Index: modules/paypal_subscription/paypal_subscription.module
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/paypal_subscription/paypal_subscription.module,v
retrieving revision 1.6
diff -u -r1.6 paypal_subscription.module
--- modules/paypal_subscription/paypal_subscription.module 25 May 2005 04:50:58 -0000 1.6
+++ modules/paypal_subscription/paypal_subscription.module 9 May 2006 18:28:23 -0000
@@ -61,7 +61,7 @@
case 'admin/settings/paypal_subscription':
return t('This module requires cron and paypal_framework.module.');
- case 'admin/paypal_subscription':
+ case 'admin/paypal/subscription':
return t('Create, edit, and delete PayPal subscriptions that you want to handle automatically.');
}
@@ -79,18 +79,19 @@
if ($may_cache) {
$items[] = array('path' => 'admin/paypal/subscription',
'title' => t('subscriptions'),
- 'callback' => 'paypal_subscription_admin',
+ 'callback' => 'paypal_subscription_admin_page',
'access' => user_access('administer paypal subscriptions'));
- }
- elseif (arg(0) == 'admin' && arg(1) == 'paypal' && arg(2) == 'subscription' && is_numeric(arg(3)) && arg(4)) {
- $items[] = array('path' => 'admin/paypal/subscription/'.arg(3).'/subscribers',
+ $items[] = array('path' => 'admin/paypal/subscription/subscribers',
'title' => t('subscribers'),
- 'callback' => 'paypal_subscription_admin',
- 'type' => MENU_LOCAL_TASK);
- $items[] = array('path' => 'admin/paypal_subscription/'.arg(3).'/edit',
+ 'callback' => 'paypal_subscription_admin_subscribers_page',
+ 'type' => MENU_CALLBACK);
+ $items[] = array('path' => 'admin/paypal/subscription/edit',
'title' => t('edit'),
- 'callback' => 'paypal_subscription_admin',
- 'type' => MENU_LOCAL_TASK);
+ 'callback' => 'paypal_subscription_admin_edit_page',
+ 'type' => MENU_CALLBACK);
+ $items[] = array('path' => 'admin/paypal/subscription/delete',
+ 'callback' => 'paypal_subscription_admin_delete_page',
+ 'type' => MENU_CALLBACK);
}
return $items;
@@ -107,13 +108,21 @@
* Implementation of hook_settings()
*/
function paypal_subscription_settings() {
- $form = form_textfield(t('Hours between updates'),
- 'paypal_subscription_cron_period',
- variable_get('paypal_subscription_cron_period', 12),
- 3, 10,
- t('The primary purpose of updating is to demote users who have not paid recently. So enter here the maximum amount of time that should transpire before a delinquent user is demoted. This should be a multiple of the time between cron updates.'));
- $form .= form_checkbox(t('Enable debugging mode'), 'paypal_subscription_debug_enabled', TRUE, variable_get('paypal_subscription_debug_enabled', FALSE), t('Debugging messages will appear in the log when this box is checked.'));
-
+ $form['paypal_subscription_cron_period'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Hours between updates'),
+ '#default_value' => variable_get('paypal_subscription_cron_period', 12),
+ '#size' => 3,
+ '#maxlength' => 10,
+ '#description' => t('The primary purpose of updating is to demote users who have not paid recently. So enter here the maximum amount of time that should transpire before a delinquent user is demoted. This should be a multiple of the time between cron updates.'),
+ );
+ $form['paypal_subscription_debug_enabled'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Enable debugging mode'),
+ '#return_value' => TRUE,
+ '#default_value' => variable_get('paypal_subscription_debug_enabled', FALSE),
+ '#description' => t('Debugging messages will appear in the log when this box is checked.'),
+ );
return $form;
}
@@ -306,239 +315,384 @@
}
}
-/**
- * Administer paypal subscriptions: add, edit, and delete
- */
-function paypal_subscription_admin() {
- $op = $_POST['op'];
- $edit = $_POST['edit'];
- $id = arg(3);
-
- if (empty($op)) {
- $op = arg(4);
+function paypal_subscription_admin_edit_page($id = '') {
+ if (!is_numeric($id)) {
+ drupal_set_message(t('Invalid id.'), 'error');
+ drupal_goto('admin/paypal/subscription');
+ break;
}
- switch ($op) {
- case t('edit'):
- //
- // Display the form to edit a single subscription.
- //
- if (!is_numeric($id)) {
- drupal_set_message(t('Invalid id.'), 'error');
- drupal_goto('admin/paypal/subscription');
- break;
- }
-
- // Prepare data for the form
- $period = array('1 day'=>t('1 day'), '2 days'=>t('2 days'), '1 week'=>t('1 week'), '2 weeks'=>t('2 weeks'), '1 month'=>t('1 month'), '2 months'=>t('2 months'), '6 months'=>t('6 months'), '1 year'=>t('1 year'));
-
- $email_addresses = array();
- foreach (explode("\n", variable_get('paypal_emails', '')) AS $email) {
- $email_addresses[$email] = $email;
- }
-
- // Pass '1' to exclude 'anonymous user'
- $roles = user_roles(1);
-
- $currencies = array('USD' => t('U.S. Dollars'), 'GBP' => t('Pounds Sterling'), 'EUR' => t('Euros'), 'CAD' => t('Canadian Dollars'), 'JPY' => t('Yen'));
- asort($currencies);
-
- $subscription = db_fetch_object(db_query('SELECT * FROM {paypal_subscription} WHERE subscription_id=%d', $id));
+ $subscription = db_fetch_object(db_query('SELECT * FROM {paypal_subscription} WHERE subscription_id=%d', $id));
+ // Provide default values.
+ $defaults = _paypal_subscription_email_defaults();
+
+ !$subscription->welcome_subject && $subscription->welcome_subject = $defaults->welcome_subject;
+ !$subscription->welcome_body && $subscription->welcome_body = $defaults->welcome_body;
+ !$subscription->warning_subject && $subscription->warning_subject = $defaults->warning_subject;
+ !$subscription->warning_body && $subscription->warning_body = $defaults->warning_body;
+ !$subscription->goodbye_subject && $subscription->goodbye_subject = $defaults->goodbye_subject;
+ !$subscription->goodbye_body && $subscription->goodbye_body = $defaults->goodbye_body;
+
+ $form = _paypal_subscription_build_edit_form($subscription);
- // Generate the form elements
- $output = form_textfield(t('Subscription name'), 'name', $subscription->name, 64, 64);
- $output .= form_textfield(t('PayPal item number'), 'item_number', $subscription->item_number, 64, 64);
- $output .= form_select(t('PayPal recipient\'s email address'), 'receiver_email', $subscription->receiver_email, $email_addresses, t('PayPal uses email addresses to identify their accounts. This list of email addresses comes from %paypal_framework.', array('%paypal_framework' => l('paypal_framework', 'admin/settings/paypal_framework'))));
- $output .= form_select(t('Payment currency'), 'currency', $subscription->currency, $currencies, t('All payments must be made in this currency. Payments in other currencies will not be rejected, but they will not count toward the subscription, either.'));
- $output .= form_textfield(t('Payment amount'), 'payment', $subscription->payment, 16, 16, t('The minimum amount that must be paid in each time period.'));
- $output .= form_select(t('Period'), 'period', $subscription->period, $period, t('This defines the length of time during which a user must pay.'));
- $output .= form_select(t('Role to grant'), 'role', $subscription->role, $roles, t('When a user is paid up, they will be granted this role. When they are delinquent, they will lose this role.'));
-
- // Provide default values.
- $defaults = _paypal_subscription_email_defaults();
- !$subscription->welcome_subject && $subscription->welcome_subject = $defaults->welcome_subject;
- !$subscription->welcome_body && $subscription->welcome_body = $defaults->welcome_body;
- !$subscription->warning_subject && $subscription->warning_subject = $defaults->warning_subject;
- !$subscription->warning_body && $subscription->warning_body = $defaults->warning_body;
- !$subscription->goodbye_subject && $subscription->goodbye_subject = $defaults->goodbye_subject;
- !$subscription->goodbye_body && $subscription->goodbye_body = $defaults->goodbye_body;
-
- $group = form_checkbox(t('Send welcome emails.'), 'send_welcome', 1, TRUE, t('Check this box to send new subscribers a welcoming email.'));
- $group .= form_checkbox(t('Send warning emails.'), 'send_warning', 1, TRUE, t('Check this box to send subscribers an email when their subscription is less than 6 hours from ending.'));
- $group .= form_checkbox(t('Send goodbye emails.'), 'send_goodbye', 1, TRUE, t('Check this box to send subscribers an email after their subscription ends.'));
- $output .= form_group(t('Email settings'), $group, t('You may edit the email messages below.'));
-
- $group = form_textfield(t('Subject of welcoming email'), 'welcome_subject', $subscription->welcome_subject, 64, 64);
- $group .= form_textarea(t('Body of welcoming email'), 'welcome_body', $subscription->welcome_body, 70, 10);
- $group .= form_textfield(t('Subject of warning email'), 'warning_subject', $subscription->warning_subject, 64, 64);
- $group .= form_textarea(t('Body of warning email'), 'warning_body', $subscription->warning_body, 70, 10);
- $group .= form_textfield(t('Subject of goodbye email'), 'goodbye_subject', $subscription->goodbye_subject, 64, 64);
- $group .= form_textarea(t('Body of goodbye email'), 'goodbye_body', $subscription->goodbye_body, 70, 10);
- $output .= form_group(t('Email messages'), $group, t('You may include the following variables in any field: %username, %site_name, %site_url, %login_url, %subscription_name, %subscription_price, %subscription_period, %item_number, %role, %payment_currency, %recipient_email, %subscription_end_date.
Note: The %subscription_end_date is predicted using the assumption that the last payment from this user was greater than or equal to the %subscription_price. If that is not the case, the subscription will still end at the correct time. But because the prediction is wrong, the user may not receive a warning email and the predicted %subscription_end_date will be too far in the future. This situation can be provoked if a user pays for a subscription in installments or if the site administrator raises the price while there are active subscriptions.'));
-
- $output .= form_submit(t('Save subscription'));
- $output .= form_submit(t('Delete subscription'));
- $output .= form_hidden('subscription_id', $subscription->subscription_id);
-
- $output = form($output);
-
- print theme('page', $output);
- break;
-
- case t('Add subscription'):
- $edit['subscription_id'] = db_next_id('{paypal_subscription}_subscription_id');
-
- db_query('INSERT INTO {paypal_subscription} (subscription_id, name)
- VALUES (%d, "%s")',
- $edit['subscription_id'], $edit['name']);
-
- drupal_set_message(t('PayPal subscription %a was added.', array('%a'=>$edit['name'])));
- drupal_goto('admin/paypal/subscription/'.$edit['subscription_id'].'/edit');
- break;
-
- case t('Delete subscription'):
- $output = '
'.t('Are you sure you want to remove the PayPal subscription %subscription? This will not erase recorded transactions.', array('%subscription' => $edit['name'])).'
';
- $output .= form_submit(t('Confirm delete'));
- $output .= form_hidden('subscription_id', $edit['subscription_id']);
-
- drupal_set_title(t('Delete PayPal subscription'));
- print theme('page', form($output));
- break;
- case t('Confirm delete'):
- db_query('DELETE FROM {paypal_subscription} WHERE subscription_id=%d', $id);
-
- drupal_set_message(t('The PayPal subscription was removed.'));
- drupal_goto('admin/paypal/subscription');
- break;
-
- case t('Save subscription'):
- db_query('UPDATE {paypal_subscription} SET name="%s", item_number="%s",
- receiver_email="%s", currency="%s",
- payment="%s", period="%s",
- role=%d, send_welcome=%d,
- send_warning=%d, send_goodbye=%d,
- welcome_subject="%s", welcome_body="%s",
- warning_subject="%s", warning_body="%s",
- goodbye_subject="%s", goodbye_body="%s"
- WHERE subscription_id=%d',
- $edit['name'], $edit['item_number'], $edit['receiver_email'], $edit['currency'],
- $edit['payment'], $edit['period'], $edit['role'], $edit['send_welcome'],
- $edit['send_warning'], $edit['send_goodbye'], $edit['welcome_subject'],
- $edit['welcome_body'], $edit['warning_subject'], $edit['warning_body'],
- $edit['goodbye_subject'], $edit['goodbye_body'], $edit['subscription_id']);
-
- drupal_set_message(t('Your changes were saved.'));
- drupal_goto('admin/paypal/subscription');
- break;
-
- case t('subscribers'):
- //
- // Print a list of people who have paid anything for the current time period. Those who have paid too much
- // and those who have paid too little will be flagged.
- //
- $subscription = _paypal_subscription_load($id);
- $title = t('PayPal subscriptions: %subscription_name', array('%subscription_name' => $subscription->name));
+ $output = drupal_get_form('paypal_subscriptions_edit', $form);
- $timeperiod = _paypal_subscription_time_period($id);
+ return $output;
+}
- //
- // Make the table sortable.
- //
- $header = array(array('data' => t('Username'), 'field' => 'u.name', 'sort' => 'asc'),
- array('data' => t('Real name'), 'field' => 'realname'),
- array('data' => t('Email address'), 'field' => 'ppl.payer_email'),
- array('data' => t('Total payment'), 'field' => 'payment'),
- array('data' => t('Last transaction'), 'field' => 'last_payment_date')
- );
- $result = pager_query('SELECT u.uid, u.name as username, ppl.payer_email AS email_address,
- concat(ppp.first_name, " ", ppp.last_name) as realname, ppp.payer_id,
- SUM(ppl.mc_gross) AS payment, UNIX_TIMESTAMP(MAX(ppl.transaction_date)) AS last_payment_date
- FROM {paypal_log} ppl
- LEFT JOIN {users} u ON ppl.payer_email=u.mail
- LEFT JOIN {paypal_payer} ppp ON ppl.payer_id=ppp.payer_id
- WHERE ppl.mc_currency="%s"
- AND UNIX_TIMESTAMP(ppl.transaction_date) >= %d
- AND UNIX_TIMESTAMP(ppl.transaction_date) < %d
- AND ppl.item_number="%s"
- GROUP BY ppl.payer_email
- %s',
- 25, 0,
- 'SELECT COUNT(DISTINCT(ppl.payer_id))
- FROM {paypal_log} ppl
- WHERE ppl.mc_currency="%s"
- AND UNIX_TIMESTAMP(ppl.transaction_date) >= %d
- AND UNIX_TIMESTAMP(ppl.transaction_date) < %d
- AND ppl.item_number="%s"',
- $subscription->currency, $timeperiod->start, $timeperiod->stop, $subscription->item_number,
- tablesort_sql($header));
+function paypal_subscription_admin_subscribers_page($id = '') {
+ if (!is_numeric($id)) {
+ drupal_set_message(t('Invalid id.'), 'error');
+ drupal_goto('admin/paypal/subscription');
+ break;
+ }
- //
- // Create the page title.
- //
- // The subscription period is stored as an English string. There is a finite list of possibilities:
- // see $period near line 89 above.
- //
- $output = '
';
+ //
+ // Print a list of people who have paid anything for the current time period. Those who have paid too much
+ // and those who have paid too little will be flagged.
+ //
+ $subscription = _paypal_subscription_load($id);
+ $title = t('PayPal subscriptions: %subscription_name', array('%subscription_name' => $subscription->name));
+
+ $timeperiod = _paypal_subscription_time_period($id);
+
+ //
+ // Make the table sortable.
+ //
+ $header = array(array('data' => t('Username'), 'field' => 'u.name', 'sort' => 'asc'),
+ array('data' => t('Real name'), 'field' => 'realname'),
+ array('data' => t('Email address'), 'field' => 'ppl.payer_email'),
+ array('data' => t('Total payment'), 'field' => 'payment'),
+ array('data' => t('Last transaction'), 'field' => 'last_payment_date')
+ );
+ $result = pager_query('SELECT u.uid, u.name as username, ppl.payer_email AS email_address,
+ concat(ppp.first_name, " ", ppp.last_name) as realname, ppp.payer_id,
+ SUM(ppl.mc_gross) AS payment, UNIX_TIMESTAMP(MAX(ppl.transaction_date)) AS last_payment_date
+ FROM {paypal_log} ppl
+ LEFT JOIN {users} u ON ppl.payer_email=u.mail
+ LEFT JOIN {paypal_payer} ppp ON ppl.payer_id=ppp.payer_id
+ WHERE ppl.mc_currency="%s"
+ AND UNIX_TIMESTAMP(ppl.transaction_date) >= %d
+ AND UNIX_TIMESTAMP(ppl.transaction_date) < %d
+ AND ppl.item_number="%s"
+ GROUP BY ppl.payer_email
+ %s',
+ 25, 0,
+ 'SELECT COUNT(DISTINCT(ppl.payer_id))
+ FROM {paypal_log} ppl
+ WHERE ppl.mc_currency="%s"
+ AND UNIX_TIMESTAMP(ppl.transaction_date) >= %d
+ AND UNIX_TIMESTAMP(ppl.transaction_date) < %d
+ AND ppl.item_number="%s"',
+ $subscription->currency, $timeperiod->start, $timeperiod->stop, $subscription->item_number,
+ tablesort_sql($header));
+
+ //
+ // Create the page title.
+ //
+ // The subscription period is stored as an English string. There is a finite list of possibilities:
+ // see $period near line 89 above.
+ //
+ $output = '