modules/rsvp/rsvp.functions.inc

<?php

// $Id: rsvp.functions.inc,v 1.2 2009/02/05 02:25:27 ulf1 Exp $

/**
 * @module rsvp_functions
 * @package rsvp - A drupal module developed for civicspace - a distribution of drupal.
 * @description Provides rsvp internal functions that can be called by other rsvp functions
 * @author Ulf Schenk (ulf@schenkunlimited.net)
 *
 */

////////////////////////////////////////////////////////////////////////////////////////////////////////////

/**
 * RSVP EMAIL ADDRESS USAGE
 */
define('RSVP_EMAIL_SITEADDRESS', 0);
define('RSVP_EMAIL_SETTINGS',    1);
define('RSVP_EMAIL_CREATOR',     2);

/**
 * RSVP ATTENDING OPTIONS (also stored in the database)
 */
define('RSVP_ATT_YES',    'yes');
define('RSVP_ATT_NO',     'no');
define('RSVP_ATT_MAYBE',  'maybe');
define('RSVP_ATT_NONE',   'none');
/**
 * ADDTL. RSVP ATTENDING OPTIONS (only used in memory)
 */
define('RSVP_ATT_ALL',    'all');
define('RSVP_ATT_NOTSEND','notsend');


define('RSVP_OPEN_INVITATION', 'open');


/**
 * RSVP RESPONSE OPTIONS
 */
define('RSVP_RESPONSE_HIDE',            0);
define('RSVP_RESPONSE_SHOW',            1);
define('RSVP_RESPONSE_SHOWWHENREPLIED', 2);

/**
 * RSVP REPLY OPTIONS
 */
define('RSVP_REPLY_HIDE', 0);
define('RSVP_REPLY_SHOW', 1);

/**
 * RSVP ATTENDEE_VISIBLE OPTIONS
 */
define('RSVP_INVITEE_HIDE', 0);
define('RSVP_INVITEE_SHOW', 1);
define('RSVP_INVITEE_SHOWRESPONSEWHENREPLIED', 2);

/**
 * RSVP SEND OPTIONS
 */
define('RSVP_SEND_NONE',        0);
define('RSVP_SEND_INVITEE',     1);
define('RSVP_SEND_RESPONDENT',  2);
define('RSVP_SEND_ATTENDEE',    3);

/**
 * RSVP INVITE OTHER OPTIONS
 */
define('RSVP_INVITE_NONE',        0);
define('RSVP_INVITE_INVITEE',     1);
define('RSVP_INVITE_RESPONDENT',  2);
define('RSVP_INVITE_ATTENDEE',    3);

/**
 * RSVP GENERAL OPTIONS
 */
define('RSVP_OPTION_NO',  0);
define('RSVP_OPTION_YES', 1);

/**
 * RSVP GUESTLIST SHOW/SORT OPTIONS
 */
define('RSVP_GUESTLIST_SORT_ALPHA', 'sa');
define('RSVP_GUESTLIST_SORT_DATE', 'sd');
define('RSVP_GUESTLIST_SHOW_ALL', 'all');
define('RSVP_GUESTLIST_SHOW_PART', 'part');

/**
 * PATH WHERE THE USER DEFINED THEMES ARE LOCATED
 */

define('RSVP_FILES_THEMES_PATH', 'rsvp/themes');
define('RSVP_FILES_ICONS_PATH', 'rsvp/icons');
define('RSVP_FILES_BACKGROUNDIMAGE_PATH', 'rsvp/backgrounds');
define('RSVP_FILES_IMAGE_PATH', 'rsvp/images');

define('RSVP_THEMES_PATH', 'themes');
define('RSVP_ICONS_PATH', 'icons');
define('RSVP_BACKGROUNDIMAGE_PATH', 'backgrounds');
define('RSVP_IMAGE_PATH', 'images');

define('RSVP_THEME_DEFAULT', 'default');
define('RSVP_STYLESHEET_DEFAULT', 'default');
define('RSVP_ICONSET_DEFAULT', 'flags');
define('RSVP_BACKGROUNDIMAGE_DEFAULT', 'none');
define('RSVP_IMAGE_DEFAULT', 'none');

/**
 * RSVP ACCESS OPTIONS
 */
define('RSVP_ACCESS_VIEW',      'v'); //maintainer, moderator, owner, co-moderator, guest, view by role permission
define('RSVP_ACCESS_REPLY',     'r'); //maintainer, moderator, owner, co-moderator, guest
define('RSVP_ACCESS_EDIT',      'e'); //maintainer, moderator, owner, co-moderator
define('RSVP_ACCESS_CREATE',    'c'); //maintainer, moderator, create permissions
define('RSVP_ACCESS_DELETE',    'd'); //maintainer, moderator, owner, co-moderator
define('RSVP_ACCESS_MAINTAIN',  'm'); //maintainer
define('RSVP_ACCESS_GUEST',     'g'); //maintainer, guest
define('RSVP_ACCESS_GUESTONLY', 'o'); //guest
define('RSVP_ACCESS_BYROLE',    'b'); //view by role permission


/**
 * RSVP PERMISSIONS
 */
define('RSVP_PERM_ADMIN',          'administer rsvp');
define('RSVP_PERM_MAINTAIN',       'maintain rsvp');
define('RSVP_PERM_ONEVENTS',       'rsvp on events');
define('RSVP_PERM_ONOWNEVENTS',    'rsvp on own events');
define('RSVP_PERM_INVITE_ROLE',    'rsvp invite by role');


/**
 * RSVP ERRORCODES
 */
define('RSVP_DELETED',                    true);
define('RSVP_ERROR_DELETE_REAL_NAME',     -1);
define('RSVP_ERROR_DELETE_USER_RECORDS',  -2);
define('RSVP_ERROR_DELETE_RSVP',          -3);


/**
* Creates a new invitation(rsvp).
* 
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $rsvp The rsvp object we want to create.
* @return int key id of the rsvp instance or false on failure.
*/

function rsvp_function_create_rsvp($rsvp) {
  global $user;

  $fields[] = 'timestamp';
  $vals[] = time();
  $markers[] = "%d";

  $fields[] = 'uid';
  $vals[] = $user->uid;
  $markers[] = "%d";
  
  foreach (array('nid', 'startdate', 'uid_moderator', 'reply_startdate', 'reply_enddate', 'max_guests', 'open_invitation', 'disable_maybe', 'send_privatemsg', 'send_conf_guest', 'send_conf_owner', 'invite_filterformat') as $key) {
    $fields[] = $key;
    $vals[] = $rsvp->$key;
    $markers[] = "%d";
  }
  
  foreach (array('name', 'theme', 'stylesheet', 'iconset', 'backgroundimage', 'image', 'rsvp_view_roles', 'response_view_roles', 'invite_text', 'response_blind', 'response_blind_node', 'reply_blind_node', 'attendees_visible', 'list_email', 'allow_invite', 'text_whoiscoming', 'text_yes', 'text_no', 'text_maybe') as $key) {
    $fields[] = $key;
    $vals[] = $rsvp->$key;
    $markers[] = "'%s'";
  }
  
  $sql = 'INSERT INTO {rsvp} ('. implode(", ", $fields) .') VALUES ('. implode(", ", $markers) .')';
  if (db_query($sql, $vals)) {
    $rsvp->rid = db_last_insert_id('rsvp', 'rid');
    
    return $rsvp->rid;
  }
  else {
    drupal_set_message(t('There was an error creating the invitation. Please try again'), 'error');
    return FALSE;
  }
}


/**
* Updates an invitation(rsvp)
* 
* Permission check needs to be done outside.
*
* @ingroup rsvp_functions
* @param $rsvp The rsvp object we want to update.
* @return boolean true on success.
*/

function rsvp_function_update_rsvp($rsvp) {
  
  $rid = $rsvp->rid;

  if (!$rid) {
    return false;
  }
  
  $fields[] = 'timestamp = %d';
  $vals[] = time();

  foreach (array('nid', 'uid', 'startdate', 'uid_moderator', 'reply_startdate', 'reply_enddate', 'max_guests', 'open_invitation', 'disable_maybe', 'send_privatemsg', 'send_conf_guest', 'send_conf_owner','invite_filterformat') as $key) {
    $fields[] = $key ." = %d";
    $vals[] = $rsvp->$key;
  }
  
  foreach (array('name', 'invite_text', 'theme', 'stylesheet', 'iconset', 'backgroundimage', 'image', 'rsvp_view_roles', 'response_view_roles', 'response_blind', 'response_blind_node', 'reply_blind_node', 'attendees_visible', 'list_email', 'allow_invite', 'text_whoiscoming', 'text_yes', 'text_no', 'text_maybe') as $key) {
    $fields[] = $key ." = '%s'";
    $vals[] = $rsvp->$key;
  }

  $vals[] = $rid;
  
  $sql = 'UPDATE {rsvp} SET '. implode(', ', $fields) .' WHERE rid = %d';

  if (db_query($sql, $vals)) {
    drupal_set_message(t('Invitation updated.'));
    return TRUE;
  }
  else {
    drupal_set_message(t('There was an error updating the invitation.'), 'error');
    return FALSE;
  }
}

/**
* Deletes an invitation(rsvp)
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $rid The rid of the rsvp to delete.
* @return boolean true on success.
*/
function rsvp_function_delete_rsvp($rid) {

  if (is_null($rid) || !is_numeric($rid)) { 
    drupal_set_message(t('Invitation %rid is not a valid type.', array('%rid' => $rid)), 'error');
    return RSVP_ERROR_DELETE_RSVP;
  }
    
  if (db_query('DELETE FROM {rsvp} WHERE rid = %d', $rid)) {
    if (db_query('DELETE FROM {rsvp_invite} WHERE rid = %d', $rid)) {
      return RSVP_DELETED;
    }
    else {
      return RSVP_ERROR_DELETE_USER_RECORDS;
    }
  }
  else {
    return RSVP_ERROR_DELETE_RSVP;
  }
}

/**
* Retrieves an invitation(rsvp) from the database.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $rid The rid of the rsvp instance.
* @return The $rsvp instance or false.
*/
function rsvp_function_load_rsvp($rid) {
	$rsvp = db_fetch_object(db_query('SELECT * FROM {rsvp} WHERE rid = %d', $rid));

  if ($rsvp == false) {
    drupal_set_message(t('The invitation you requested (rid=%rid) is invalid or has been deleted.', array('%rid' => $rid)));
  }  

  return $rsvp;
}

/**
* Retrieves a node from the database, based on a particular invitation.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $object The rsvp object that you want the node to load for or the $nid (numeric).
* @return The $node instance or false.
*/
function rsvp_function_load_node($object) {

	if (is_numeric($object)) {
    $node = node_load($object);
    if ($node == false) {
      drupal_set_message(t('The node you requested (nid=%nid) has been deleted.', array('%nid' => $object)));
    }
	}
  else {
  	//$object is a $rsvp instance
    $node = node_load($object->nid);
    if ($node == false) {
      drupal_set_message(t('The node you requested (nid=%nid) that belongs to invitation (rid=%rid) has been deleted.', array('%rid' => $object->rid, '%nid' => $object->nid)));
    }
  }
  
  return $node;
}

/**
* Returns a particular invitation that a user has received.
*
* @ingroup rsvp_functions
* @param $rid The rsvp id of the invitation.
* @param $uid The uid of the user. If NULL, use logged in users credentials
* @param $print Boolean print drupal message in case of error.
* * 
* @return invite object or false.
*/
function rsvp_function_load_invitation_rid($rid, $uid = NULL, $print = true) {

  $uid = _rsvp_function_check_uid($uid);	
	if (is_null($uid)) {
    return false;
	}
	
  $invite_target = db_fetch_object(db_query('SELECT * FROM {rsvp_invite} u LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE u.uid = %d AND u.rid = %d', $uid, $rid));

  if (($invite_target == false) && ($print == true)) {
    drupal_set_message(t('The invitation (rid=%rid) that you (uid=%uid) requested is invalid or has been deleted.', array('%rid' => $rid, '%uid' => $uid)));
  }  

  return $invite_target;
}

/**
* Checks that the incoming $uid is not anonymous user.
*
* @ingroup rsvp_functions
* @param $uid The uid of the user. If NULL, use logged in users credentials. returns NULL if anonymous.
* 
* @return cleared $uid.
*/
function _rsvp_function_check_uid($uid) {
	if (is_null($uid) || ($uid == 0)) {
    if (user_is_anonymous())
      return NULL;
    
    global $user;
    $uid = $user->uid;
    if ($uid == 0)
      return NULL;
	}
	
	return $uid;
}

/**
* Returns an invite by hash value.
*
* @ingroup rsvp_functions
* @param $hash The hash value of the invitee.
* @return dbresultset of the requested invite or false.
*/
function rsvp_function_load_invitation_hash($hash) {

	
	$invite_target = db_fetch_object(db_query('SELECT u.*,n.realname FROM {rsvp} r LEFT JOIN {rsvp_invite} u ON r.rid = u.rid LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE u.hash = \'%s\'', $hash)); 
  if ($invite_target == false) {
    drupal_set_message(t('The invitation (hash=%hash) that you requested is invalid or has been deleted.', array('%hash' => $hash)));
  }  

  return $invite_target;
	
}

/**
* Returns selective guests for an invitation based on the passed status
*
* @ingroup rsvp_functions
* @param $rid The rid of the rsvp instance.
* @param $status const of type (RSVP_ATT_ALL,...)
* @param $count Boolean. If true return an interger with the number of found elements. If false return elements.
* * 
* @return dbresultset of the requested attendees.
*/
function rsvp_function_load_guests($rid, $status = RSVP_ATT_ALL, $count = FALSE, $tablesort = ' ORDER BY u.email') {

	if ($status == RSVP_ATT_ALL || !isset($status))
    $result = db_query('SELECT '. ($count ? 'SUM(totalguests)' : 'u.*,n.realname') .' FROM {rsvp_invite} u LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE rid = %d ' . $tablesort, $rid);
  else
    $result = db_query('SELECT '. ($count ? 'SUM(totalguests)' : 'u.*,n.realname') .' FROM {rsvp_invite} u LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE rid = %d AND response=\'%s\'' . $tablesort, $rid, $status);
    
  if ($result == false) {
    drupal_set_message(t('The invitation you requested (rid=%rid) is invalid or has been deleted.', array('%rid' => $rid)));
  }  

  return $result;
}

/**
* Return totals for each type (RSVP_ATT_ALL,...) for an invitation
*
* @ingroup rsvp_functions
* @param $rid The rid of the rsvp instance.
* @return dbresultset of the requested attendees.
*/
function rsvp_function_load_totalguests($rid) {
	$skip = false;
	$responses = array(RSVP_ATT_NONE, RSVP_ATT_YES, RSVP_ATT_NO, RSVP_ATT_MAYBE);
  foreach ($responses as $response) {
    $total = db_result(db_query('SELECT SUM(totalguests) FROM {rsvp_invite} u WHERE u.rid = %d AND u.response = \'%s\'', $rid, $response));

     
    $totals[$response] = (int) $total;
    $totals[RSVP_ATT_ALL] += (int) $total;

  }
  return $totals;
}

/**
* Remove a guest from an invitation.
*
* @ingroup rsvp_functions
* @param $hash The hash value of the invitee.
* @return boolean true if successful.
*/
function rsvp_function_remove_guest($hash) {
	return db_query('DELETE FROM {rsvp_invite} WHERE hash = \'%s\'', $hash);
}

/**
* Checks if an invitation for a user (by email address) already exists and returns it.
*
* @ingroup rsvp_functions
* @param $rid The id of the rsvp instance.
* @param $email The email to check for.
* @return boolean false if the email don't exist for the rsvp, or the $invitation object.
*/
function rsvp_function_exists_guest_email($rid, $email) {
	return db_fetch_object(db_query('SELECT u.*,n.realname FROM {rsvp_invite} u LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE u.rid = %d AND u.email = \'%s\'', $rid, $email));
}

/**
* Checks if an invitation for a user (by user id) already exists and returns it.
* *
* @ingroup rsvp_functions
* @param $rid The id of the rsvp instance.
* @param $uid The user uid to check for.
* @return boolean false if the email don't exist for the rsvp, or the $invitation object.
*/
function rsvp_function_exists_guest_uid($rid, $uid) {
	
  $uid = _rsvp_function_check_uid($uid);  
  if (is_null($uid)) {
    return false;
  }
  
	return db_fetch_object(db_query('SELECT u.*,n.realname FROM {rsvp_invite} u LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE u.rid = %d AND u.uid = %d', $rid, $uid));
}

/**
* Creates a new realname dataset(rsvp).
* 
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $invite_target The invite instance you want to create a realname entry for.
* @param $realname The real name you want to store.
* 
* @return true or false on failure.
*/

function rsvp_function_create_rsvp_realname($invite_target, $realname) {
  global $user;

  $fields[] = 'realname';
  $vals[] = $realname;
  $markers[] = "'%s'";

  $fields[] = 'email';
  $vals[] = $invite_target->email;
  $markers[] = "'%s'";
  

  $sql = 'INSERT INTO {rsvp_realname} ('. implode(", ", $fields) .') VALUES ('. implode(", ", $markers) .')';
  if (db_query($sql, $vals)) {
    return true;
  }
  else {
    drupal_set_message(t('There was an error creating the realname. Please try again'), 'error');
    return FALSE;
  }
}


/**
* Updates an rsvp_realname
* 
* Permission check needs to be done outside.
*
* @ingroup rsvp_functions
* @param $invite_target The invite instance you want to update the realname entry for.
* @param $realname The real name you want to store.
* @return boolean true on success.
*/

function rsvp_function_update_rsvp_realname($invite_target, $realname) {
  
  $fields[] = 'realname = \'%s\'';
  $vals[] = $realname;

  $vals[] = $invite_target->email;
  
  $sql = 'UPDATE {rsvp_realname} SET '. implode(', ', $fields) .' WHERE email = \'%s\'';
  
  if (db_query($sql, $vals)) {
    return TRUE;
  }
  else {
    drupal_set_message(t('There was an error updating the Real name.'), 'error');
    return FALSE;
  }
}

/**
* Deletes a rsvp_realname
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $invite_target The invite instance you want to update the realname entry for.
* @return boolean true on success.
*/
function rsvp_function_delete_rsvp_realname($invite_target) {
    
  if (db_query('DELETE FROM {rsvp_realname} WHERE email = \'%s\'', $invite_target->email)) {
    return RSVP_DELETED;
  }
  else {
    return RSVP_ERROR_DELETE_REAL_NAME;
  }
}

/**
* Checks if a rsvp_realname for an invite object (by email) already exists and returns it.
* *
* @ingroup rsvp_functions
* @param $invite_target The invite instance you want to update the realname entry for.
* @return boolean false if the realname don't exist for the invite object, or the realname object.
*/
function rsvp_function_exists_rsvp_realname($invite_target) {
  
  return db_fetch_object(db_query('SELECT * FROM {rsvp_realname} WHERE email = \'%s\'', $invite_target->email));
}


/**
 * Returns a new $rsvp Object with default settings.
 *
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 */

function rsvp_function_initialize_default_rsvp() {
  
  //create a rsvp and use it to set the default values.
  $rsvp = new stdClass();

  $rsvp->text_yes = variable_get('rsvp_default_text_yes', t('Attend'));
  $rsvp->text_no = variable_get('rsvp_default_text_no', t('Attend not'));
  $rsvp->text_maybe = variable_get('rsvp_default_text_maybe', t('Undecided'));
  $rsvp->text_whoiscoming = variable_get('rsvp_default_text_whoiscoming', t('Responses'));
  $rsvp->response_blind = variable_get('rsvp_default_response_blind', RSVP_RESPONSE_SHOW);
  $rsvp->response_blind_node = variable_get('rsvp_default_response_blind_node', RSVP_RESPONSE_HIDE);
  $rsvp->attendees_visible = variable_get('rsvp_default_attendees_visible', RSVP_INVITEE_HIDE);
  $rsvp->response_view_roles = variable_get('rsvp_default_response_view_roles', '');
  $rsvp->rsvp_view_roles = variable_get('rsvp_default_rsvp_view_roles','');
  $rsvp->reply_blind_node = variable_get('rsvp_default_reply_blind_node', RSVP_REPLY_HIDE);
  $rsvp->list_email = variable_get('rsvp_default_list_email', RSVP_SEND_NONE);
  $rsvp->allow_invite = variable_get('rsvp_default_allow_invite', RSVP_INVITE_NONE);

  $rsvp->send_conf_owner = variable_get('rsvp_default_send_conf_owner', RSVP_OPTION_NO);
  $rsvp->send_conf_guest = variable_get('rsvp_default_send_conf_guest', RSVP_OPTION_NO);
  $rsvp->send_privatemsg = variable_get('rsvp_default_send_privatemsg', RSVP_OPTION_NO);
  $rsvp->disable_maybe = variable_get('rsvp_default_disable_maybe', RSVP_OPTION_NO);
  $rsvp->open_invitation = variable_get('rsvp_default_open_invitation', RSVP_OPTION_NO);
  $rsvp->max_guests = variable_get('rsvp_default_max_guests', 0);
  $rsvp->theme = variable_get('rsvp_default_theme', RSVP_THEME_DEFAULT);
  $rsvp->stylesheet = variable_get('rsvp_default_stylesheet', RSVP_STYLESHEET_DEFAULT);
  $rsvp->iconset = variable_get('rsvp_default_iconset', RSVP_ICONSET_DEFAULT);
  $rsvp->backgroundimage = variable_get('rsvp_default_backgroundimage', RSVP_BACKGROUNDIMAGE_DEFAULT);
  $rsvp->image = variable_get('rsvp_default_image', RSVP_IMAGE_DEFAULT);
  
  $rsvp->invite_filterformat = FILTER_FORMAT_DEFAULT;
  
  return $rsvp; 
}


/**
 * Internal function
 * 
 * Adds a number of guests to an invitation(rsvp)
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 *
 * @param $rsvp The rsvp instance.
 * @param $invite_caller The invitation object of the user who adds the guests, 
 *        or NULL if the rsvp owner, co_owner or moderator adds the guests,
 *        or const RSVP_OPEN_INVITATION for an open invitation
 * 
 * @param $guestsarray Stringarray Contains a mix of email addresses and drupal usernames.
 * 
 * @return array with failed emailaddresses or false
 */
function _rsvp_function_add_guests($rsvp, $invite_caller, $guestsarray) {

  $emails = array();

	// remove duplicates from guestlist array
  $guestsarray = array_unique($guestsarray);

  $rid = $rsvp->rid;

  if (is_null($invite_caller))
    $owner_hash = '';
  elseif ($invite_caller == RSVP_OPEN_INVITATION)
    $owner_hash = RSVP_OPEN_INVITATION;
  else
    $owner_hash = $invite_caller->hash;
  
  
  foreach ($guestsarray as $key => $value) {

    $list_key = NULL;
    $invite_hash = NULL;
    
    // strip whitespace
    $string = trim($value);
    
    if (strlen($string)) {
      // attempt to deal with the string as a drupal username
      // we do this before dealing it as an e-mail to handle users like 
      // foo@somesite.com
      $usr = user_load(array('name' => $string));
      if ($usr === FALSE) {
        // attempt to find a system user having this string as an e-mail address
        $usr = user_load(array('mail' => $string));
        if ($usr === FALSE) {
          // no user found: carry on dealing with the string as an e-mail address
          if (valid_email_address($string)) {
            $invite_target = rsvp_function_exists_guest_email($rid, $string);
            if (!$invite_target) {
              // if this e-mail is not in the attendee list,
              // add it
              $hash = md5($rid . $string . time());
              if (db_query('INSERT INTO {rsvp_invite} (rid, inviteehash, email, hash, timestamp, response, comment, totalguests) VALUES (%d, \'%s\', \'%s\', \'%s\', %d, \'%s\', \'%s\', %d)', $rid, $owner_hash, $string, $hash, time(), 'none', '', 1)) {
                $invite_hash = $hash;
                $list_key = 'success_add';
              }
            }
            else {
              // the e-mail is already in the attendee list
              $invite_hash = $invite_target->hash;
              $list_key = 'existing';
            }
          }
          else {
            // the e-mail is invalid
            $invite_hash = NULL;
            $list_key = 'invalid';
          }
        }
      }

      if ($usr != FALSE) {
        // a valid drupal user was found, make sure his/her e-mail isn't already
        // in the attendees list
        $invite_target = rsvp_function_exists_guest_uid($rid, $usr->uid);
        if (!$invite_target) {
          $hash = md5($rid . $string . time());
          if (db_query('INSERT INTO {rsvp_invite} (rid, uid, inviteehash, email, hash, timestamp, response, comment, totalguests) VALUES (%d, %d, \'%s\', \'%s\', \'%s\', %d, \'%s\', \'%s\', %d)', $rid, $usr->uid, $owner_hash, $usr->mail, $hash, time(), 'none', '', 1)) {
            $invite_hash = $hash;
            $list_key = 'success_add';
          }          
        }
        else {
          // the uid is already in the attendee list
          $invite_hash = $invite_target->hash;
          $list_key = 'existing';
        }
      }
      
      if ($invite_hash != NULL) {
        $invite_target = rsvp_function_load_invitation_hash($invite_hash);
        $emails[$list_key][] = rsvp_function_getGuestEmail($invite_target);
      }
      else {
        $emails[$list_key][] = $string;
      }
    }
  }

  return $emails;
}


/**
 * Adds a number of guests to an invitation(rsvp) and sends out emails
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 * 
 * @param $rsvp The rsvp instance.
 * @param $invite_caller The invitation object of the user who adds the guests, 
 *        or NULL if the rsvp owner, co-owner or maintainer adds the guests,
 *        or const RSVP_OPEN_INVITATION for an open invitation
 * @param $guestsarray Stringarray Contains a mix of email addresses and drupal usernames.
 * @param $send_rsvp Boolean Also send the invitations or just add the invitees to the invitation.

 * @return array with statusmessages or false
 * 
 */
function rsvp_function_add_guests($rsvp, $invite_caller, $guestsarray, $send_rsvp) {
	
  $content = '';
  
  $add_status = _rsvp_function_add_guests($rsvp, $invite_caller, $guestsarray);
  
  $send_status = array();
  
  if ($send_rsvp == true) {
    // send invitations
    if ($invite_caller == RSVP_OPEN_INVITATION)
      $invite_caller = NULL; //set $invite_caller back to NULL before sending the invitation.
      
    $send_status = rsvp_function_send_multiple_invitations($rsvp, $invite_caller);
  }

  return array_merge($add_status, $send_status);
}

/**
 * Remove a number of guests from an invitation(rsvp)
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 *
 * @param $rsvp The rsvp instance.
 * @param $guestsarray Stringarray Contains a mix of email addresses, drupal usernames and hashes.
 * 
 * @return array with failed emailaddresses or false
 */
function _rsvp_function_remove_guests($rsvp, $guestsarray) {

  $emails = array();

  // remove duplicates from guestlist array
  $guestsarray = array_unique($guestsarray);

  $rid = $rsvp->rid;
  
  foreach ($guestsarray as $key => $value) {

    $list_key = NULL;
    $invite_name = NULL;
    
    // strip whitespace
    $string = trim($value);
    
    if (strlen($string)) {
      // attempt to deal with the string as a drupal username
      // we do this before dealing it as an e-mail to handle users like 
      // foo@somesite.com
      $usr = user_load(array('name' => $string));
      if ($usr === FALSE) {
        // attempt to find a system user having this string as an e-mail address
        $usr = user_load(array('mail' => $string));
        if ($usr === FALSE) {
          // no user found: carry on dealing with the string as an e-mail address
          if (valid_email_address($string)) {
            $invite_target = rsvp_function_exists_guest_email($rid, $string);
            if ($invite_target) {
              $invite_name = rsvp_function_getGuestEmail($invite_target);
              $list_key = 'success_remove';
            	rsvp_function_remove_guest($invite_target->hash);
            }
            else {
              $invite_name = $string;
              $list_key = 'invalid';
            }
          }
          else {
            // the e-mail is invalid. Last possibility is that the string is a hash.
            $invite_target = rsvp_function_load_invitation_hash($string);
            if ($invite_target) {
              $invite_name = rsvp_function_getGuestEmail($invite_target);
              $list_key = 'success_remove';
              rsvp_function_remove_guest($invite_target->hash);
            }
            else {
              $invite_name = $string;
              $list_key = 'invalid';
            }
          }
        }
      }

      if ($usr != FALSE) {
        // a valid drupal user was found, make sure his/her e-mail is the guest list
        $invite_target = rsvp_function_exists_guest_uid($rid, $usr->uid);
        if ($invite_target) {
          $invite_name = rsvp_function_getGuestEmail($invite_target);
          $list_key = 'success_remove';
          rsvp_function_remove_guest($invite_target->hash);
        }
        else {
          $invite_name = $string;
          $list_key = 'invalid';
        }
        
      }
      
      $emails[$list_key][] = $invite_name;
      
    }
  }

  return $emails;
}

/**
 * Remove a number of guests from an invitation(rsvp)
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 *
 * @param $rsvp The rsvp instance.
 * @param $guestsarray Stringarray Contains a mix of email addresses, drupal usernames and hashes.
 * 
 * @return array with failed emailaddresses or false
 */
function rsvp_function_remove_guests($rsvp, $guestsarray) {
  
  $content = '';
  
  $remove_status = _rsvp_function_remove_guests($rsvp, $guestsarray);
  
  $content .= theme('rsvp_status', $remove_status);
  drupal_set_message($content);
}

/**
 * Sends the invitation to all invitees of an rsvp instance.
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 *
 * @param $rsvp The rsvp object.
 * @param $invite_caller The invite object of the user sending the invitation or NULL (if NULL, moderator sends invitation). 
 * @param $resend True: sends to all guests even when received flag is already set. default: false.
 *
 * @return array of status values.
 */
function rsvp_function_send_multiple_invitations($rsvp, $invite_caller = NULL, $resend = FALSE) {

	$status['success_send_invitation'] = array();
  $status['failed_send_invitation'] = array();
  
  $invitees = rsvp_function_load_guests($rsvp->rid);
  while ($one_invite = db_fetch_object($invitees)) {
    if (!($resend && $one_invite->received) && !($one_invite->invited)) {
      if (_rsvp_function_send_one_invitation($rsvp, $one_invite, $invite_caller)) { 
        $status['success_send_invitation'][] = rsvp_function_getGuestEmail($one_invite);
      }
      else {
        $status['failed_send_invitation'][] = rsvp_function_getGuestEmail($one_invite);
      }
    }
  }
  return $status;
}

/**
 * Sends the invitation to one guest.
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 *
 * @param $rsvp The rsvp object.
 * @param $invite_target The invite object to send the invitation to.
 * @param $invite_caller The invite object of the user sending the invitation or NULL (if NULL, moderator sends invitation).
 *
 * @return array of status values.
 */
function rsvp_function_send_one_invitation($rsvp, $invite_target, $invite_caller = NULL) {

  $status['success_send_invitation'] = array();
  $status['failed_send_invitation'] = array();

  if (_rsvp_function_send_one_invitation($rsvp, $invite_target, $invite_caller)) { 
    $status['success_send_invitation'][] = rsvp_function_getGuestEmail($invite_target);
  }
  else {
    $status['failed_send_invitation'][] = rsvp_function_getGuestEmail($invite_target);
  }
  
  return $status;
}

/**
 * Internal function
 * 
 * Sends an invitation to one guest.
 * 
 * Permission check needs to be done outside.
 *
 * @ingroup rsvp_functions
 * @param $rsvp The rsvp object.
 * @param $invite_target The invite object to send the invitation to.
 * @param $invite_caller The invite object of the user sending the invitation or NULL (if NULL, moderator sends invitation).
 * @return boolean. True if message has been successfully send.
 */
function _rsvp_function_send_one_invitation($rsvp, $invite_target, $invite_caller = NULL) {
	global $language;
  
  if (!$invite_caller || is_null($invite_caller)) {
    global $user;
    $sender_name = $user->name;
    $from = rsvp_function_email_getFromField($user->name, $user->mail);
  }
  else {
    $sender_name = $invite_caller->email;
    $from = rsvp_function_email_getFromField($sender_name, $invite_caller->email);
  }
  
  $u = user_load($rsvp->uid);
  $preferred_language = user_preferred_language($u);

  $to = $invite_target->email;

  $replacements = rsvp_mailer_replacements($rsvp, $invite_target, $sender_name, '', $rsvp->invite_text);

  $ret = drupal_mail('rsvp', 'invitation', $to, $preferred_language, $replacements, $from);

  if ($ret == true) {
    $fields[] = 'invited = %d';
    $fields[] = 'timestamp = %d';
    
    $vals[] = 1;
    $vals[] = time();
    $vals[] = $invite_target->hash;
    
    $sql = 'UPDATE {rsvp_invite} SET '. implode(', ', $fields) .' WHERE hash = \'%s\'';
  
    db_query($sql, $vals);
  }
  
  return $ret;      
}

/**
* Send a message to selective guests of an invitation.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* 
* @param $rsvp The rsvp object.
* @param $audience Const The audience for the message (RSVP_ATT_ALL,...).
* @param $rsvp_mailer_op String One of the mailer operations in rsvp.mailer.inc.
* @param $subject String The body you want to send.
* @param $body String The subject you want to send.
* @param $invite_caller The invitee instance of the person triggering the message or NULL if moderator. 
*
* @return string of formatted recipients, or empty string depending on $confirm.
*/
function rsvp_function_send_message_guests($rsvp, $audience, $rsvp_mailer_op, $subject, $body, $invite_caller = NULL) {
	
  // check whether the message is sent from a user who's invited
  // yet allowed to message other attendees
  if (!$invite_caller || is_null($invite_caller)) {
    global $user;
    $sender_name = $user->name;
    $from = rsvp_function_email_getFromField($user->name, $user->mail);
  }
  else {
    $sender_name = $invite_caller->email;
    $from = rsvp_function_email_getFromField($sender_name, $invite_caller->email);
  }

  $status['success_send_message'] = array();
  $status['failed_send_message'] = array();

  $attendees = rsvp_function_load_guests($rsvp->rid);
  while ($attendee = db_fetch_object($attendees)) {
    $invite = rsvp_function_load_invitation_hash($attendee->hash);
    
    if ($audience == RSVP_ATT_ALL || $invite->response == $audience) {
      $inviteuser = user_load($invite->uid);
      $to = $attendee->email;

      $preferred_language = user_preferred_language($inviteuser);

      $replacements = rsvp_mailer_replacements($rsvp, $attendee, $sender_name, $subject, $body);

      if (drupal_mail('rsvp', $rsvp_mailer_op, $to, $preferred_language, $replacements, $from)) {
        $status['success_send_message'][$invite->email] = rsvp_function_getGuestEmail($invite);
      }
      else {
        $status['failed_send_message'][$invite->email] = rsvp_function_getGuestEmail($invite);
      }
    }
  }

  return $status;
}

/**
* Send a message to a particular guest of an invitation.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* 
* @param $rsvp The rsvp object.
* @param $hash The hashcode of the person we want to send the message to.
* @param $rsvp_mailer_op String One of the mailer operations in rsvp.mailer.inc.
* @param $body String The body you want to send.
* @param $subject String The subject you want to send.
* @param $invite_caller The invitee instance of the person triggering the message or NULL if moderator. 
*
* @return string of formatted recipients, or empty string depending on $confirm.
*/
function rsvp_function_send_message_guest($rsvp, $hash, $rsvp_mailer_op, $subject, $body, $invite_caller = NULL) {

//get rid of subject

  // check whether the message is sent from a user who's invited
  // yet allowed to message other attendees
  if (!$invite_caller || is_null($invite_caller)) {
    global $user;
    $sender_name = $user->name;
    $from = rsvp_function_email_getFromField($sender_name, $user->mail);
  }
  else {
    $sender_name = $invite_caller->email;
    $from = rsvp_function_email_getFromField($sender_name, $invite_caller->email);
  }

  $status['success_send_message'] = array();
  $status['failed_send_message'] = array();

  $invite = rsvp_function_load_invitation_hash($hash);
    
  $inviteuser = user_load($invite->uid);
  $to = $invite->email;

  $preferred_language = user_preferred_language($inviteuser);

  $replacements = rsvp_mailer_replacements($rsvp, $invite, $sender_name, $subject, $body);

  if (drupal_mail('rsvp', $rsvp_mailer_op, $to, $preferred_language, $replacements, $from)) {
    $status['success_send_message'][$invite->email] = rsvp_function_getGuestEmail($invite);
  }
  else {
    $status['failed_send_message'][$invite->email] = rsvp_function_getGuestEmail($invite);
  }

  return $status;
}

/**
* Send a message to the owner/co-owner of an invitation.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* 
* @param $rsvp The rsvp object.
* @param $rsvp_mailer_op String One of the mailer operations in rsvp.mailer.inc.
* @param $subject String The subject you want to send.
* @param $body String The body you want to send.
* @param $invite_target The invitee instance of the person triggering the message or NULL if no trigger. 
* *
* @return string of formatted recipients, or empty string depending on $confirm.
*/
function rsvp_function_send_message_moderator($rsvp, $rsvp_mailer_op, $subject, $body, $invite_target = NULL) {
	
  $owner_user = user_load($rsvp->uid);
  if ($rsvp->uid_moderator > 0)
    $moderator_user = user_load($rsvp->uid_moderator);
  else
    $moderator_user = false;
    
  global $user;
  $sender_name = $user->name;
  $from = rsvp_function_email_getFromField($sender_name, $user->mail);

  $status['success_send_message'] = array();
  $status['failed_send_message'] = array();

  
  //send to owner
  $to = $owner_user->mail;
  $preferred_language = user_preferred_language($owner_user);

  $replacements = rsvp_mailer_replacements($rsvp, $invite_target, $sender_name, $subject, $body);

  if (drupal_mail('rsvp', $rsvp_mailer_op, $to, $preferred_language, $replacements, $from)) {
    $status['success_send_message'][$to] = rsvp_function_getGuestEmail($invite_target);
  }
  else {
    $status['failed_send_message'][$to] = rsvp_function_getGuestEmail($invite_target);
  }
  
  //send to co-moderator
  if ($moderator_user == true) {
    $to = $moderator_user->mail;
    $preferred_language = user_preferred_language($moderator_user);

    if (drupal_mail('rsvp', $rsvp_mailer_op, $to, $preferred_language, $replacements, $from)) {
      $status['success_send_message'][$to] = rsvp_function_getGuestEmail($invite_target);
    }
    else {
      $status['failed_send_message'][$to] = rsvp_function_getGuestEmail($invite_target);
    }
  }

  return $status;
}

/**
* Returns the invitations that a user is the owner or co_maintainer of.
*
* Permission check needs to be done outside.
*
* @ingroup rsvp_functions
* @param $nid The nid of the node.Can be one, array of nodes or NULL which means all nodes of the user.
* @param $uid The uid of the user.Can be a user, array of users or NULL which means rsvp for all users.
* @return dbresultset of invitations.
*/
function rsvp_function_load_invitations_owner($nid = NULL, $uid = NULL, $tablesort = ' ORDER BY nid') {
	
  $query = 'SELECT r.*, n.title FROM {rsvp} r INNER JOIN {node} n ON r.nid = n.nid '; //r.uid = %d';
  
  if (!is_null($uid) || !is_null($nid)) {
    $query .= 'WHERE '; 
  }
  
  //$query = 'SELECT r.*, n.title FROM {rsvp} r INNER JOIN {node} n ON r.nid = n.nid WHERE r.uid = %d';
  if (!is_null($nid)) {
    if (is_array($nid)) {
      $query .= 'r.nid IN (%s) ';
      $nid = implode(', ', $nid);
    }
    elseif (is_numeric($nid)) {
      $query .= 'r.nid = %d ';
    }
  }
  
  if (!is_null($uid)) {
    if (!is_null($nid)) {
      $query .= 'AND ';
    }

    //load if uid is owner or co_moderator.
    if (is_array($uid)) {
      $query .= '( r.uid IN (%s) ';
      $query .= ' OR r.uid_moderator IN (%s) )';
      $uid = implode(', ', $uid);
    }
    elseif (is_numeric($uid)) {
      $query .= '( r.uid = %d ';
      $query .= ' OR r.uid_moderator = %d )';
    }
  }
  
  $query .= $tablesort;
  
  if (is_null($nid)) {
    return db_query($query, $uid, $uid);  
  }
  else {
    return db_query($query, $nid, $uid, $uid);
  }
  
}

/**
* Returns the invitations that a user has received.
* If nid is NULL, return all invitation for the user. Otherwise only invitation of that particluar node 
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $uid The uid of the user.
* @param $nid The nodeid we want to query for. If Null, select for nodes
* @param $count returns only the total number of invitations for a particular uid/nid.
* @return array of events or integer if count=true.
*/
function rsvp_function_load_invitations_user($uid = NULL, $nid = NULL, $count = false) {
  
	$uid = _rsvp_function_check_uid($uid);  
  if (is_null($uid)) {
  	if ($count)
  	  return 0;
  	else
      return array();
  }
  
  $query = 'SELECT '. ($count ? 'COUNT(*)' : 'u.*,r.nid,n.realname') .' FROM {rsvp} r LEFT JOIN {rsvp_invite} u ON r.rid = u.rid LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE u.uid = %d';
  if (!is_null($nid)) {
    $query .= ' AND r.nid = %d';
  }

  return db_query($query, $uid, $nid);
}

/**
* Returns the invitations that a registered user has received for a specific event node.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $nid The nid of the node.
* @param $uid The uid of the user. If null, return all from all users. 
*             uid can not be 0, because it would return all invitations from unregistered attendees.
* @return array of event nids.
*/
function rsvp_function_load_invitations_node2($nid, $uid = NULL, $count = false) {
	
  
  $query = 'SELECT '. ($count ? 'COUNT(*)' : 'u.*,n.realname') .' FROM {rsvp} r LEFT JOIN {rsvp_invite} u ON r.rid = u.rid LEFT JOIN {rsvp_realname} n ON u.email = n.email WHERE r.nid = %d';
  if (!is_null($uid)) {
    if ($uid != 0)
      $query .= ' AND u.uid = %d';
    else
      return array();
  }
  
  return db_query($query, $nid, $uid);
}


/**
* Checks to see if a logged in user has been invited to an event.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $nid The node id of the event.
* @param $uid The uid of the user. If null, it uses global $user->uid.
* @return boolean. True if user has been invited to the event.
*/
function rsvp_function_is_invited($nid, $uid = NULL) {
	
  $uid = _rsvp_function_check_uid($uid);  
  if (is_null($uid)) {
  	return false;
  }

  if (db_result(db_query('SELECT COUNT(*) FROM {rsvp} r LEFT JOIN {rsvp_invite} u ON r.rid = u.rid WHERE r.nid = %d AND u.uid = %d', $nid, $uid)) > 0) {
    return TRUE;
  }
  return FALSE;
}

/**
* Checks to see if responses are visible to other attendees.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $rid The rid of the rsvp.
* @return Int. 0:Show responses, 1:Hide responses, 2:Hide responses until replied 
* 
*/

function rsvp_function_is_response_blind($rid) {
	$status = db_fetch_object(db_query('SELECT response_blind FROM {rsvp} WHERE rid = %d', $rid));

  return $status->response_blind;
}

/**
* Checks to see if a user is the owner of an rsvp.
*
* Permission check needs to be done outside.
* 
* @ingroup rsvp_functions
* @param $rid The id of the rsvp.
* @param $uid The uid of the user. If null, it uses global $user->uid.
* @return boolean. True if user is the owner of an rsvp to the event.
*/
function rsvp_function_is_owner($rid, $uid = NULL) {

  $uid = _rsvp_function_check_uid($uid);  
  if (is_null($uid)) {
  	return false;
  }

  if (db_result(db_query('SELECT COUNT(*) FROM {rsvp} WHERE rid = %d AND uid = %d', $rid, $uid)) > 0) {
    return TRUE;
  }
  return FALSE;
}
