modules/rsvp/rsvp.module

<?php
// $Id$

/**
 * @module rsvp
 * @package rsvp - A drupal module developed for civicspace - a distribution of drupal.
 * @description Provides email invite and tracking functionality for nodes. Requires event.module or date.module.
 * @author crunchywelch (welch@advomatic.com)
 * @author Omar Abdel-Wahab (owahab@gmail.com)
 * @author Ulf Schenk (ulf@schenkunlimited.net)
 *
 */


// Pre Loading files that will be required in this module
foreach (array('functions', 'api', 'blocks', 'form', 'mailer', 'admin', 'actions') as $file) {
  module_load_include("inc", "rsvp", "rsvp.{$file}");
}

/**
 * @defgroup rsvp_core core functions for rsvp.
 */

/**
 * Implementations of hook_views_api().
 *
 * @ingroup rsvp_core
 *  
 */
function rsvp_views_api() {
  return array(
    'api' => 2,
    'path' => drupal_get_path('module','rsvp'),
  );
}

/**
 * Implementation of hook_theme.
 *
 * @ingroup rsvp_core
 * 
 */
function rsvp_theme($existing, $type, $theme, $path) {
  return array(
    'rsvp_status' => array(
      'file' => 'rsvp.theme',
      'arguments' => array('statusin' => NULL),
    ),
    'rsvp_help' => array(
      'file' => 'rsvp.theme',
      'arguments' => array('content' => NULL),
    ),
    'rsvp_invitation_page' => array(
      'theme paths' => array(file_directory_path()),
      'template' => 'themes/default/rsvp-invitation-page',
      'arguments' => array('connector' => NULL, 'rsvp' => NULL, 'invite_target' => NULL, 'params' => NULL),
    ),
    
    'rsvp_invitation' => array(
      'theme paths' => array(file_directory_path()),
      'template' => 'themes/default/rsvp-invitation',
      'arguments' => array('connector' => NULL, 'rsvp' => NULL, 'invite_target' => NULL, 'node' => NULL, 'params' => NULL),
    ),
    
    'rsvp_guestlist' => array(
      'theme paths' => array(file_directory_path()),
      'template' => 'themes/default/rsvp-guestlist',
      'arguments' => array('connector' => NULL, 'rsvp' => NULL, 'invite_target' => NULL, 'params' => NULL),
    ),

    'rsvp_guestlist_block' => array(
      'theme paths' => array(file_directory_path()),
      'template' => 'themes/default/rsvp-guestlist-block',
      'arguments' => array('connector' => NULL, 'rsvp' => NULL, 'invite_target' => NULL, 'params' => NULL),
    ),
    
  );
}

/**
 * Provides a pathetically small amount of help information for the rsvp module.
 *
 * @ingroup rsvp_forms
 */
function rsvp_help($path, $arg) {
    switch ($path) {
    case 'admin/help#rsvp':
    	
    	global $user;
      $output = '<p>'. t('The RSVP module lets users invite people by email to events and track a list of people who will be attending.    The RSVP module requires either the event module or the date module because it is necessary to specify a content type to invite people to first.') .'</p>';
      $output .= '<p>'. t('The RSVP module also lets users invite users subscribed to newsletters, which requires !simplenews installed, as well as invite other registered users.', array('!simplenews' => l(t('Simplenews module'), 'http://drupal.org/project/simplenews'))) .'</p>';
      $output .= '<p>'. t('The RSVP page shows an <em>Invitation</em> tab in the content type page and in the users <em>My account</em> page. There are confirmation screens for creating and editing invitations. Email addresses which are input for invitations have input validation.  RSVP also creates an invitation url by hash value access so that invitees can click a URL and be taken directly to their invitation. For each invitation there are view, edit, manage, and send tabs. Users can manage guests through the "manage guests" tab. Users can also send attendees a message through the send message tab.') .'</p>';
      $output .= t('<p>You can:</p>
<ul>
<li>Enable the RSVP module at !admin-modules.</li>
<li>Create an invitation by clicking the <strong>Create invitation</strong> link in the Invitation tab when displying your event.</li>
<li>View your invitations in your !rsvp-user.</li>
<li>View, edit, and invite more people to each invitation.</li>
<li>Manage all invitations at !rsvp-content.</li>
', array('!admin-modules' => l(t('Administer >> modules'), 'admin/build/modules'), 
         '!rsvp-user' => l(t('user profile'), 'user/'. $user->uid .'/rsvp'), 
         '!rsvp-content' => l(t('Administer >> Content management >> RSVP management'),'admin/content/rsvp')) ) .'</ul>';
      
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="!rsvp">RSVP page</a>.', array('!rsvp' => url('http://www.drupal.org/handbook/modules/rsvp/', array('external' => TRUE)))) .'</p>';
      return $output;
    case 'admin/modules#description' :
      return t('Provides rsvp functionality for node types enabled in the rsvp system.');
    case 'rsvp/'. arg(1) .'/message' :
      return t('You can send a message to the attendees of this invitation here.');
    case 'rsvp/'. arg(1) .'/attendees' :
      return t('You can add more persons to the invitation, remove invitees, or view the status of an invitees\'s invitation here.');
    case 'rsvp' :
      global $user;
      if (!$user->uid) {
        return t('You must %login or %register in order to manage your invitations from this site. Otherwise, please use the link provided in your email to reply. If the link does not work, contact the sender of the invitation to see if the event has been deleted.', array('%login' => l('login', 'user'), '%register' => l('create a user account', 'user/register')));
      }
  }
}

/**
 * Provides the rsvp permission information for the drupal system.
 *
 * @ingroup rsvp_core
 */
function rsvp_perm() {
  return array(RSVP_PERM_ADMIN, 
               RSVP_PERM_MAINTAIN, 
               RSVP_PERM_ONEVENTS, 
               RSVP_PERM_ONOWNEVENTS);
}

/**
 * Implementation of hook_cron
 * @ingroup rsvp_core
 *
 * Processing assuring that new users get their invitations associated with their account.
 */
function rsvp_cron() {
  db_query('UPDATE {rsvp_invite} r, {users} u SET r.uid = u.uid WHERE r.uid = 0 AND r.email = u.mail');
}

/**
 * Implementation of hook_init().
 */
function rsvp_init() {
//  drupal_add_css(drupal_get_path('module', 'rsvp') .'/rsvp.css', 'module', 'all', TRUE);
}

/**
 * Implementation of hook_menu().
 *
 * @ingroup rsvp_core
 * 
 */
function rsvp_menu() {

  $connector = new RsvpConnector();
  
  $items = array();

  //admin settings tab
  $items['admin/settings/rsvp'] = array(
    'title' => 'RSVP settings',
    'type' => MENU_NORMAL_ITEM,
    'description' => 'Set up RSVP related options.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_general'),
    'access arguments' => array(RSVP_PERM_ADMIN),
    'description' => 'Configure general RSVP settings.',
    'file' => 'rsvp.admin.inc',
  );
  
  $items['admin/settings/rsvp/general'] = array(
    'title' => 'General',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_general'),
    'access arguments' => array(RSVP_PERM_ADMIN),
    'weight' => -10,
    'description' => 'Configure general RSVP settings.',
    'file' => 'rsvp.admin.inc',
  );

  $items['admin/settings/rsvp/defaults'] = array(
    'title' => 'Default settings',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_default'),
    'access arguments' => array(RSVP_PERM_ADMIN),
    'weight' => -9,
    'description' => 'Configure default options for invitations',
    'file' => 'rsvp.admin.inc',
  );
  
  $items['admin/settings/rsvp/types'] = array(
    'title' => 'Associations',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_types'),
    'access callback' => 'rsvp_admin_type_access',
    'access arguments' => array($connector),
    'weight' => -9,
    'description' => 'Manage associations with content types that you want to use within invitations.',
    'file' => 'rsvp.admin.inc',
  );

  $items['admin/settings/rsvp/types/list'] = array(
    'title' => 'List associations',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_types'),
    'access callback' => 'rsvp_admin_type_access',
    'access arguments' => array($connector),
    'weight' => -8,
    'description' => 'Manage associations with content types that you want to use within invitations.',
    'file' => 'rsvp.admin.inc',
  );
  
  $items['admin/settings/rsvp/types/add'] = array(
    'title' => 'Add association',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_types_add'),
    'access callback' => 'rsvp_admin_type_access',
    'access arguments' => array($connector),
    'weight' => -7,
    'description' => 'Add a association with a content type that you want to use within invitations.',  
    'file' => 'rsvp.admin.inc',
  );
  
  $items['admin/settings/rsvp/types/add/%'] = array(
    'title' => 'Select field for association',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_types_add_field', 5),
    'access callback' => 'rsvp_admin_type_access',
    'access arguments' => array($connector),
    'file' => 'rsvp.admin.inc',
  );
    
  $items['admin/settings/rsvp/types/delete/%'] = array(
    'title' => 'Delete association',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_admin_settings_types_delete', 5),
    'access callback' => 'rsvp_admin_type_access',
    'access arguments' => array($connector),
    'file' => 'rsvp.admin.inc',
  );
  
  //admin content tab
  $items['admin/content/rsvp'] = array(
    'title' => 'RSVP management',
    'type' => MENU_NORMAL_ITEM,
    'description' => 'Manage all invitations.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_overview_created_form', NULL, NULL),
    'access callback' => 'rsvp_overview_created_form_access',
    'access arguments' => array($connector, NULL, NULL),
    'description' => 'Manage all invitations.',
  );
  
  
  // user account tabs
  $items['user/%user/rsvp'] = array(
    'title' => 'Invitations',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_overview_form', NULL, 1),
    'access callback' => 'rsvp_overview_form_access',
    'access arguments' => array($connector, 1, NULL),
  );
    
  // email response path (for guest access)
  $items['rsvp/email/%rsvp_hash/edit'] = array(
    'title' => 'Edit guests reply',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_guest_editreply_form', 2),
    'access callback' => 'rsvp_guest_editreply_form_access',
    'access arguments' => array($connector, 2),
    'weight' => 0,
  );
  $items['rsvp/email/%rsvp_hash'] = array(
    'title' => 'View invitation',
    'type' => MENU_NORMAL_ITEM,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_invite_view_form', NULL, 2),
    'access callback' => 'rsvp_invite_view_form_access',
    'access arguments' => array($connector, NULL, 2),
    );
  $items['rsvp/email/%rsvp_hash/view'] = array(
    'title' => 'View invitation',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_invite_view_form', NULL, 2),
    'access callback' => 'rsvp_invite_view_form_access',
    'access arguments' => array($connector, NULL, 2),
    'weight' => 0,
  );
  $items['rsvp/email/%rsvp_hash/attendees'] = array(
    'title' => 'Add guests',
    'type' => MENU_LOCAL_TASK,
    'description' => 'Add more guests to the invitation.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_attendee_hash_form', 2),
    'access callback' => 'rsvp_attendee_hash_form_access',
    'access arguments' => array($connector, 2),
    'weight' => 1,
  );
  $items['rsvp/email/%rsvp_hash/message'] = array(
    'title' => 'Send message',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_message_hash_form', 2),
    'access callback' => 'rsvp_hash_sendmessage_access',
    'access arguments' => array($connector, 2),
    'weight' => 2,
  );
  $items['rsvp/email/%rsvp_hash/csv'] = array(
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_csv_hash_form', NULL, 2),
    'access callback' => 'rsvp_csv_hash_form_access',
    'access arguments' => array($connector, NULL, 2),
  );
  $items['rsvp/email/%rsvp_hash/realname'] = array(
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_changerealname_form', 2),
    'access callback' => 'rsvp_changerealname_form_access',
    'access arguments' => array($connector, 2),
  );
  $items['node/%node/rsvp'] = array(
    'title' => 'Invitations',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_overview_form', 1, NULL),
    'access callback' => 'rsvp_overview_form_access',
    'access arguments' => array($connector, NULL, 1),
    'weight' => 3,
  );
  $items['node/%node/rsvp/create'] = array(
    'title' => 'Create invitation',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_addedit_form', 1, NULL),
    'access callback' => 'rsvp_addedit_form_access',
    'access arguments' => array($connector, NULL, 1, RSVP_ACCESS_CREATE),
    'description' => 'Create a new invitation.',
  );

  // rsvp management tabs
  $items['rsvp/%rsvp'] = array(
    'title' => 'View',
    'type' => MENU_NORMAL_ITEM,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_invite_viewonly_form', 1, NULL),
    'access callback' => 'rsvp_invite_viewonly_form_access',
    'access arguments' => array($connector, 1, NULL),
    'weight' => '0',
  );
  $items['rsvp/%rsvp/view'] = array(
    'title' => 'View',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_invite_viewonly_form', 1, NULL),
    'access callback' => 'rsvp_invite_viewonly_form_access',
    'access arguments' => array($connector, 1, NULL),
    'weight' => '0',
  );
  $items['rsvp/%rsvp/owner'] = array(
    'title' => 'Change the owner of the invitation',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_changeowner_form', 1),
    'access callback' => 'rsvp_changeowner_form_access',
    'access arguments' => array($connector, 1),
  );
  $items['rsvp/%rsvp/msg_moderator'] = array(
    'title' => 'Send me a message when guests reply',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_msg_moderator_form', 1),
    'access callback' => 'rsvp_msg_moderator_form_access',
    'access arguments' => array($connector, 1),
  );
  
  $items['rsvp/%rsvp/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_addedit_form', NULL, 1),
    'access callback' => 'rsvp_addedit_form_access',
    'access arguments' => array($connector, 1, NULL, RSVP_ACCESS_EDIT),
    'weight' => '1',
    'description' => 'Modify an existing invitation.',
  );
  $items['rsvp/%rsvp/attendees'] = array(
    'title' => 'Manage guests',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_attendee_form', 1, NULL, NULL),
    'access callback' => 'rsvp_attendee_form_access',
    'access arguments' => array($connector, 1, NULL),
    'weight' => '2',
  );
  $items['rsvp/%rsvp/attendees/send'] = array(
    'title' => 'Send invitation email',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_attendees_send_invitation_form', 1, NULL),
    'access callback' => 'rsvp_attendees_send_invitation_form_access',
    'access arguments' => array($connector, 1, NULL),
    'weight' => '2',
  );
  $items['rsvp/%rsvp/attendees/send/%'] = array(
    'title' => 'Send invitation email',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_attendees_send_invitation_form', 1, 4),
    'access callback' => 'rsvp_attendees_send_invitation_form_access',
    'access arguments' => array($connector, 1, NULL),
    'weight' => '2',
  );
  $items['rsvp/%rsvp/attendees/csv'] = array(
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_csv_hash_form', 1, NULL),
    'access callback' => 'rsvp_csv_hash_form_access',
    'access arguments' => array($connector, 1, NULL),
  );
  $items['rsvp/%rsvp/attendees/remove/%'] = array(
    'title' => 'Remove guest from guest list',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_remove_guest_form', 1, 4),
    'access callback' => 'rsvp_function_invitation_by_invite_access',
    'access arguments' => array($connector, 1, NULL, NULL, RSVP_ACCESS_EDIT),
  );
  $items['rsvp/%rsvp/attendees/status/%'] = array(
    'title' => 'Status of attendee',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_guest_status_form', 1, 4),
    'access callback' => 'rsvp_function_invitation_by_invite_access',
    'access arguments' => array($connector, 1, NULL, NULL, RSVP_ACCESS_EDIT),
  );
  
  $items['rsvp/%rsvp/message'] = array(
    'title' => 'Send message',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_message_form', 1, NULL),
    'access callback' => 'rsvp_function_invitation_by_invite_access',
    'access arguments' => array($connector, 1, NULL, NULL, RSVP_ACCESS_EDIT),
    'weight' => '3',
  );
  $items['rsvp/%rsvp/message/%'] = array(
    'title' => 'Send message',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_message_form', 1, 3),
    'access callback' => 'rsvp_function_invitation_by_invite_access',
    'access arguments' => array($connector, 1, NULL, NULL, RSVP_ACCESS_EDIT),
  );
  $items['rsvp/%rsvp/delete'] = array(
    'title' => 'Delete invitation',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_delete_form', 1),
    'access callback' => 'rsvp_function_invitation_by_invite_access',
    'access arguments' => array($connector, 1, NULL, NULL, RSVP_ACCESS_DELETE),
  );
  $items['rsvp/%rsvp/register'] = array(
    'title' => 'Open Signup to invitation',
    'type' => MENU_LOCAL_TASK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('rsvp_register_form', 1),
    'access callback' => 'rsvp_register_form_access',
    'access arguments' => array($connector, 1),
    'description' => 'Allows to signup for open invitation',
  );
  
  //javascript calls
  $items['rsvp/js/stylesheet'] = array(
    'page callback' => 'rsvp_stylesheet_options_update',
    'access callback' => 'rsvp_function_invitation_by_invite_access',
    'access arguments' => array($connector, 1, NULL, NULL, RSVP_ACCESS_EDIT),
    'type' => MENU_CALLBACK,
    'file' => 'rsvp.form.inc',
  );
  
  
  return $items;
}

/**
 * Provides the links that should be displayed when viewing rsvp.
 *
 * @ingroup rsvp_forms
 *  
 * @param $type the type of link (for example, 'node', 'page', or 'system') being requested
 * @param $node the node that is requesting the link.  This is used in conjunction with $type to further determine
 *        what sort of link to display.
 * @return an array of links, or an empty array if no links apply for the criteria passed to this method.
 */
function rsvp_link($type, $node = NULL, $teaser = FALSE) {
  $links = array();
  
  if ($type == 'node') {
  	
    $connector = new RsvpConnector();
  	
    if ($connector->is_event_enabled($node->type) == true) {
      global $user;
    
      $print_startdate = false;
    
    	// node links
      $field = rsvp_function_getFieldforContentType($node->type);

      //first collect all invitations that the user received for the node
      $num_invites = db_result(rsvp_function_load_invitations_node2($node->nid, $user->uid, true));
      if ($num_invites > 0) {
        if ($num_invites > 1) {
          $print_startdate = true;	
        }
    
        $invitations = rsvp_function_load_invitations_node2($node->nid, $user->uid);
        while ($invite_target = db_fetch_object($invitations)) {
          $rsvp = rsvp_function_load_rsvp($invite_target->rid);
        	$text = 'Reply to invitation';
      
        	if ($print_startdate == true) {
        	  $pos = $connector->get_posByHash($node, $field, $rsvp->startdate );
            if ($pos >= 0) {
              $startdate = $connector->get_startdateAsString($node, $field, $pos);
            }
            else {
              $startdate = 'UNKNOWN STARTDATE:' . $rsvp->startdate; 
            }
              $text .= '(' . $startdate . ')'; 	
          }
      	  $links['rsvp_invite_' . $invite_target->hash] = array('title' => t($text), 
                                                                'href' => 'rsvp/email/'. $invite_target->hash . '/view',
                                                               );
        }
      }
    
      //In a second step collect all invitations for the node that a user has view permissions to.
      $rsvps = rsvp_function_load_invitations_owner($node->nid, NULL, NULL);
	    while ($rsvp = db_fetch_object($rsvps)) {	  	
        list($perm_view, $perm_reply, $perm_moderator) = rsvp_function_invitation_by_invite_accessarray($connector, $rsvp, NULL, NULL, array(RSVP_ACCESS_VIEW, RSVP_ACCESS_REPLY, RSVP_ACCESS_EDIT), NULL);

        if ($perm_view == true) {  
        	
        	$text = 'View invitation';

        	//never print startdate for the invitations you have view permissions. Assume we have only one.
        	if (false) {
            $pos = $connector->get_posByHash($node, $field, $rsvp->startdate /*derived by query*/);
            if ($pos >= 0) {
              $startdate = $connector->get_startdateAsString($node, $field, $pos);
            }
            else {
              $startdate = 'UNKNOWN STARTDATE:' . $rsvp->startdate; 
            }

            $text .= '(' . $startdate . ')';  
          }
          
          if ($perm_reply == false) {
          	//access because of view by role permission.(perm_view = true and perm_reply = false)
            $links['rsvp_rsvp_' . $rsvp->rid] = array('title' => t($text), 'href' => 'rsvp/'. $rsvp->rid . '/view');
            if (rsvp_register_form_access($connector, $rsvp) == true) {
              $links['rsvp_rsvpregister_' . $rsvp->rid] = array('title' => t('Signup to invitation'), 'href' => 'rsvp/'. $rsvp->rid . '/register');
            }
          }
          else {
            //if we are a moderator, display link as well.
          	if ($perm_moderator == true)
              $links['rsvp_rsvp_' . $rsvp->rid] = array('title' => t($text), 'href' => 'rsvp/'. $rsvp->rid . '/view');
          }
        }
  	  }
    }
  }  
  return $links;
}


/**
* Act on nodes defined by other modules.
*
* @ingroup rsvp_forms
* @param $node The requested node.
* @param $op The requested operation.
* @return dbresultset of the requested rsvp.
*/
function rsvp_nodeapi(&$node, $op, $teaser, $page) {
  
	
  $connector = new RsvpConnector();
  
  if ($op == 'view') {

    if (!$teaser && $page) {
      //do not show guestlist for anonymous users
    	if (user_is_anonymous())
        return;
    	
    	global $user;
    	
      $content = '';
      $display = false;
      //In a first  step collect all invitations for the node that a user has view permissions to.
      $invitations = rsvp_function_load_invitations_user($user->uid, $node->nid);
      while ($invite_target = db_fetch_object($invitations)) {
        $rsvp = rsvp_function_load_rsvp($invite_target->rid);
      	
      	if ($rsvp->response_blind_node == RSVP_RESPONSE_SHOW) {
        	
        	$params = array();
          list($perm_view, $perm_guestonly) = rsvp_function_invitation_by_invite_accessarray($connector, $rsvp, $invite_target, NULL, array(RSVP_ACCESS_VIEW, RSVP_ACCESS_GUESTONLY), NULL);
          if (($perm_guestonly == true) || ($perm_view == true)) {
            if ($perm_guestonly == true) {
              $params['replybox'] = drupal_get_form('rsvp_reply_form', $rsvp, $invite_target);
              $display = true;
            }
            if ($perm_view == true) {  
              $params['guestlist'] = rsvp_show_guestlist($rsvp, NULL);
              $display = true;
            }
            $content .= theme('rsvp_invitation_page', $connector, $rsvp, $invite_target, $params);
            
          }
        }
      }

      if ($display == true) {
        $node->content['rsvp_guestlist'] = array(
          '#type' => 'item',
          '#value' => $content,
          '#weight' => 50,
        );
      }
    }
  }
  elseif ($op == 'delete') {
    // delete all Invitations associated with a node when the node is deleted
  	rsvp_api_remove_invitation(NULL, $node->nid);
  }
  else if ($op == 'presave') {
  	//load old version of node, and check if startdate has changed. If that is the case update invitation as well. 
  	//$old_node = node_load($node->nid);
  }
    	
}
//- automatic update of invitations startdate when startdate in node changes.
//- automatic remove guests uid from invitations if user is being removed.

/**
 * Implementation of hook_user().
 *
 * Checks whether an email address is subscribed to the newsletter when a new
 * user signs up. If so, changes uid from 0 to the new uid in
 * simplenews_subscriptions so that the user's subscription status is known when
 * he logs in.
 */
function rsvp_user($op, &$edit, &$account, $category = NULL) {
  switch ($op) {
    case 'insert':
      //Processing assuring that new users get their invitations associated with their account.
    	db_query("UPDATE {rsvp_invite} SET uid = %d WHERE uid = 0 AND email = '%s'", $edit['uid'], $edit['mail']);
      break;
    case 'delete':
      // Only remove uid from invitation data when account is removed
      db_query("UPDATE {rsvp_invite} SET uid = 0 WHERE uid = %d", $account->uid);
      break;
  }
}


/**
* hook_load
* Retrieves an rsvp from the database.
*
* @ingroup rsvp_forms
* 
* @param $rid The rid of the rsvp instance.
* @return The rsvp instance or false.
*/
function rsvp_load($rid) {
	return rsvp_function_load_rsvp($rid);
}

/**
* hook_load
* Retrieves an invitation from the database based on a hash.
*
* @ingroup rsvp_forms
* @param $hash_target The hash of a invite instance we want to load.
* @return The invite instance or false.
*/
function rsvp_hash_load($hash_target) {
  
  $invite_target = rsvp_function_load_invitation_hash($hash_target);
  return $invite_target;
}

/**
* Shows the list of created invitations for a particular user/node.
* This form is being called only for moderator purposes.
*
* @ingroup rsvp_forms
* 
* @param $node The node object you want to manage the rsvp instances for, or NULL for all nodes.
* @param $usr The user. If NULL show invitations for the logged in user.
* @return themed rsvp manage response.
*
* This form is being called from three places:
* - Through "rsvp_overview_form" (user/%uid/rsvp): The current user wants to displays all Invitations of a particular user that he is entitled to
*       params: NULL, $user
* 
* - Through "rsvp_overview_form" (node/%node/rsvp): A User selects a node and then clicks the "Invitation" tab if visible
*       params: $node, NULL
* 
* - The RSVP management page (admin/content/rsvp): A maintainer displays all generated invitations
*       params: NULL, NULL
* 
*/
function rsvp_overview_created_form(&$form_state, $node = NULL, $usr = NULL) {

  $allNodes = (is_null($node));
	$allUsers = (is_null($usr) && ($allNodes == true));

	if ($allUsers == true) {
		rsvp_function_session_parent('admin/content/rsvp');
	} 
	else if ($allNodes == true) {
    rsvp_function_session_parent('user/'. $usr->uid .'/rsvp');
	}
	else {
    rsvp_function_session_parent('node/'. $node->nid .'/rsvp');
  }
	
  $form = array();

  
  $allExpired = true;  //are all dates for a node are expired?
  
  
  $connector = new RsvpConnector();
  
  //create header
  $header = array();
  
  if ($allNodes == true) {
    $header[] = array('data' => t('Event'), 'field' => 'title');
  }
  $header[] = array('data' => t('Title'), 'field' => 'name', 'sort' => 'asc', 'width' => '20%');
  $header[] = t('Owner');
  
  $header[] = t('Startdate');
  $header[] = t('Inv.');
  $header[] = t('Yes');
  $header[] = t('No');
  $header[] = t('Maybe');
  $header[] = t('No resp.');
  $header[] = array('data' => t('Operations'), 'colspan' => 4);


  //check if there is at least one date that has not been expired. 
  if (!$allNodes) {
    $allExpired = rsvp_function_is_expired($node);

    if (variable_get('rsvp_for_expired_event', RSVP_OPTION_NO) == RSVP_OPTION_YES)
      $allExpired = false;
  }

  //fill array with invitations
  $rows = array();
  
  //load rsvp always for all users. We later have to check if we have edit/view or no rights.
  $rsvps = rsvp_function_load_invitations_owner(($allNodes == true) ? NULL : $node->nid, NULL, tablesort_sql($header));

  while ($rsvp = db_fetch_object($rsvps)) {
    $field = NULL;
    if ($allNodes) {
        $node = rsvp_function_load_node($rsvp);
    }
    $_owner = user_load($rsvp->uid);
    if ($rsvp->uid_moderator != 0) {
      $_co_owner = user_load($rsvp->uid_moderator);
    	$co_owner_link = ' / ' . l($_co_owner->name, 'user/'. $_co_owner->uid, array('attributes' => array('title' => 'View moderator')));
    }
    else {
    	$co_owner_link = '';
    }
    
    $perm_edit = rsvp_function_invitation_by_invite_access($connector, $rsvp, NULL, NULL, RSVP_ACCESS_EDIT, NULL);

    if ($perm_edit == true) {  
      $field = rsvp_function_getFieldforContentType($node->type);

      $row = array();
      ($allNodes == true) ? $row[] = l($node->title, 'node/'. $rsvp->nid, array('attributes' => array('title' => 'View node'))) : '';
      $row[] = l($rsvp->name, 'rsvp/'. $rsvp->rid .'/view', array('attributes' => array('title' => 'View invitation')));

      $row[] = l($_owner->name, 'user/'. $rsvp->uid, array('attributes' => array('title' => 'View owner'))) . $co_owner_link;

      $pos = $connector->get_posByHash($node, $field, $rsvp->startdate);
      if ($pos >= 0)
        $row[] = $connector->get_startdateAsString($node, $field, $pos);
      else
        $row[] = 'UNKNOWN STARTDATE:' . $rsvp->startdate; 
      
      // add statistics
      $row[] = (int) db_result(rsvp_function_load_guests($rsvp->rid, RSVP_ATT_ALL, TRUE));
      $row[] = (int) db_result(rsvp_function_load_guests($rsvp->rid, RSVP_ATT_YES, TRUE));
      $row[] = (int) db_result(rsvp_function_load_guests($rsvp->rid, RSVP_ATT_NO, TRUE));
      $row[] = (int) db_result(rsvp_function_load_guests($rsvp->rid, RSVP_ATT_MAYBE, TRUE));
      $row[] = (int) db_result(rsvp_function_load_guests($rsvp->rid, RSVP_ATT_NONE, TRUE));
      $row[] = l(t('View'), 'rsvp/'. $rsvp->rid .'/view', array('attributes' => array('title' => 'View invitation')));
      $row[] = l(t('Edit'), 'rsvp/'. $rsvp->rid .'/edit', array('attributes' => array('title' => 'Edit invitation')));
      $row[] = l(t('Manage guests'), 'rsvp/'. $rsvp->rid .'/attendees', array('attributes' => array('title' => 'Invite more people to attend your event')));
      $row[] = l(t('Send message'), 'rsvp/'. $rsvp->rid .'/message', array('attributes' => array('title' => 'Send people you invited a message')));
      $rows[] = $row;
    }
  }
  
  if ($pager = theme('pager', NULL, 10, 0)) {
    $rows[] = array(array('data' => $pager, 'colspan' => count($header)));
  }

  //after collecting the input data, 
  //now start creating meaningful output depending on the situation in the right order.
  
  //display breadcrumbs, title and header line
  $header_text = NULL;
  $notfound_text = NULL;
  if ($allUsers == true) {
    $header_text = 'All invitations by all users';
    $notfound_text = 'No invitations available.';
  }
  else if ($allNodes == true) {
    $header_text =  'Your invitations that you created for all events';
    $notfound_text = 'You have not created any active invitations.';
    drupal_set_title(check_plain($usr->name));
    drupal_set_breadcrumb(array(l(t('Home'), NULL), l('My account', 'user/'. $usr->uid)));
  }
  else {
    $header_text = 'Invitations that you have created for this event';
    $notfound_text = 'You have not created any invitations for this event.';
    drupal_set_title(check_plain($node->title));
    drupal_set_breadcrumb(array(l(t('Home'), NULL), l($node->title, 'node/'. $node->nid)));
  }
  
  $form['rsvp_overview_created_form'] = array(
    '#type' => 'fieldset',
    '#title' => ' ', //avoids Iexplorer display problem of empty box(frame)
  );
  
  $form['rsvp_overview_created_form']['title'] = array('#value' => '<br /><div><h3>' . t($header_text) . '</h3><br /></div>');
  //TODO output needs to be improoved in version 2.0. 
  //Avoid displaying box if $rows is 0 and user is not allowed to create invitation.
  
  //display the invitations or an appropriate message.
  if (!$rows) {
    $form['rsvp_overview_created_form']['not_found'] = array('#value' => '<p>'. t($notfound_text) .'</p>');
  }
  else {
    $table = theme('table', $header, $rows);
    $form['rsvp_overview_created_form']['table'] = array('#value' => $table);
  }

  //display if the user is allowed to create an rsvp for an event.
  $content = NULL; 
  if ($allNodes == false) {
  	if ($allExpired == true) {
      $content = t('This event has expired. Invitations can only be created for events <br />that have not expired yet.');
  	}
   	else {
   		if (_rsvp_rsvp_by_node_access($connector, $node, RSVP_ACCESS_CREATE))
         $content = l(t('Create invitation'), 'node/'. $node->nid .'/rsvp/create');
   	}
  	
  }
  else {
    $content = t('(To create an invitation, select and view an !event, then select tab "Invitation" and click on "Create invitation").', 
                    array('!event'=> l(t('event'), 'tracker'))
               );
  	
  }
  $form['rsvp_overview_created_form']['content_message'] = array('#value' => '<p>'. $content .'</p>');      
 
  return $form;
}

/*
 * Access function to determine if the current user is allowed to see rsvp_overview_created_form
 *
 *
 * @ingroup rsvp_forms
 * 
 * @param $usr The user object that the current user wants to check for or NULL.
 * @param $node The node object you want to check for or NULL.
 * @return true or false.
 *  
 *      could be the user, admin or moderator. Verify that the current user is one of those persons.
 *
 * Used for menus 
 * - Through rsvp_overview_form (user/%uid/rsvp): Current user displays %uid's invitations (can be the same or not, e.g. moderator!)
 *       params: NULL, $user
 * 
 * - Through rsvp_overview_form (node/%node/rsvp): Current user selects a node and then clicks the "Invitation" tab if visible
 *       params: $node, NULL
 * 
 * - The RSVP management page (admin/content/rsvp): Current user displays all generated invitations (must be maintainer)
 *       params: NULL, NULL
 *  
 */
function rsvp_overview_created_form_access($connector, $node, $usr) {
  
	//don't show the frame for anonymous users.
  if (user_is_anonymous())
    return false;
	
	$display = false;
	if (!is_null($usr) && is_null($node)) {
		//verify that current user is usr.
    $perm_view = _rsvp_user_access($connector, $usr, RSVP_ACCESS_VIEW, NULL);
		if ($perm_view == true)
		  $display = true;
	}
  else if (is_null($usr) && !is_null($node)) {
    if (!$connector->is_event_enabled($node->type))
      return false;
  	
  	//checking for RSVP_ACCESS_VIEW takes too long. So assume we can see it, and then print a message if no RSVPs are available
  	//if (/*(_rsvp_rsvp_by_node_access($connector, $node, RSVP_ACCESS_VIEW) == true)*/true ||
    //TODO missing parameter
  	//(_rsvp_rsvp_by_node_access($connector, $node, RSVP_ACCESS_CREATE) == true))
      //check internally inside the form
      $display = true;
  }
  else if (is_null($usr) && is_null($node)) {
    $display = user_access(RSVP_PERM_MAINTAIN);
  }
  
	return $display;
}

/**
* Shows the invitations that a user has been invited to. 
*
* @ingroup rsvp_form
* 
* @param $node A node. Shows invitations to the current user for a particular node or NULL. If NULL, show for all nodes.
* @param $usr A user. Shows invitations to the current user for a particular user or NULL. If NULL show invitations for the logged in user. 

* @return themed response.
*
* This form is being called from three places:
* - Through "rsvp_overview_form" (user/%uid/rsvp): The current user wants to displays all Invitations of a particular user that he is entitled to
*       params: NULL, $user
* 
* - Through "rsvp_overview_form" (node/%node/rsvp): A User selects a node and then clicks the "Invitation" tab if visible
*       params: $node, NULL
*/
function rsvp_overview_invited_form(&$form_state, $node, $usr) {

  $form = array();
	
	$connector = new RsvpConnector();

  $displays_for_user = NULL;
  $_user = NULL;
  $_node = NULL;
  
  if (is_null($usr)) {
    //implies that $node must be valid.
    $displays_for_user = false;
    global $user;

    //anonymous user is not allowed to see this form.
    if (user_is_anonymous())
      return $form;
    
    $_user = $user;
    $_node = $node;
  }
  else {
    $displays_for_user = true;
    $_user = $usr;
    $_node = NULL;
    
  }
  
  $title = '';
  $display = false;
      
  //when we list invitations only for a particular node, $node is set. Otherwise $node is NULL.
  $invitations = rsvp_function_load_invitations_user($_user->uid, $_node->nid);

  $nid2inviteslist = array();
  while ($invite_target = db_fetch_object($invitations)) {
      $nid2inviteslist[$invite_target->nid][] = $invite_target;
  }

  foreach ($nid2inviteslist as $nid => $inviteslist) {
    $links = array();
    if ($displays_for_user == true) {
      $_node = rsvp_function_load_node($nid);
    }
      
    foreach ($inviteslist as $invite_target) {
      //In order to see this invitation, the current user should be either moderator or the user.
    	$perm_reply = rsvp_function_invitation_by_invite_access($connector, NULL, $invite_target, $_user->uid, RSVP_ACCESS_REPLY, NULL);
      if ($perm_reply == true) {
    	
        if ($_node) {
          $field = rsvp_function_getFieldforContentType($_node->type);
          $rsvp = rsvp_function_load_rsvp($invite_target->rid);
          $pos = $connector->get_posByHash($_node, $field, $rsvp->startdate);
          if ($pos >= 0) {
            $startdate = $connector->get_startdateAsString($_node, $field, $pos);
          }
          else {
            $startdate = 'UNKNOWN STARTDATE:' . $rsvp->startdate; 
          }
          $links[] = l($rsvp->name . ' (' . $startdate . ')', "rsvp/email/". $invite_target->hash . "/view", array('attributes' => array('title' => t('View invitation'))));
          $display = true;
        }
        else {
          // node has been deleted
          $links[] = l($invite_target->name, "rsvp/email/". $invite_target->hash. "/view", array('attributes' => array('title' => t('View invitation'))));
          $display = true;
        }   
        
      }
    }   
    if ($_node) {
      if ($displays_for_user == true) {
        $title = t('For event: ') . l($_node->title, 'node/'. $_node->nid, array('attributes' => array('title' => t('View this node/event'))));
      }
      else {
        $title = NULL;          
      }
    }
    else {
      $title = t('Deleted events:');
    }
    
    $itemlist .= theme('item_list', $links, $title);
  }
  
  //after collecting the data, print all information in the right order to the screen.
  //setting breadcrumbs and title is not neccessary because form is always embedded and the outer form has to set the breadcrumbs
  if ($displays_for_user == true) {
    $header_text =  'Invitations that you have been invited to';
  }
  else {
    $header_text = 'Invitations for this event that you have been invited to';
  }
  
  //display invitation box only if we have to display invitations.
  if ($display == true) {
  
    $form['rsvp_overview_invited_form'] = array(
      '#type' => 'fieldset',
      '#title' => ' ', //avoids Iexplorer display problem of empty box(frame)
    );
  
    $form['rsvp_overview_invited_form']['title'] = array('#value' => '<br /><div><h3>' . t($header_text) . '</h3><br /><br /></div>');
  
    $form['rsvp_overview_invited_form']['item_lists'] = array('#value' => $itemlist);
    
/*  
  if (count($nid2inviteslist) == 0) {
    if ($displays_for_user == true) {
      $output = '<p>'. t('You have not been invited to any events yet.') .'</p>';
    }
    else {
      $output = '<p>'. t('You have not been invited to this event.') .'</p>';
    }
      
    $form['rsvp_overview_form']['content'] = array( '#value' => $output );      
  }
*/
  }
  
  return $form;
}

/**
* Shows the invitations that a user has view access to by role (set by setting "Invitation message - view permissions"). 
*
* @ingroup rsvp_form
* 
* @param $node A node. Shows invitations to the current user for a particular node or NULL. If NULL, show for all nodes.
* @param $usr A user. Shows invitations to the current user for a particular user or NULL. If NULL show invitations for the logged in user. 