modules/lm_paypal/lm_paypal_subscriptions.module

<?php

// $Id: lm_paypal_subscriptions.module,v 1.32 2007/07/20 19:37:50 leemcl Exp $

/**
 * @file
 *
 * PayPal Subscriptions interface.
 *
 * Lee McLoughlin <lee@lmmrtech.com>. July 2006
 * This is a Drupal 4.7 module to handle PayPal subscriptions.
 *
 * It requires the lm_paypal module to be installed, enabled and configured.
 *
 * This module is licensed under  Gnu General Public License Version 2
 * see the LICENSE.txt file for more details.
 */

//TODO:
// Admin option to add a user to a sub with an auto unsub at end of period
//  probably best to do this with an option under edit user otherwise hard to
//  find the user to add
// Add a subscr_modify based option to create buttons to extend a subscription
// find a way to export all subscriptions from paypal and consolidate them
//  against those in this module
// change all the output blocks so they can be themed more easily
// go thru all the fields in the ips table and see what is actually needed
// On deleting a user issue a cancel on any subscriptions - can't do that from
//  here, can only cancel on PayPal

define(LM_PAYPAL_SUBSCRIPTIONS, 'LM_PayPal_Subs');

// Don't change these here! Use the admin interface at admin/lm_paypal_subscriptions
define(LM_PAYPAL_SUBSCRIPTIONS_INPROGRESS_DEFAULT, '/lm_paypal/subscriptions_inprogress');
define(LM_PAYPAL_SUBSCRIPTIONS_MENU_REBUILD_DEFAULT, FALSE);

define(LM_PAYPAL_SUBSCRIPTIONS_UID_ADMIN_DEFAULT, 1);
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONSUB_DEFAULT, 1);
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONSUB_SUBJECT, 'New subscriber %Username to %Subscription%Node on %Site');
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONSUB_BODY, 'The user %Username has subscribed to %Subscription%Node on %Site on %Date');

define(LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONEND_DEFAULT, 1);
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONEND_SUBJECT, 'User %Username leaves %Subscription%Node on %Site');
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONEND_BODY, 'The user %Username has ended their subscription to %Subscription%Node on %Site on %Date by %End');

define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONSUB_DEFAULT, 0);
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONSUB_SUBJECT_DEFAULT, 'Welcome to %Subscription%Node');
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONSUB_BODY_DEFAULT, 'Hello %Username and welcome to your new subscription %Subscription%Node on %Site');

define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONNEAREND_DEFAULT, 0);
define(LM_PAYPAL_SUBSCRIPTIONS_NEAREND_DAYS_DEFAULT, 5);
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONNEAREND_SUBJECT_DEFAULT, 'Your subscription %Subscription ends soon');
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONNEAREND_BODY_DEFAULT, 'Hello %Username your subscription to %Subscription on %Site ends in %Days days.');

define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONEND_DEFAULT, 0);
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONEND_SUBJECT_DEFAULT, 'Goodbye from %Subscription');
define(LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONEND_BODY_DEFAULT, 'Hello %Username and thank you for being a subscriber to %Subscription on %Site. We hope you will join us again.');

define(LM_PAYPAL_SUBSCRIPTIONS_TERMS_DEFAULT, '');

// In theory a subscription will go:
// signedup, live, EOT (end of term) or cancelled
// however sometimes (often) a subscr_payment will arrive before a subscr_signup
//  so then you'll get paid, live... instead
// If the incoming subscription details dont match those expected it will
//  be blocked
// If the subscription amount is zero (probably for a trial period) then
//  no payment will arrive
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_DEAD, 0);
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_LIVE, 1); // dont change this one!
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_SIGNEDUP, 2);
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_PAID, 3);
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_CANCELLED, 4);
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_EOT, 5);
define(LM_PAYPAL_SUBSCRIPTIONS_STATUS_BLOCKED, 6);

/**
 * Initialize global variables.
 */
function _lm_paypal_subscriptions_ini() {
  _lm_paypal_ini();
  global $_lm_paypal_subscriptions_inprogress;	// page user is directed to on subscribe

  // In theory this shouldn't be necessary but I've had one user require it.
  global $_lm_paypal_subscriptions_menu_rebuild; // rebuild menu cache on role or group change

  // Status of subscribers
  global $_lm_paypal_subscriptions_stati;

  static $inited = 0;

  if ($inited) {
    return;
  }
  $inited = 1;

  $_lm_paypal_subscriptions_inprogress = variable_get('lm_paypal_subscriptions_inprogress', LM_PAYPAL_SUBSCRIPTIONS_INPROGRESS_DEFAULT);
  $_lm_paypal_subscriptions_menu_rebuild = variable_get('lm_paypal_subscriptions_menu_rebuild', LM_PAYPAL_SUBSCRIPTIONS_MENU_REBUILD_DEFAULT);

  $_lm_paypal_subscriptions_stati = array(
    0 => t('dead'),
    1 => t('live'),
    2 => t('signedup'),
    3 => t('paid'),
    4 => t('cancelled'),
    5 => t('eot'),
    6 => t('blocked'),
  );
}

/**
 * Implementation of hook_help().
 */
function lm_paypal_subscriptions_help($section) {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_welcome;	// Welcome message
  global $_lm_paypal_drupal_major;
  global $base_url;

  $groups = l(t('create content > group'), 'node/add/og');
  $subs = l(t('LM PayPal Subscriptions'), 'admin/lm_paypal/subscriptions');
  if ($_lm_paypal_drupal_major > 4) {
    // Drupal 5
    $c = '!'; // t() has changed and to use a link in it use '!'
    $admin = l('LM PayPal Admin', 'admin/lm_paypal/settings');
    $roles = l(t('user management > roles'), 'admin/user/roles');
    $access = l(t('user management > access control'), 'admin/user/access');
    $blocks = l(t('site building > blocks'), 'admin/build/block');
  }
  else {
    // Drupal 4
    $c = '%';
    $admin = l('LM PayPal Admin', 'admin/settings/lm_paypal');
    $roles = l(t('access control > roles'), 'admin/access/roles');
    $access = l(t('access control'), 'admin/access');
    $blocks = l(t('administer blocks'), 'admin/block');
  }
  $help_subs = l(t('LM PayPal Subscriptions Help'), 'admin/help/lm_paypal_subscriptions');

  switch ($section) {
    // admin/help/lm_paypal_subscriptions
    case 'admin/help#lm_paypal_subscriptions':
      $output = $_lm_paypal_welcome;

      $output .= '<p><b>'. t('Special Notes') . ':</b>';
      $output .= '<ul>';
      $output .= '<li><b>' . t('This module requires the module lm_paypal to be installed, enabled and configured.') . '</b></li>';
      $output .= '<li>' . t('This module does not provide access control. The subscriptions defined here allow paid membership of a role or Organic Group only. Use this module in conjunction with an access control module such as <a href="http://drupal.org/project/taxonomy_access">Taxonomy Access Control</a> or <a href="http://drupal.org/project/premium">Premium</a> to restrict the actions of a role on your site.') . '</li>';
      $output .= '<li>' . t('You must use the subscription buttons generated by this module. The button factory on PayPal cannot add all the information this module needs.') . '</li>';
      $output .= '<li>' . t('Only authenticated users can take out subscriptions.') . '</li>';
      $output .= '</ul>';
      $output .= '</p>';

      $output .= '<h2>' . t('Initial Configuration') . '</h2>';
      $output .= '<p>' . t('If you are new to this module you need to:');
      $output .= '<ul>';
      $output .= '<li>' . t("Update the site specific settings via ${c}admin. Normally you only need to provide your PayPal Business Email.", array("${c}admin" => $admin)) . '</li>';
      $output .= '<li>' . t("For role subscriptions, if not already created, use ${c}roles to create one or more additional roles to be associated with the subscriptions you are about to create.", array("${c}roles" => $roles)) .'</li>';
      $output .= '<li>' . t("For Organic Group (OG) subscriptions, if not already created, use ${c}groups to create one or more additional groups.", array("${c}groups" => $groups)) .'</li>';
      $output .= '<li>' . t('For role subscriptions configure your chosen access control module, for example <a href="http://drupal.org/project/taxonomy_access">Taxonomy Access Control</a> or <a href="http://drupal.org/project/premium">Premium</a>, to restrict roles as appropriate for your setup.') . '</li>';
      $new = l(t('Create New Subscription'), 'admin/lm_paypal/subscriptions/new');
      $output .= '<li> ' . t("Use ${c}new to create one or more subscription definitions.", array("${c}new" => $new)) .'</li>';
      $output .= '<li>' . t("Make sure the right roles (usually just 'authenticated user') can see these subscription definitions by enabling it in ${c}access under <b>lm_paypal_module</b> 'access lm_paypal_subscribe'. ", array("${c}access" => $access));
      $output .=    t('<em>Special note:</em> If anonymous users are allowed to view the subscriptions pages then they are asked to login or register instead of subscribing. ') .'</li>';
      $output .= '<li>' . t('Once completed the new menu item <b>PayPal Subscribe</b> will become available allowing users to select the subscriptions they wish to purchase. Users can also view their subscriptions under <b>my account</b>.') .'</li>';
      $output .= '</ul>';
      $output .= '</p>';

      $output .= '<h2>' . t('Blocks') . '</h2>';
      $output .= '<p>' . t("For each role or group subscription defined a subscribe block becomes automatically available. These can be configured via ${c}blocks", array("${c}blocks" => $blocks)) . '</p>';
      $output .= '<p><b>' . t('Special note:') . '</b> ' . t('subscription blocks are only displayed to logged in users who do not already have that subscription.') . '</p>';

      $output .= '<h2>' . t('Inline PHP Snippet') . '</h2>';
      $output .= '<p>'. t("The following PHP snippet shows how to make a subscribe button appear for the subscription with a subid of 1. Admin's can find the subid via ${c}subs", array("${c}subs" => $subs)) . '</p>';
      $output .= '<p>'. t('Note that nothing will appear if they are either not able to subscribe (not logged in) or if they have already subscribed:') .'</p>';
      $output .= '<pre>'. t('&lt;?php
if (function_exists(\'lm_paypal_can_subscribe\')) {
  $subid = 1;
  if (lm_paypal_can_subscribe ($subid)) {
    print \'Why not subscribe now? \' . lm_paypal_subscribe($subid,8);
  }
}
?&gt;') .'</pre>';
      $output .= '<p>'. t('It is best to check that the lm_paypal_can_subscribe function exists before using it just in case the module has been disabled.') . '</p>';

      $output .= '<h2>'. t('Viewing Subscriptions/Subscribers') .'</h2>';
      $output .= '<p>'. t("To view all subscriptions and everyone who has subscribed to them use ${c}subs", array("${c}subs" => $subs)) . '</p>';

      return $output;

    // This is the brief description of the module displayed on the modules page
    case 'admin/modules#description':
      return t('Provides PayPal subscriptions to Drupal roles (requires lm_paypal).');

    // This appears at the start of the module admin page
    case 'admin/settings/lm_paypal_subscriptions':
    // The admin page under Drupal 5
    case 'admin/lm_paypal/subscriptions_settings':
    // This appears at the start of the admin page
    case 'admin/lm_paypal/subscriptions':
    // This appears at the start of the new subscription page
    case 'admin/lm_paypal/subscriptions/new':
      $output = $_lm_paypal_welcome;

      $output .= '<p>'. t("For detailed help please read ${c}help_subs", array("${c}help_subs" => $help_subs)) .'</p>';
      return $output;

    // This appears at the start of the subscriptions user page
    case 'lm_paypal/subscribe':
      $output .= '<p>'. t('The following lists all the subcriptions available via PayPal on this system. To take out one of these subscriptions you will need a login on this web site and a PayPal account. If you do not already have a PayPal account then PayPal will show you how to get an account when you subscribe.') .'</p>';
      return $output;
  }
}

/**
 * Implementation of hook_perm().
 * Return a list of the access control permissions that this module defines
 */
function lm_paypal_subscriptions_perm() {
  return array('access lm_paypal_subscribe');
}

/**
 * Implementation of hook_menu().
 */
function lm_paypal_subscriptions_menu($may_cache) {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_drupal_major;

  $items = array();

  if ($may_cache) {
    // TODO: For Drupal 5 put all the subscription admin menu entries into
    //  their own section
    if ($_lm_paypal_drupal_major > 4) {
      // New to Drupal 5 - hook_settings gone so settings is a normal page
      $items[] = array(
        'path' => 'admin/lm_paypal/subscriptions_settings',
        'title' => t('LM PayPal Subscriptions Settings'),
        'callback' => 'drupal_get_form',
        'callback arguments' => array('lm_paypal_subscriptions_admin_settings'),
        'access' => user_access('administer site configuration'),
        'type' => MENU_NORMAL_ITEM,
        'weight' => 1,
        // New to Drupal 5 - every path has a description
        'description' => t('PayPal subscriptions interface configuration.'),
      );
    }
    // Subscription admin
    $items[] = array(
      'path' => 'admin/lm_paypal/subscriptions',
      'title' => t('LM PayPal Subscriptions'),
      'callback' => 'lm_paypal_view_subscriptions',
      'access' => user_access('administer lm_paypal'),
      'weight' => -3,
      // New to Drupal 5 - every path has a description
      'description' => t('View PayPal subscriptions.'),
    );

    $items[] = array(
      'path' => 'admin/lm_paypal/subscriptions/new',
      'title' => t('LM PayPal Create New Subscription'),
      'callback' => 'lm_paypal_subscription_edit',
      'access' => user_access('administer lm_paypal'),
      // New to Drupal 5 - every path has a description
      'description' => t('Create new PayPal subscriptions.'),
    );

    $items[] = array(
      'path' => 'admin/lm_paypal/subscription/delete',
      'title' => t('LM PayPal Delete Subscription'),
      'type' => MENU_CALLBACK,
      'callback' => 'lm_paypal_subscription_delete',
      'access' => user_access('administer lm_paypal'),
     );

    $items[] = array(
      'path' => 'admin/lm_paypal/subscription',
      'title' => t('LM PayPal Show Subscription Details'),
      'type' => MENU_CALLBACK,
      'callback' => 'lm_paypal_subscription',
      'access' => user_access('administer lm_paypal'),
    );

    $items[] = array(
      'path' => 'admin/lm_paypal/subscribers',
      'title' => t('LM PayPal Show Subscribers'),
      'type' => MENU_CALLBACK,
      'callback' => 'lm_paypal_subscribers',
      'access' => user_access('administer lm_paypal'),
    );

    $items[] = array(
      'path' => 'admin/lm_paypal/subscriber_edit',
      'title' => t('LM PayPal Edit Subscriber'),
      'type' => MENU_CALLBACK,
      'callback' => 'lm_paypal_subscriber_edit',
      'access' => user_access('administer lm_paypal'),
    );

    // User page to subscribe
    $items[] = array(
      'path' => 'lm_paypal/subscribe',
      'title' => t('PayPal Subscribe'),
      'callback' => 'lm_paypal_subscribe',
      'access' => user_access('access lm_paypal_subscribe'),
      // New to Drupal 5 - every path has a description
      'description' => t('Subscribe using PayPal.'),
    );

    // By default we tell Paypal to redirect users here after subscribing
    $items[] = array(
      'path' => 'lm_paypal/subscriptions_inprogress',
      'title' => t('LM PayPal Subscription In Progress'),
      'type' => MENU_CALLBACK,
      'callback' => 'lm_paypal_subscriptions_inprogress',
      'access' => user_access('access lm_paypal_subscribe'),
    );

  }

  return $items;
}

// Ugly magic to hide lm_paypal_settings from Drupal 5.0 as it spots its
// existance and refuses to access the real page.
if (strncmp(VERSION, '4', 1) == 0) {
  /**
   * Implementation of hook_settings()
   * Note: hook_settings not used in Drupal 5.
   */
  function lm_paypal_subscriptions_settings() {
    return lm_paypal_subscriptions_settings_form();
  }
}

/**
 */
function lm_paypal_subscriptions_admin_settings() {
  $form = lm_paypal_subscriptions_settings_form();
  return system_settings_form($form);
}

/**
 */
function lm_paypal_subscriptions_settings_form() {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_subscriptions_inprogress;
  global $_lm_paypal_subscriptions_menu_rebuild;

  if (!user_access('administer lm_paypal')) {
    drupal_access_denied();
    return;
  }

  $form['lm_paypal_subscriptions_inprogress'] = array(
    '#type' => 'textfield',
    '#title' => t('LM PayPal subscription in progress page'),
    '#default_value' => $_lm_paypal_subscriptions_inprogress,
    '#maxlength' => 100,
    '#required' => TRUE,
    '#description' => t('The page the user is sent to by PayPal after a subscribe. The default is ') . LM_PAYPAL_SUBSCRIPTIONS_INPROGRESS_DEFAULT . t(' but you might want to point it at a page you have created yourself.'),
  );

  $form['lm_paypal_subscriptions_menu_rebuild'] = array(
    '#type' => 'checkbox',
    '#title' => t('Rebuild menu cache on subscription change'),
    '#default_value' => $_lm_paypal_subscriptions_menu_rebuild,
    '#description' => t('On a user being added to/removed from a subscription rebuild the menu cache. Needed only if user logout/login fails to get the right menu items.'),
  );

  return $form;
}

/**
 * Find all live node subscriptions.
 *
 * @return
 *   An array of of live node subscriptions
 */
function lm_paypal_subscription_node_subs() {
  $node_subs = array();
  $output = '';
  $sql = 'SELECT subid, item_name FROM {lm_paypal_subscriptions} WHERE status = 1 AND kind = 1';
  $subs = db_query($sql);
  if (db_num_rows($subs) <= 0) {
    return $node_subs;
  }

  while ($so = db_fetch_object($subs)) {
    $node_subs[$so->subid] = $so->item_name;
  }

  return $node_subs;
}

/**
 * Tests if the given node has a live subscription.
 * 
 * @param $nid
 *   The node to check for
 *
 * @return
 *   TRUE only if the node has a live subscription
 */
function lm_paypal_node_subscribed($nid,&$subid) {
  $sql = "SELECT * FROM {lm_paypal_subscribers} WHERE status = 1 AND nid = %d";
  $sbs = db_query($sql, $nid);
  if (db_num_rows($sbs) <= 0) {
    // No subscribers
    return FALSE;
  }
  
  if (!($sb = db_fetch_object($sbs))) {
    // TODO: No object.. is this an error?
    return FALSE;
  }

  $subid = $sb->subid;
  return TRUE;
}

/**
 * Display either all live subscriptions or a single one with a link to PayPal.
 *
 * @param $subid
 *   If given then a subscribe page is returned otherwise a list of
 *   available subscriptions is returned.
 * @param $display
 *   If just showing a single subscription then $diplay lists what to show.
 *   1 = item_name
 *   2 = description
 *   4 = human readable details of subscription
 *   8 = button
 *  16 = brief
 *  32 = no section header (applies to list of subscriptions, subid=null)
 *   These can be added to get combinations (eg: 11 = 1 + 2 + 8)
 *  64 = output a comma seperated list the current users subscriptions
 *       (or just none)
 * @param button_url
 *   The url of the button to display
 * @param nid
 *   For node subscriptions this is the node id
 */
function lm_paypal_subscribe($subid = null, $display = 15, $button_url = '', $nid = null, $account = null) {
  _lm_paypal_subscriptions_ini();
  global $user;
  global $_lm_paypal_debug;
  global $_lm_paypal_host;
  global $_lm_paypal_business;
  global $_lm_paypal_subscriptions_inprogress;
  global $_lm_paypal_drupal_major;
  global $_lm_paypal_js_hide_email;

  // Drupal 5 - t() has changed and to use a link in it use '!'
  $c = ($_lm_paypal_drupal_major > 4 ? '!' : '%');

  if (!is_null($account)) {
    // I am looking at an account other than current user.
    // I cannot tell if they are logged in or not .. so presume they are.
    $logged_in = true;
  }
  else {
    $logged_in = ($user->uid != 0);
  }


  $subid = check_plain($subid);

  // Print out the details of just one subscription
  if ($subid != '') {
    if (!is_numeric($subid) || intval($subid) != $subid) {
      $err = t('lm_paypal_subscribe requires integer subid: %subid', array('%subid' => $subid));
      watchdog(
        LM_PAYPAL_SUBSCRIPTIONS,
        $err,
        WATCHDOG_ERROR);
      return $err;
    }

    if (!$logged_in) {
      $login = l(t('login'), 'user');
      $register = l(t('create new account'), 'user/register');
      return t("You must ${c}login or ${c}register to subscribe", array("${c}login" => $login, "${c}register" => $register));
    }

    $sql = "SELECT * FROM {lm_paypal_subscriptions} WHERE subid = %d AND status = 1";
    $subs = db_query($sql, $subid);
    $so = db_fetch_object($subs);
    if (! $so) {
      $err = t('lm_paypal_subscribe cannot find subscription: %subid', array('%subid' => $subid));
      watchdog(
        LM_PAYPAL_SUBSCRIPTIONS,
        $err,
        WATCHDOG_ERROR);
      return $err;
    }

    $output = '';
    $output .= '<p>' . lm_paypal_subscription($subid, $display) . '</p>';

    if (($display & 8) == 0) {
      // If I am not displaying a button then I am done.
      return $output;
    }

    $i_agree = $_SESSION['lm_paypal_I_agree'];
    if ($so->terms != '' && $i_agree != $subid) {
      $output .= lm_paypal_subscription_terms($subid, $so->terms);
      return $output;
    }
    $_SESSION['lm_paypal_I_agree'] = '';

    if ($button_url == '') {
      // This is the default paypal subscribe button
      $button_url = 'http://images.paypal.com/images/x-click-but20.gif';
      $button_url = 'http://images.paypal.com/images/x-click-butcc-subscribe.gif';
    }
    else {
      $button_url = check_url($button_url);
    }

    if ($so->return_url != '') {
      $ret_url = $so->return_url;
    }
    else {
      $ret_url = $_lm_paypal_subscriptions_inprogress;
    }
    if (variable_get('clean_url', 0)) {
      $return_url = url(check_url($ret_url), null, null, TRUE);
    }
    else {
      $return_url = url(null, 'q=' . check_url($ret_url), null, TRUE);
    }
    $notify_url = url('lm_paypal/ipn', null, null, TRUE);
    $biz = check_plain($_lm_paypal_business);
    $so->item_name = check_plain($so->item_name);

    // Output a form that will redirect the user to PayPal - note all the fields
    // are hidden so only the submit appears

    // If email hiding is enabled then turn on this javascript
    //  and add an onsubmit action
    $onsub = '';
    if ($_lm_paypal_js_hide_email) {
      lm_paypal_add_js();
      $at = strpos($biz, '@');
      $person = substr($biz, 0, $at);
      $host = substr($biz, $at + 1, strlen($biz));
      $biz = '';

      $onsub = "onsubmit=\"lm_paypal_setbiz(this,'$person','$host')\"";
    }

    $form = "\n<form action=\"http://$_lm_paypal_host/cgi-bin/webscr\" method=\"post\" $onsub>\n";

    $form .= "<input type=\"hidden\" name=\"cmd\" value=\"_xclick-subscriptions\">\n";
    $form .= "<input type=\"hidden\" name=\"business\" value=\"$biz\">\n";
    $form .= "<input type=\"hidden\" name=\"notify_url\" value=\"$notify_url\">\n";
    $form .= "<input type=\"hidden\" name=\"item_name\" value=\"$so->item_name\">\n";
    $form .= "<input type=\"hidden\" name=\"item_number\" value=\"$so->subid\">\n";
    $form .= "<input type=\"hidden\" name=\"no_shipping\" value=\"1\">\n";
    $form .= "<input type=\"hidden\" name=\"return\" value=\"$return_url\">\n";
    $form .= "<input type=\"hidden\" name=\"cancel_return\" value=\"$return_url\">\n";
    if ($so->currency_code) {
      $form .= "<input type=\"hidden\" name=\"currency_code\" value=\"$so->currency_code\">\n";
    }
    if ($so->p1 != '' && $so->p1 > 0) {
      $so->a1 = check_plain($so->a1);
      $so->p1 = check_plain($so->p1);
      $form .= "<input type=\"hidden\" name=\"a1\" value=\"$so->a1\">\n";
      $form .= "<input type=\"hidden\" name=\"p1\" value=\"$so->p1\">\n";
      $form .= "<input type=\"hidden\" name=\"t1\" value=\"$so->t1\">\n";
    }
    if ($so->p2 != '' && $so->p2 > 0) {
      $so->a2 = check_plain($so->a2);
      $so->p2 = check_plain($so->p2);
      $form .= "<input type=\"hidden\" name=\"a2\" value=\"$so->a2\">\n";
      $form .= "<input type=\"hidden\" name=\"p2\" value=\"$so->p2\">\n";
      $form .= "<input type=\"hidden\" name=\"t2\" value=\"$so->t2\">\n";
    }
    $so->a3 = check_plain($so->a3);
    $so->p3 = check_plain($so->p3);
    $form .= "<input type=\"hidden\" name=\"a3\" value=\"$so->a3\">\n";
    $form .= "<input type=\"hidden\" name=\"p3\" value=\"$so->p3\">\n";
    $form .= "<input type=\"hidden\" name=\"t3\" value=\"$so->t3\">\n";
    // If recurring times is set but recurring isn't then set it otherwise
    // PayPal will reject this request
    if ($so->srt != '' && $so->src == '') {
      $so->src = 1;
    }
    if ($so->src != '') {
      $form .= "<input type=\"hidden\" name=\"src\" value=\"$so->src\">\n";
      if ($so->srt != '') {
        $form .= "<input type=\"hidden\" name=\"srt\" value=\"$so->srt\">\n";
      }
    }
    $form .= "<input type=\"hidden\" name=\"sra\" value=\"1\">\n";
    $form .= "<input type=\"hidden\" name=\"no_note\" value=\"1\">\n";
    if ($so->kind == 0 || $so->kind == 2) {
      $custom = $user->uid;
    }
    if ($so->kind == 1) {
      $custom = ($nid << 16) | ($user->uid & 0xFFFF);
    }
    $form .= "<input type=\"hidden\" name=\"custom\" value=\"$custom\">\n";
    //$form .= "<input type=\"hidden\" name=\"invoice\" value=\"invoicenumber\">\n";
    $form .= "<input type=\"hidden\" name=\"usr_manage\" value=\"0\">\n";
    $form .= "<input type=\"image\" src=\"$button_url\" border=\"0\" name=\"submit\" alt=\"Make payments with PayPal - it's fast, free and secure!\">\n";
    $form .= "</form>\n";

    $output .= $form;
    return $output;
  }

  // Output a list of all the live role or group subscriptions
  $output = '';
  $sql = 'SELECT subid, item_name, description, status FROM {lm_paypal_subscriptions} WHERE status = 1 AND (kind = 0 OR kind = 2)';
  $subs = db_query($sql);
  if (db_num_rows($subs) <= 0) {
    $output .= '<p>' . t('No subscriptions currently defined') . '</p>';
    return $output;
  }

  if (($display & 64) != 0) {
    $nSubs = 0;
    while ($so = db_fetch_object($subs)) {
      $already = lm_paypal_user_subscribed($so->subid, $account);
      if (!$already) {
        continue;
      }
      $item_name = check_plain($so->item_name);
      if ($nSubs > 0) {
        $output .= ", ";
      }
      $output .= '"' . $item_name . '"';
      $nSubs ++;
    }
    if ($nSubs == 0) {
      $output .= t('<b>none</b>');
    }
    return $output;
  }

  if (($display & 32) == 0) {
    $output .= '<h2>' . t('Subscriptions') . '</h2>';
  }

  $header = array(t('Subscription Name'), t('Description'), '');
  while ($so = db_fetch_object($subs)) {
    $already = lm_paypal_user_subscribed($so->subid, $account);

    $item_name = check_plain($so->item_name);
    if ($already) {
      $sub = t('already subscribed');
    }
    else {
      if (!$logged_in) {
        $login = l(t('login'), 'user');
        $register = l(t('create new account'), 'user/register');
        $sub = t("You must ${c}login or ${c}register to subscribe", array("${c}login" => $login, "${c}register" => $register));
      }
      else {
        $sub = l(t('subscribe'), "lm_paypal/subscribe/$so->subid");
      }
    }

    $rows[] = array('data' => array($item_name, $so->description, $sub));
    $count++;
  }
  $output .= theme('table', $header, $rows);

  $alias = urlencode($_lm_paypal_business);
  $unsuburl = "https://$_lm_paypal_host/cgi-bin/webscr?cmd=_subscr-find&alias=$alias";

  $output .= '<h3>' . t('To Unsubscribe') . '</h3>';
  $output .= '<p>';
  $output .= t('Click unsubscribe to log in to your PayPal account. Click the Details of the subscription in question. Click Cancel Subscription.');
  $output .= "</p><p><a href=\"$unsuburl\">" . t('Unsubscribe') . '</a>';
  $output .= '</p>';

  return $output;
}

/**
 * Finds if a user is already subscribed to this subid
 *
 * @param $subid
 *   The subscription to check
 * @param $account
 *   The user to check, if null then the current user will be checked
 * 
 * @return
 *   TRUE only for role subscriptions and if the current user is subscribed
 */
function lm_paypal_user_subscribed($subid, $account = null) {
  global $user;

  if (is_null($account)) {
    $uid = $user->uid;
  }
  else {
    $uid = $account->uid;
  }

  $subid = check_plain($subid);

  if (!is_numeric($subid) || intval($subid) != $subid) {
    watchdog(
      LM_PAYPAL_SUBSCRIPTIONS,
      t('lm_paypal_user_subscribed requires integer subid: %subid', array('%subid' => $subid)),
      WATCHDOG_ERROR);
    return FALSE;
  }

  // kind 0 is a role subscription, kind 2 is a group
  $sql = "SELECT uid, subid, status, kind FROM {lm_paypal_subscribers} WHERE uid = %d AND subid = %d AND status = 1 AND (kind = 0 OR kind = 2)";
  $subs = db_query($sql, $uid, $subid);
  if (db_num_rows($subs) <= 0) {
    return FALSE;
  }
  
  $ss = db_fetch_object($subs);
  if (! $ss) {
    watchdog(
      LM_PAYPAL_SUBSCRIPTIONS,
      t('Cannot find the subscriber (uid %uid, subid %subid)', array('%uid' => $uid, '%subid' => $subid)),
      WATCHDOG_ERROR);
    return FALSE;
  }
  return TRUE;
}

/**
 * Tests if the current user, if any, can subscribe to a given subscription.
 * 
 * @param $subid
 *   The subscription the user is trying to subscribe to.
 *
 * @return
 *   TRUE only if there is a user and they have not already subscribed
 */
function lm_paypal_can_subscribe($subid) {
  global $user;
  if ($user->uid == 0 ) {
    return FALSE;
  }
  if (lm_paypal_user_subscribed($subid)) {
    return FALSE;
  }
  return TRUE;
}

/**
 * The user has to agree to the terms and conditions
 */
function lm_paypal_subscription_terms($subid, $terms) {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_drupal_major;

  if ($_lm_paypal_drupal_major > 4) {
    return drupal_get_form('lm_paypal_subscription_terms_form', $subid, $terms);
  }
  else {
    $form = lm_paypal_subscription_terms_form($subid, $terms);

    // Note: I've chosen a form_id the same as this function
    return drupal_get_form('lm_paypal_subscription_terms', $form);
  }
}

function lm_paypal_subscription_terms_form($subid, $terms) {
  // Under Drupal 5 this form has the following base name and all the
  // processing is done by calling #base_validate, ...
  $form['#base'] = 'lm_paypal_subscription_terms';

  $_SESSION['lm_paypal_I_agree'] = '';

  $terms = check_plain($terms);

  $form['terms'] = array(
    '#value' => t('<h2>Terms and Conditions</h2><p>') . $terms . 
     t('</p><p><em>Before you can subscribe you must agree to these terms and conditions</em></p>'),
  );

  $form['terms_subid'] = array(
    '#type' => 'hidden',
    '#value' => $subid,
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('I agree'),
  );

  return $form;
}

/**
 * Process "I Agree" to terms form
 *
 * @param $form_id
 *   The form_id that caused this _submit function to be called
 * @pararm $values
 *   The array of name,value pairs from the form
 *
 * @return
 *   The url to go to.
 *
 * The user has agreed to the terms and conditions. Allow them to subscribe.
 */
function lm_paypal_subscription_terms_submit($form_id, $values) {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_debug;

  $subid = ($values ['terms_subid']);
  $_SESSION['lm_paypal_I_agree'] = $subid;
  return 'lm_paypal/subscribe/' . $subid;
}


/**
 * Creates or edits a subscription.
 *
 * @param $subid
 *   If provided then edit this subscription instead creating a new one
 */
function lm_paypal_subscription_edit($subid = '') {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_drupal_major;

  if ($_lm_paypal_drupal_major > 4) {
    return drupal_get_form('lm_paypal_subscription_edit_form', $subid);
  }
  else {
    $form = lm_paypal_subscription_edit_form($subid);

    // Note: I've chosen a form_id the same as this function
    return drupal_get_form('lm_paypal_subscription_edit', $form);
  }
}

function lm_paypal_subscription_edit_form($subid = '') {
  _lm_paypal_subscriptions_ini();
  global $_lm_paypal_period_units_option;
  global $_lm_paypal_currency_option;

  // Under Drupal 5 this form has the following base name and all the
  // processing is done by calling #base_validate, ...
  $form['#base'] = 'lm_paypal_subscription_edit';

  $subid = check_plain($subid);

  if ($subid != '' && (!is_numeric($subid) || intval($subid) != $subid)) {
    watchdog(
      LM_PAYPAL_SUBSCRIPTIONS,
      t('lm_paypal_subscription_edit requires empty or integer subid: %subid', array('%subid' => $subid)),
      WATCHDOG_ERROR);
    return '';
  }

  $edit = ($subid != '');

  if ($edit) {
    // Look up the default values
    $sql = "SELECT * FROM {lm_paypal_subscriptions} WHERE subid = %d";
    $subs = db_query($sql, $subid);
  
    if (db_num_rows($subs) <= 0) {
      watchdog(
        LM_PAYPAL_SUBSCRIPTIONS,
        t('Attempt to edit non existant subscription subid: %subid', array('%subid' => $subid)),
        WATCHDOG_ERROR);
      return '';
    }
  
    $so = db_fetch_object($subs);
    if (! $so) {
      watchdog(
        LM_PAYPAL_SUBSCRIPTIONS,
        t('Cannot find the subscription subid: %subid', array('%subid' => $subid)),
        WATCHDOG_ERROR);
      return '';
    }

    $form['edit_subid'] = array(
      '#type' => 'hidden',
      '#value' => $subid,
    );
  }
  else {
    // Initialise a new subscription
    $so->src = 0;
    $so->uid_admin = LM_PAYPAL_SUBSCRIPTIONS_UID_ADMIN_DEFAULT;
    $so->send_admin_onsub = LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONSUB_DEFAULT;
    $so->send_admin_onend = LM_PAYPAL_SUBSCRIPTIONS_SEND_ADMIN_ONEND_DEFAULT;

    $so->send_user_onsub = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONSUB_DEFAULT;
    $so->send_user_onsub_subject = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONSUB_SUBJECT_DEFAULT;
    $so->send_user_onsub_body = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONSUB_BODY_DEFAULT;

    $so->send_user_onnearend = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONNEAREND_DEFAULT;
    $so->nearend_days = LM_PAYPAL_SUBSCRIPTIONS_NEAREND_DAYS_DEFAULT;
    $so->send_user_onnearend_subject = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONNEAREND_SUBJECT_DEFAULT;
    $so->send_user_onnearend_body = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONNEAREND_BODY_DEFAULT;

    $so->send_user_onend = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONEND_DEFAULT;
    $so->send_user_onend_subject = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONEND_SUBJECT_DEFAULT;
    $so->send_user_onend_body = LM_PAYPAL_SUBSCRIPTIONS_SEND_USER_ONEND_BODY_DEFAULT;

    $so->terms = LM_PAYPAL_SUBSCRIPTIONS_TERMS_DEFAULT;
  }

  $form['item_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Subscription Name'),
    '#maxlength' => 127,
    '#default_value' => $so->item_name,
    '#required' => TRUE,
    '#description' => t('The name of the subscription'),
  );

  $form['description'] = array(
    '#type' => 'textfield',
    '#title' => t('Description'),
    '#maxlength' => 127,
    '#default_value' => $so->description,
    '#required' => TRUE,
  );

  $kinds = array(0 => 'Role', 1 => 'Node');
  $descr = t('Kind of subscription. Role subscriptions for users to gain an role. Node subscription to make a private node public.');

  $og = (function_exists('og_subscribe_user'));

  if ($og) {
    $kinds[2] = 'Organic Group';
    $descr .= t(' Organic Group for users to gain a group');
    $og = true;
  }

  $form['kind'] = array(
    '#type' => 'select',
    '#title' => t('Subscription Kind'),
    '#options' => $kinds,
    '#default_value' => $so->kind,
    '#required' => TRUE,
    '#description' => $descr,
  );

  $form['rid'] = array(
    '#type' => 'select',
    '#title' => t('Subscribers Role'),
    '#options' => lm_paypal_subscribable_roles(TRUE),
    '#default_value' => $so->rid,
    //'#required' => TRUE, - not required for node-subs only role-subs
    '#description' => t('The role subscribers become members of. Only used when kind is Role'),
  );

  if ($og) {
    // NOTE: Reusing the so->rid field for the Organic Group id
    $form['gid'] = array(
      '#type' => 'select',
      '#title' => t('Subscribers Organic Group'),
      '#options' => lm_paypal_subscribable_groups(),
      '#default_value' => $so->rid,
      //'#required' => TRUE, - not required for node-subs only role-subs
      '#description' => t('The Organic Group subscribers become members of. Only used when kind is Organic Group. Only "Invite Only" groups can be used in subcsriptions.'),
    );
  }

  $form['a3'] = array(
    '#type' => 'textfield',
    '#title' => t('Regular rate'),
    '#maxlength' => 10,
    '#default_value' => $so->a3,
    '#required' => TRUE,
    '#description' => t('This is the price of the subscription. (The currency is specified below.)'),
  );

  $form['p3'] = array(
    '#type' => 'textfield',
    '#title' => t('Regular billing cycle'),
    '#maxlength' => 10,
    '#default_value' => $so->p3,
    '#required' => TRUE,
    '#description' => t('This is the length of the billing cycle. The number is modified by the regular billing cycle units'),
  );

  $form['t3'] = array(
    '#type' => 'select',
    '#title' => t('Regular billing cycle units'),
    '#options' => $_lm_paypal_period_units_option,
    '#default_value' => $so->t3,
    '#required' => TRUE,
    '#description' => t('This is the units of the regular billing cycle'),
  );

  $form['src'] = array(
    '#type' => 'checkbox',
    '#title' => t('Recurring payments'),
    '#default_value' => $so->src,
    '#description' => t('If set the payment will recur unless your customer cancels the subscription before the end of the billing cycle. If omitted, the subscription payment will not recur at the end of the billing cycle'),
  );

  $form['srt'] = array(
    '#type' => 'textfield',
    '#title' => t('Recurring Times'),
    '#maxlength' => 10,
    '#default_value' => $so->srt,
    '#description' => t('This is the number of payments which will occur at the regular rate. If omitted, payment will continue to recur at the regular rate until the subscription is cancelled. Requires Recurring payments to be set. <b>If set it must be at least 2</b>.'),
  );

  $form['currency_code'] = array(
    '#type' => 'select',
    '#title' => t('The currency of the payment(s)'),
    '#default_value' => $so->currency_code,
    '#options' => $_lm_paypal_currency_option,
    '#description' => t('The currency to use in all payments relating to this subscription.'),
  );

  $form['return_url'] = array(
    '#type' => 'textfield',
    '#title' => t('Return URL'),
    '#maxlength' => 200,
    '#default_value' => $so->return_url,
    '#description' => t('If set this is the URL the user is returned to after completing the transaction at PayPal. If can be used to override the default "thank you" page with a page of your own.'),
  );

  $form['trial_header'] = array(
    '#value' => '<br><h2>' . t('Optional Trial Periods') . '</h2>',
  );

  $form['a1'] = array(
    '#type' => 'textfield',
    '#title' => t('Trial amount 1'),
    '#maxlength' => 10,
    '#default_value' => $so->a1,
    '#description' => t('This is the price of the first trial period. For a free trial set this to 0'),
  );

  $form['p1'] = array(
    '#type' => 'textfield',
    '#title' => t('Trial period 1'),
    '#maxlength' => 10,
    '#default_value' => $so->p1,
    '#description' => t('This is the length of the first trial period. The number is modified by the trial period 1 units'),
  );

  $form['t1'] = array(
    '#type' => 'select',
    '#title' => t('Trial period 1 units'),
    '#options' => $_lm_paypal_period_units_option,
    '#default_value' => $so->t1,
    '#description' => t('This is the units of trial period 1'),
  );

  $form['a2'] = array(
    '#type' => 'textfield',
    '#title' => t('Trial amount 2'),
    '#maxlength' => 10,
    '#default_value' => $so->a2,
    '#description' => t('This is the price of the second trial period. For a free trial set this to 0'),
  );

  $form['p2'] = array(
    '#type' => 'textfield',
    '#title' => t('Trial period 2'),
    '#maxlength' => 10,
    '#default_value' => $so->p2,
    '#description' => t('This is the length of the second trial period. The number is modified by the trial period 2 units'),
  );

  $form['t2'] = array(
    '#type' => 'select',
    '#title' => t('Trial period 2 units'),
    '#options' => $_lm_paypal_period_units_option,
    '#default_value' => $so->t2,
    '#description' => t('This is the units of trial period 2'),
  );

  $form['admin_emails_header'] = array(
    '#value' => '<br><h2>' . t('Email administrator options') . '</h2>',
  );

  $form['uid_admin'] = array(
    '#type' => 'textfield',
    '#title' => t('UID Admin'),
    '#maxlength' => 10,
    '#default_value' => $so->uid_admin,
    '#description' => t('UID of this subscriptions administrator'),
  );

  $form['send_admin_onsub'] = array(
    '#type' => 'checkbox',
    '#title' => t('Email admin on subscription'),
    '#default_value' => $so->send_admin_onsub,
    '#description' => t('Email this subscriptions administrator when someone subscribes'),
  );

  $form['send_admin_onend'] = array(
    '#type' => 'checkbox',
    '#title' => t('Email admin on subscription end'),
    '#default_value' => $so->send_admin_onend,
    '#description' => t('Email this subscriptions administrator when someones subscription ends by either cancel or end-of-term'),
  );

  $form['send_user_header'] = array(
    '#value' => '<br><h2>' . t('Email subscriber options') . '</h2>' . t('The following variables can be used in the subject and body of messages:<ul><li>%Subscription - the subscriptions name</li><li>%Username - the subscribers name</li><li>%Login - the subscribers login</li><li>%Site - this sites name</li><li>%Uri - this uri</li><li>%Uri_brief - this uri stripped of http://</li><li>%Mailto - target of this email</li><li>%Date - the curent date/time</li></ul>'),
  );

  $form['send_user_onsub'] = array(
    '#type' => 'checkbox',
    '#title' => t('Email user on subscription'),
    '#default_value' => $so->send_user_onsub,
    '#description' => t('Email the user when they subscribe'),
  );

  $form['send_user_onsub_subject'] = array(
    '#type' => 'textfield',
    '#title' => t('New subscription email subject'),
    '#maxlength' => 80,
    '#default_value' => $so->send_user_onsub_subject,
    '#description' => t('Subject of email sent to a user on a new subscription'),
  );

  $form['send_user_onsub_body'] = array(
    '#type' => 'textarea',
    '#title' => t('New subscription email body'),
    '#maxlength' 