modules/uc_promo/uc_promo.module

<?php

// $Id$

/**
 * @file
 * Create promotions with redeemable promotional codes that users can redeem to
 *   perform special actions in your store.
 */


/**
 * Implementation of hook_menu().
 */
function uc_promo_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array(
      'path' => 'promo',
      'title' => t('Redeem a promotion'),
      'description' => t('Form to redeem a promotional code.'),
      'callback' => 'uc_promo_redeem',
      'callback arguments' => array(''),
      'access' => TRUE,
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'admin/store/settings/promo',
      'title' => t('Promotions'),
      'description' => t('Setup and administer your promotions.'),
      'callback' => 'uc_promo_admin',
      'access' => user_access('administer uc promotions'),
      'type' => MENU_NORMAL_ITEM,
    );
    $items[] = array(
      'path' => 'admin/store/settings/promo/overview',
      'title' => t('Overview'),
      'description' => t('Setup and administer your promotions.'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10,
    );
    $items[] = array(
      'path' => 'admin/store/settings/promo/add',
      'title' => t('Add a promotion'),
      'description' => t('Setup and administer your promotions.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('uc_promo_promotion_form', 0),
      'access' => user_access('administer uc promotions'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 0,
    );
    $items[] = array(
      'path' => 'admin/store/settings/promo/settings',
      'title' => t('Settings'),
      'description' => t('Adjust the general promotions settings.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('uc_promo_admin_form'),
      'access' => user_access('administer uc promotions'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 10,
    );
  }
  else {
    if (arg(3) === 'promo' && intval(arg(4)) > 0) {
      $items[] = array(
        'path' => 'admin/store/settings/promo/'. arg(4) .'/edit',
        'title' => t('Edit promotion'),
        'description' => t('Delete an existing promotion.'),
        'callback' => 'drupal_get_form',
        'callback arguments' => array('uc_promo_promotion_form', arg(4)),
        'access' => user_access('administer uc promotions'),
        'type' => MENU_CALLBACK,
      );
      $items[] = array(
        'path' => 'admin/store/settings/promo/'. arg(4) .'/delete',
        'title' => t('Delete promotion'),
        'description' => t('Delete a promotion.'),
        'callback' => 'drupal_get_form',
        'callback arguments' => array('uc_promo_delete_promotion_form', arg(4)),
        'access' => user_access('administer uc promotions'),
        'type' => MENU_CALLBACK,
      );

      if (arg(5) === 'codes') {
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes',
          'title' => t('Promotional codes'),
          'description' => t('Administer promotional codes for a given promotion.'),
          'callback' => 'uc_promo_codes',
          'callback arguments' => array(arg(4)),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_CALLBACK,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/overview',
          'title' => t('Overview'),
          'description' => t('Administer promotional codes for a given promotion.'),
          'type' => MENU_DEFAULT_LOCAL_TASK,
          'weight' => -10,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/add',
          'title' => t('Add code'),
          'description' => t('Add a promotional code for the promotion.'),
          'callback' => 'drupal_get_form',
          'callback arguments' => array('uc_promo_codes_form', arg(4), 0),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_LOCAL_TASK,
          'weight' => 0,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/'. arg(6) .'/download',
          'title' => t('Download bulk generated codes'),
          'callback' => 'uc_promo_code_bulkgen',
          'callback arguments' => array(arg(4), arg(6)),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_CALLBACK,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/'. arg(6) .'/edit',
          'title' => t('Edit code'),
          'description' => t('Edit a promotional code.'),
          'callback' => 'drupal_get_form',
          'callback arguments' => array('uc_promo_codes_form', arg(4), arg(6)),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_CALLBACK,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/'. arg(6) .'/delete',
          'title' => t('Delete code'),
          'description' => t('Delete a promotional code.'),
          'callback' => 'drupal_get_form',
          'callback arguments' => array('uc_promo_delete_code_form', arg(4), arg(6)),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_CALLBACK,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/'. arg(6) .'/redemptions',
          'title' => t('Promotional code redemptions'),
          'description' => t('A table of redemptions for a promotional code.'),
          'callback' => 'uc_promo_redemptions',
          'callback arguments' => array(arg(4), arg(6)),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_CALLBACK,
        );
        $items[] = array(
          'path' => 'admin/store/settings/promo/'. arg(4) .'/codes/back',
          'title' => t('Back to promotions'),
          'callback' => 'drupal_goto',
          'callback arguments' => array('admin/store/settings/promo'),
          'access' => user_access('administer uc promotions'),
          'type' => MENU_LOCAL_TASK,
          'weight' => 10,
        );
      }
    }
  }

  return $items;
}

/**
 * Implementation of hook_perm().
 */
function uc_promo_perm() {
  return array('administer uc promotions', 'redeem uc promotions');
}

/**
 * Implementation of Workflow-ng hook_event_info().
 */
function uc_promo_event_info() {
  $events = array();

  $result = db_query("SELECT promo_id, promo_name FROM {uc_promos}");
  while ($promo = db_fetch_object($result)) {
    $events['uc_promo_'. $promo->promo_id] = array(
      '#label' => t('@name', array('@name' => $promo->promo_name)),
      '#module' => 'Promotions',
      '#arguments' => array(
        'user' => array('#entity' => 'user', '#label' => t('User')),
      ),
    );
  }

  return $events;
}

/**
 * Implementation of Workflow-ng hook_action_info().
 */
function uc_promo_action_info() {
  $actions = array();

  // Provide integration for File Downloads module.
  if (module_exists('uc_file')) {
    // Add a file download to a user's account.
    $actions['uc_promo_user_add_download'] = array(
      '#label' => t('Give a user a file download.'),
      '#arguments' => array(
        'user' => array('#entity' => 'user', '#label' => t('User account')),
      ),
      '#module' => t('Promotions'),
    );
  }

  return $actions;
}

// Displays a form for redeeming promotions.
function uc_promo_redeem() {
  // Check for redemption access.
  if (!user_access('redeem uc promotions')) {
    if (variable_get('uc_promo_login_redirect', TRUE)) {
      // Redirect if specified in the promotions settings.
      drupal_set_message(t('You must login or create an account before you can redeem your promotional code.'));
      drupal_goto('user/login', 'destination=promo');
    }
    else {
      drupal_access_denied();
    }
  }

  return drupal_get_form('uc_promo_redeem_form', $code);
}

// Form builder function for a promotional code redemption form.
function uc_promo_redeem_form() {
  $form = array();

  $form['promo_code'] = array(
    '#type' => 'textfield',
    '#title' => t('Promotional code'),
    '#description' => t('Enter the code for the promotion you would like to redeem.'),
    '#required' => TRUE,
  );

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

  return $form;
}

function uc_promo_redeem_form_validate($form_id, $form_values) {
  global $user;

  // Check to make sure the code is valid.
  if (!uc_promo_validate_code($form_values['promo_code'], $user)) {
    form_set_error('promo_code', t('You have entered an invalid promotional code.  Make sure you have entered code correctly and try again.'));
  }
}

function uc_promo_redeem_form_submit($form_id, $form_values) {
  global $user;

  // Load the promo code data.
  $code_data = uc_promo_load_code($form_values['promo_code']);

  // Check if this is a bulk generated code; if so, we redeem it differently.
  if ($code_data['promo_code'] !== $form_values['promo_code']) {
    $bulk_code = $form_values['promo_code'];
  }
  else {
    $bulk_code = NULL;
  }

  // Make the appropriate database updates for the redemption.
  uc_promo_redeem_code($code_data['promo_code'], $user, $bulk_code);

  $promo_data = uc_promo_load_promotion($code_data['promo_id']);

  // Trigger any configurations assigned to this promotion's trigger.
  workflow_ng_invoke_event('uc_promo_'. $code_data['promo_id'], $user);

  // Send the user to the promotion's landing page.
  $path = token_replace($promo_data['landing_page'], 'global');

  return $path;
}

// Displays an admin table for existing promotions and a settings form.
function uc_promo_admin() {
  $header = array(
    array('data' => t('ID'), 'field' => 'promo_id'),
    array('data' => t('Created'), 'field' => 'created', 'sort' => 'desc'),
    array('data' => t('Name'), 'field' => 'promo_name'),
    array('data' => t('Status'), 'field' => 'promo_status'),
    t('Operations'),
  );

  $rows = array();

  // Get all the promotions from the database.
  $result = pager_query("SELECT * FROM {uc_promos}". tablesort_sql($header), 30);
  while ($data = db_fetch_array($result)) {
    $ops = array(
      l(t('codes'), 'admin/store/settings/promo/'. $data['promo_id'] .'/codes'),
      l(t('edit'), 'admin/store/settings/promo/'. $data['promo_id'] .'/edit'),
      l(t('delete'), 'admin/store/settings/promo/'. $data['promo_id'] .'/delete'),
    );

    $row = array(
      check_plain($data['promo_id']),
      array('data' => format_date($data['created'], 'short'), 'style' => 'white-space: nowrap'),
      check_plain($data['promo_name']),
      $data['promo_status'] ? t('Active') : t('Disabled'),
      array('data' => implode(' ', $ops), 'style' => 'white-space: nowrap;'),
    );

    $rows[] = $row;
  }

  if (count($rows) == 0) {
    $rows[] = array(
      array('data' => t('No promotions created yet.'), 'colspan' => 4),
    );
  }

  return theme('table', $header, $rows) . theme('pager') . l(t('Add a promotion.'), 'admin/store/settings/promo/add');
}

// Form builder for the promo admin settings form.
function uc_promo_admin_form() {
  $form = array();

  $form['uc_promo_login_redirect'] = array(
    '#type' => 'checkbox',
    '#title' => t('Redirect users without access to redeem promotions to the login page.'),
    '#description' => t('Check this setting if authenticated users has access but anonymous users do not.'),
    '#default_value' => variable_get('uc_promo_login_redirect', TRUE),
  );
  $form['uc_promo_delete_behavior'] = array(
    '#type' => 'radios',
    '#title' => t('Promotion delete behavior'),
    '#options' => array(
      0 => t('Delete the promotion and any related promotional codes.'),
      1 => t('Delete the promotion and any related unredeemed promotional codes.'),
      2 => t('Delete the promotion.'),
    ),
    '#default_value' => variable_get('uc_promo_delete_behavior', 0),
  );

  return system_settings_form($form);
}

// Form builder for adding or editing a promotion.
function uc_promo_promotion_form($promo_id) {
  $form = array();

  // Load the specified promotion; will be FALSE if $promo_id == 0.
  $data = uc_promo_load_promotion($promo_id);

  $form['promo_id'] = array(
    '#type' => 'value',
    '#value' => $data === FALSE ? 0 : $promo_id,
  );

  $form['promo_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
    '#description' => t('Displayed on the admin overview and to the user when they redeem a code for this promotion.'),
    '#max_length' => 255,
    '#default_value' => $data['promo_name'],
    '#required' => TRUE,
  );

  $form['landing_page'] = array(
    '#type' => 'textfield',
    '#title' => t('Landing page'),
    '#description' => t('Specify the path to which users who redeem this promotion should be redirected.<br /><a href="!url">Uses global tokens.</a>', array('!url' => url('admin/store/help/tokens'))),
    '#default_value' => $data['landing_page'],
    '#size' => 32,
    '#field_prefix' => url(NULL, NULL, NULL, TRUE) . (variable_get('clean_url', 0) ? '' : '?q='),
  );

  $form['redeem_once'] = array(
    '#type' => 'checkbox',
    '#title' => t('Users can only redeem this promotion once with any code.'),
    '#description' => t('Use this to prevent users from taking advantage of unlimited use promotion codes.'),
    '#default_value' => $data['redeem_once'],
  );

  $form['promo_status'] = array(
    '#type' => 'radios',
    '#title' => t('Status'),
    '#options' => array(
      0 => t('Disabled'),
      1 => t('Active'),
    ),
    '#default_value' => $data === FALSE ? 1 : $data['promo_status'],
    '#required' => TRUE,
  );

  $form['save'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
    '#suffix' => l(t('Cancel'), 'admin/store/settings/promo'),
  );

  return $form;
}

function uc_promo_promotion_form_submit($form_id, $form_values) {
  uc_promo_save_promotion($form_values);

  drupal_set_message(t('Promotion saved.'));

  return 'admin/store/settings/promo';
}

// Form buider for deleting a promotion.
function uc_promo_delete_promotion_form($promo_id) {
  $data = uc_promo_load_promotion($promo_id);
  $form = array();

  // Fail if the promotion doesn't exist.
  if (!$data) {
    drupal_set_message(t("The specified promotion doesn't exist."), 'error');
    drupal_goto('admin/store/settings/promo');
  }

  $form['promo_id'] = array(
    '#type' => 'value',
    '#value' => $promo_id,
  );

  return confirm_form($form, t('Delete promotion'), 'admin/store/settings/promo', t('Are you sure you want to delete %name?', array('%name' => $data['promo_name'])), t('Delete'));
}

function uc_promo_delete_promotion_form_submit($form_id, $form_values) {
  uc_promo_delete_promotion($form_values['promo_id']);

  drupal_set_message(t('The promotion has been deleted.'));

  return 'admin/store/settings/promo';
}

/**
 * Loads a promotion from the database.
 *
 * @param $promo_id
 *   The ID of the promotion to load.
 * @return
 *   An array of data for the promotion.
 */
function uc_promo_load_promotion($promo_id) {
  $result = db_query("SELECT * FROM {uc_promos} WHERE promo_id = %d", $promo_id);

  return db_fetch_array($result);
}

/**
 * Saves or inserts a new promotion.
 *
 * @param $data
 *   An array of data representing the promotion.
 */
function uc_promo_save_promotion($data) {
  // First try to update an existing promotion.
  if ($data['promo_id'] > 0) {
    db_query("UPDATE {uc_promos} SET promo_name = '%s', landing_page = '%s', redeem_once = %d, promo_status = %d WHERE promo_id = %d",
      $data['promo_name'], $data['landing_page'], $data['redeem_once'],
      $data['promo_status'], $data['promo_id']);
  }

  // Otherwise insert a new promotion.
  if ($data['promo_id'] === 0 || db_affected_rows() == 0) {
    db_query("INSERT INTO {uc_promos} (promo_id, promo_name, landing_page, redeem_once, promo_status, created) VALUES (%d, '%s', '%s', %d, %d, %d)",
      $data['promo_id'] == 0 ? db_next_id('{uc_promos}_promo_id') : $data['promo_id'],
      $data['promo_name'], $data['landing_page'], $data['redeem_once'],
      $data['promo_status'], time());
  }
}

/**
 * Delete a promotion from the database.
 *
 * @param $promo_id
 *   The ID of the promotion to delete.
 */
function uc_promo_delete_promotion($promo_id) {
  // Delete related codes per the user settings.
  switch (variable_get('uc_promo_delete_behavior', 0)) {
    case 0:
      // Delete any related promotional codes.
      db_query("DELETE FROM {uc_promo_code_redemptions} WHERE promo_id = %d", $promo_id);
      db_query("DELETE FROM {uc_promo_codes} WHERE promo_id = %d", $promo_id);
      break;

    case 1:
      // Delete related promotional codes that haven't been redeemed.
      db_query("DELETE FROM {uc_promo_codes} WHERE promo_id = %d AND redemptions > 0", $promo_id);
      break;
  }

  // Get the name for use in the log entry.
  $name = db_result(db_query("SELECT promo_name FROM {uc_promos} WHERE promo_id = %d", $promo_id));

  // Delete the promotion itself.
  db_query("DELETE FROM {uc_promos} WHERE promo_id = %d", $promo_id);

  watchdog('uc_promo', t('Promotion %name deleted.', array('%name' => !empty($name) ? $name : $promo_id)));
}

function uc_promo_codes($promo_id) {
  // Load the specified promo code; will be FALSE if $code == 0.
  $data = uc_promo_load_promotion($promo_id);

  if ($data === FALSE) {
    drupal_set_message(t('Specified promotion does not exist.'), 'error');
    drupal_goto('admin/store/settings/promo');
  }

  $output = t('Promotion: %name', array('%name' => check_plain($data['promo_name'])));

  $header = array(
    array('data' => t('Code'), 'field' => 'promo_code'),
    array('data' => t('Type'), 'field' => 'promo_code_type'),
    array('data' => t('Redemptions'), 'field' => 'redemptions'),
    array('data' => t('Last redemption'), 'field' => 'last_redemption', 'sort' => 'desc'),
    t('Operations'),
  );

  $rows = array();

  // Get all the promotions from the database.
  $result = pager_query("SELECT * FROM {uc_promo_codes} WHERE promo_id = %d". tablesort_sql($header), 30, 0, NULL, $promo_id);
  while ($data = db_fetch_array($result)) {
    // Create a download link for bulk generated codes.
    if (!empty($data['bulkgen_seed'])) {
      $download = '<br />'. l(t('Download codes.'), 'admin/store/settings/promo/'. $data['promo_id'] .'/codes/'. $data['promo_code'] .'/download');
    }
    else {
      $download = '';
    }

    // Create an array of operations for the code.
    $ops = array(
      l(t('redemptions'), 'admin/store/settings/promo/'. $data['promo_id'] .'/codes/'. $data['promo_code'] .'/redemptions'),
      l(t('edit'), 'admin/store/settings/promo/'. $data['promo_id'] .'/codes/'. $data['promo_code'] .'/edit'),
      l(t('delete'), 'admin/store/settings/promo/'. $data['promo_id'] .'/codes/'. $data['promo_code'] .'/delete'),
    );

    switch ($data['promo_code_type']) {
      case 1:
        $type = t('Unlimited');
        break;
      case 2:
        $type = t('Limited: @number', array('@number' => $data['max_redemptions']));
        break;
      case 3:
        $type = t('Expires @date', array('@date' => format_date($data['expiration'], 'short')));
        break;
    }

    $row = array(
      'data' => array(
        check_plain($data['promo_code']) . $download,
        array('data' => $type, 'style' => 'white-space: nowrap;'),
        $data['redemptions'],
        array('data' => $data['last_redemption'] > 0 ? format_date($data['last_redemption'], 'short') : '-', 'style' => 'white-space: nowrap;'),
        array('data' => implode(' ', $ops), 'style' => 'white-space: nowrap;'),
      ),
      'valign' => 'top',
    );

    $rows[] = $row;
  }

  if (count($rows) == 0) {
    $rows[] = array(
      array('data' => t('No promotional codes created yet.'), 'colspan' => 5),
    );
  }

  $output .= theme('table', $header, $rows) . theme('pager') . l(t('Add promotional codes.'), 'admin/store/settings/promo/'. $promo_id .'/codes/add');

  return $output;
}

function uc_promo_codes_form($promo_id, $code) {
  $form = array();

  // Load the specified promotion; will be FALSE if $code == 0.
  $data = uc_promo_load_promotion($promo_id);

  if ($data === FALSE) {
    drupal_set_message(t('Specified promotion does not exist.'), 'error');
    drupal_goto('admin/store/settings/promo');
  }

  $form['promo_name'] = array(
    '#value' => t('Promotion: %name', array('%name' => check_plain($data['promo_name']))),
  );

  $form['promo_id'] = array(
    '#type' => 'value',
    '#value' => $promo_id,
  );

  // Load the specified promo code; will be FALSE if $code == 0.
  $data = uc_promo_load_code($code);

  $code_disabled = FALSE;

  if ($data !== FALSE) {
    $form['promo_code_orig'] = array(
      '#type' => 'value',
      '#value' => $code,
    );

    // Disable editing the code if we're dealing with a bulkgen code.
    if (!empty($data['bulkgen_seed'])) {
      $code_disabled = TRUE;
    }
    else {
      // Otherwise disable it if it's already been redeemed.
      $count = db_result(db_query("SELECT COUNT(*) FROM {uc_promo_code_redemptions} WHERE promo_code = '%s'", $code));
      if ($count > 0) {
        $code_disabled = TRUE;
      }
    }
  }


  $form['promo_code'] = array(
    '#type' => 'textfield',
    '#title' => t('Promotional code'),
    '#description' => t('Promotional codes may only contain letters, numbers, underscores, and dashes.<br />Codes may not be changed once they have been redeemed.<br/>Do NOT manually set a code to start with "BULKGEN".'),
    '#default_value' => $data === FALSE ? '' : $data['promo_code'],
    '#required' => $data === FALSE ? FALSE : TRUE,
    '#disabled' => $code_disabled,
  );

  if ($code === 0) {
    $form['bulk'] = array(
      '#type' => 'fieldset',
      '#title' => t('Bulk code generation'),
      '#description' => t('You may choose to bulk generate alphanumeric promotional codes based on the settings below.<br />If so, the promotional code entered above will be ignored.'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['bulk']['bulk_generate'] = array(
      '#type' => 'checkbox',
      '#title' => t('Bulk generate codes for this promotion.'),
    );
    /*$form['bulk']['code_rule'] = array(
      '#type' => 'radios',
      '#title' => t('Code generation rule'),
      '#options' => array(
        'numeric' => t('Random numeric promotional codes.'),
        'alpha_numeric' => t('Random alpha-numeric promotional codes.'),
      ),
    );*/
    $form['bulk']['number_codes'] = array(
      '#type' => 'textfield',
      '#title' => t('Number of codes'),
      '#description' => t('Enter in the number of codes you want to generate.'),
    );
    $form['bulk']['code_length'] = array(
      '#type' => 'select',
      '#title' => t('Code length'),
      '#options' => drupal_map_assoc(range(10, 30)),
    );
  }

  $form['promo_code_type'] = array(
    '#type' => 'radios',
    '#title' => t('Promotional code type'),
    '#description' => t('Limited or expirable promotional codes should specify their settings below.'),
    '#options' => array(
      1 => t('Unlimited number of redemptions'),
      2 => t('Limited number of redemptions'),
      3 => t('Expires on a certain date'),
    ),
    '#default_value' => $data['promo_code_type'],
    '#required' => TRUE,
  );

  $form['max_redemptions'] = array(
    '#type' => 'textfield',
    '#title' => t('Maximum number of redemptions'),
    '#description' => t('Only applicable to limited promotional codes.'),
    '#default_value' => $data['max_redemptions'],
  );

  $form['expiration'] = array(
    '#type' => 'date',
    '#title' => t('Expiration date'),
    '#description' => t('The code will fail after 23:59 of the specified date.<br />Only applicable to expirable promotional codes.'),
    '#default_value' => array(
      'year' => date('Y', $data === FALSE ? time() : $data['expiration']),
      'month' => date('n', $data === FALSE ? time() : $data['expiration']),
      'day' => date('j', $data === FALSE ? time() : $data['expiration']),
    ),
  );

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

  $form['save_add'] = array(
    '#type' => 'submit',
    '#value' => t('Save and add another'),
    '#suffix' => l(t('Cancel'), 'admin/store/settings/promo/'. $promo_id .'/codes'),
  );

  return $form;
}

function uc_promo_codes_form_validate($form_id, $form_values) {
  // Fail if no promo code was entered and bulk generation was not selected.
  if (!$form_values['bulk_generate'] && empty($form_values['promo_code'])) {
    form_set_error('promo_code', t('You must specify a promotional code.'));
  }

  // Fail if the user entered an invalid bulk generated code length.
  if ($form_values['bulk_generate'] && (intval($form_values['code_length']) < 10 || intval($form_values['code_length']) > 30)) {
    form_set_error('code_length', t('You must specify a code length between 10 and 30.'));
  }

  // Fail if the user entered an invalid number of bulk generated codes.
  if ($form_values['bulk_generate'] && intval($form_values['number_codes']) <= 0) {
    form_set_error('number_codes', t('You must specify a number of codes greater than 0.'));
  }

  // Fail if the promotional code has invalid characters.
  if (!empty($form_values['promo_code']) && !preg_match('!^[a-zA-Z0-9_-]+$!', $form_values['promo_code'])) {
    form_set_error('promo_code', t('The promotional code can only consist of letters, numbers, underscores, and dashes.'));
  }

  // Fail if the promotional code entered is non-unique.
  if (!isset($form_values['promo_code_orig']) || $form_values['promo_code_orig'] != $form_values['promo_code']) {
    $exists = db_result(db_query("SELECT COUNT(*) FROM {uc_promo_codes} WHERE UPPER(promo_code) = '%s'", strtoupper($form_values['promo_code'])));
    if ($exists > 0) {
      form_set_error('promo_code', t('That promotional code has already been used.'));
    }
  }

  // Fail if the user entered an invalid value for redemptions.
  if ($form_values['promo_code_type'] == 2 && intval($form_values['max_redemptions']) <= 0) {
    form_set_error('max_redemptions', t('You must specify a number of redemptions greater than 0.'));
  }
}

function uc_promo_codes_form_submit($form_id, $form_values) {
  // Convert the expiration date to a timestamp.
  $form_values['expiration'] = gmmktime(23, 59, 59, $form_values['expiration']['month'], $form_values['expiration']['day'], $form_values['expiration']['year']);

  // Special handling for bulk generated codes.
  if ($form_values['bulk_generate']) {
    $bulkgen_id = variable_get('uc_promo_bulkgen_id', 1);
    variable_set('uc_promo_bulkgen_id', $bulkgen_id + 1);

    // Manually set the promo code name.
    $form_values['promo_code'] = 'BULKGEN'. $bulkgen_id .'-'. $form_values['code_length'] .'-'. $form_values['number_codes'];

    // Setup the bulk generator seed.
    $form_values['bulkgen_seed'] = sha1(mktime() . rand());
  }

  uc_promo_save_code($form_values);

  drupal_set_message(t('Promotional code saved.'));

  if ($form_values['op'] == t('Save')) {
    return 'admin/store/settings/promo/'. $form_values['promo_id'] .'/codes';
  }
}

// Form buider for deleting a promotional code.
function uc_promo_delete_code_form($promo_id, $code) {
  $data = uc_promo_load_code($code);
  $form = array();

  // Fail if the promotional code doesn't exist.
  if (!$data) {
    drupal_set_message(t("The specified promotional code doesn't exist."), 'error');
    drupal_goto('admin/store/settings/promo/'. $promo_id .'/codes');
  }

  $form['promo_id'] = array(
    '#type' => 'value',
    '#value' => $promo_id,
  );

  $form['promo_code'] = array(
    '#type' => 'value',
    '#value' => $code,
  );

  return confirm_form($form, t('Delete promotional code'), 'admin/store/settings/promo/'. $promo_id .'/codes', t('Are you sure you want to delete %code?', array('%code' => $data['promo_code'])), t('Delete'));
}

function uc_promo_delete_code_form_submit($form_id, $form_values) {
  uc_promo_delete_code($form_values['promo_code']);

  drupal_set_message(t('The promotional code has been deleted.'));

  return 'admin/store/settings/promo/'. $form_values['promo_id'] .'/codes';
}

/**
 * Loads a promotional code's data from the database.
 *
 * @param $code
 *   The promotional code to load.
 * @return
 *   An array of data for the promotional code; FALSE if the code isn't found.
 */
function uc_promo_load_code($code) {
  if (empty($code)) {
    return FALSE;
  }

  // Check to make sure non-priveleged users don't match directly on the bulk
  // generated special string.
  if (substr($code, 0, 7) === 'BULKGEN' && !user_access('administer uc promotions')) {
    return FALSE;
  }

  // Look for an exact match in the database.
  $result = db_query("SELECT * FROM {uc_promo_codes} WHERE UPPER(promo_code) = '%s'", strtoupper($code));

  // Return the data if an exact match was found.
  if ($data = db_fetch_array($result)) {
    return $data;
  }

  // Otherwise look for a bulk generated match in codes for active promotions
  // that haven't passed their expiration date.
  $result = db_query("SELECT pc.* FROM {uc_promo_codes} AS pc LEFT JOIN {uc_promos} AS p ON pc.promo_id = p.promo_id WHERE p.promo_status = 1 AND pc.expiration > %d AND pc.bulkgen_seed <> ''", time());
  while ($data = db_fetch_array($result)) {
    // Parse the promotion code
    $parts = explode('-', $data['promo_code']);

    // First check that the code is the correct length.
    if (strlen($code) != $parts[1]) {
      continue;
    }

    // Second check that the sequence part of the code is in the valid range.
    // The code sequence is encoded in the first 5 characters of the code.
    $sequence = explode("U", substr(strtoupper($code), 0, 5));
    if (preg_match("/^[0-9ABCDEF]{1,5}$/", $sequence[0])) {
      $sequence = hexdec($sequence[0]);
      if ($sequence >= $parts[2]) {
        continue;
      }
    }
    else {
      continue;
    }

    // Last, check that the MD5 hash part of code is valid.
    $hash = substr(md5($sequence . $data['promo_id'] . $data['bulkgen_seed']), 0, ($parts[1] - 5));

    if (strcasecmp($hash, substr($code, 5)) == 0) {
      return $data;
    }
  }

  return FALSE;
}

/**
 * Saves or inserts a new promotional code.
 *
 * @param $data
 *   An array of data representing the promotional code.
 */
function uc_promo_save_code($data) {
  // First try to update an existing promotional code.
  db_query("UPDATE {uc_promo_codes} SET promo_code_type = %d, max_redemptions = %d, expiration = %d WHERE UPPER(promo_code) = '%s'",
    $data['promo_code_type'], $data['max_redemptions'], $data['expiration'], strtoupper($data['promo_code']));

  // Otherwise insert a new promotional code.
  if (db_affected_rows() == 0) {
    db_query("INSERT INTO {uc_promo_codes} (promo_code, promo_id, promo_code_type, bulkgen_seed, redemptions, max_redemptions, expiration, created, last_redemption) VALUES ('%s', %d, %d, '%s', %d, %d, %d, %d, %d)",
      strtoupper($data['promo_code']), $data['promo_id'], $data['promo_code_type'],
      $data['bulkgen_seed'], 0, $data['max_redemptions'], $data['expiration'],
      time(), 0);
  }
}

/**
 * Delete a promotional code from the database.
 *
 * @param $promo_code
 *   The ID of the promotional code to delete.
 */
function uc_promo_delete_code($code) {
  // Delete any related promotional code redemptions.
  db_query("DELETE FROM {uc_promo_code_redemptions} WHERE promo_code = '%s'", $code);

  // Delete the code itself.
  db_query("DELETE FROM {uc_promo_codes} WHERE promo_code = '%s'", $code);

  watchdog('uc_promo', t('Promotional code %code deleted.', array('%code' => $code)));
}

// Displays a table of redemptions for the specified promotional code.
function uc_promo_redemptions($promo_id, $code) {
  // Load the specified promotion; will be FALSE if $code == 0.
  $data = uc_promo_load_promotion($promo_id);

  if ($data === FALSE) {
    drupal_set_message(t('Specified promotion does not exist.'), 'error');
    drupal_goto('admin/store/settings/promo');
  }

  $output = '<div>'. t('<strong>Promotion:</strong> @name', array('@name' => check_plain($data['promo_name']))) .'<br />';

  // Load the specified promotional code; will be FALSE if $code == 0.
  $data = uc_promo_load_code($code);

  if ($data === FALSE) {
    drupal_set_message(t('Specified promotional code does not exist.'), 'error');
    drupal_goto('admin/store/settings/promo/'. $promo_id .'/codes');
  }

  $output .= t('<strong>Code:</strong> @code', array('@code' => check_plain($code))) .'</div>';

  $output .= '<div>'. l(t('Return to promotional codes listing.'), 'admin/store/settings/promo/'. $promo_id .'/codes') .'</div>';

  $header = array(
    array('data' => t('Redeemed on'), 'field' => 'redeemed', 'sort' => 'desc'),
    array('data' => t('User'), 'field' => 'uid'),
  );

  if (substr($code, 0, 7) === 'BULKGEN') {
    $header[] = array('data' => t('Bulk code'), 'field' => 'bulk_code');
  }

  $rows = array();

  $result = pager_query("SELECT * FROM {uc_promo_code_redemptions} WHERE promo_code = '%s'". tablesort_sql($header), 30, 0, NULL, $code);
  while ($data = db_fetch_array($result)) {
    $row = array(
      array('data' => format_date($data['redeemed'], 'short'), 'style' => 'white-space: nowrap'),
      array('data' => $data['uid'] > 0 ? l($data['uid'], 'user/'. $data['uid']) : '0', 'width' => substr($code, 0, 7) === 'BULKGEN' ? '33%' : '50%'),
    );

    if (substr($code, 0, 7) === 'BULKGEN') {
      $row[] = $data['bulk_code'];
    }

    $rows[] = $row;
  }

  if (count($rows) == 0) {
    $rows[] = array(
      array('data' => t('This promotional code has not been redeemed.'), 'colspan' => 5),
    );
  }

  $output .= theme('table', $header, $rows) . theme('pager');

  return $output;
}

/**
 * Checks the database to see if a code is valid.
 *
 * @param $code
 *   The promotional code to validate.
 * @return
 *   TRUE or FALSE depending on whether the code is valid or not.
 */
function uc_promo_validate_code($code, $user) {
  // Return FALSE if the code is not found.
  if (!$data = uc_promo_load_code($code)) {
    return FALSE;
  }

  // Validate the code based on its type.
  switch ($data['promo_code_type']) {
    // Unlimited use promotional code.
    case 1:
      // Nothing should cause these to fail.
      break;

    // Specified number of uses.
    case 2:
      // Return FALSE if the code has been used up; handle bulk codes in a way
      // that accounts for redemptions of individual bulk generated codes.
      if (substr($data['promo_code'], 0, 7) === 'BULKGEN') {
        $count = db_result(db_query("SELECT COUNT(*) FROM {uc_promo_code_redemptions} WHERE promo_code = '%s' AND bulk_code = '%s'", $data['promo_code'], $code));
        if ($count >= $data['max_redemptions']) {
          return FALSE;
        }
      }
      else {
        if ($data['redemptions'] >= $data['max_redemptions']) {
          return FALSE;
        }
      }
      break;

    // Expiration date.
    case 3:
      // Return FALSE if the code has expired.
      if (time() >= $data['expiration']) {
        return FALSE;
      }
      break;
  }

  // Return FALSE if the promotion is no longer available or is disabled.
  $active = db_result(db_query("SELECT promo_id FROM {uc_promos} WHERE promo_id = %d AND promo_status = 1", $data['promo_id']));
  if (!$active) {
    return FALSE;
  }

  $redeem_once = db_result(db_query("SELECT redeem_once FROM {uc_promos} WHERE promo_id = %d", $data['promo_id']));
  if ($redeem_once == 1) {
    $redeemed = db_result(db_query("SELECT COUNT(redemption_id) FROM {uc_promo_code_redemptions} WHERE promo_id = %d AND uid = %d", $data['promo_id'], $user->uid));
    if ($redeemed > 0) {
      return FALSE;
    }
  }

  return TRUE;
}

/**
 * Redeems a promotional code for a user by adding a redemption in the database
 *   and updating the promotional code's data as needed.
 *
 * @param $code
 *   The promotional code to redeem.
 * @param $user
 *   The user account for which the code is being redeemed.
 * @param $bulk_id
 *   If the code is a special BULKGEN code, $bulk_code should contain the actual
 *     unique code used to redeem the promotion.
 */
function uc_promo_redeem_code($code, $user, $bulk_code = NULL) {
  // Load the appropriate promotion ID.
  $promo_id = db_result(db_query("SELECT promo_id FROM {uc_promo_codes} WHERE promo_code = '%s'", $code));

  // Insert the redemption into the database.
  db_query("INSERT INTO {uc_promo_code_redemptions} (redemption_id, promo_code, bulk_code, promo_id, uid, redeemed) VALUES (%d, '%s', '%s', %d, %d, %d)",
    db_next_id('{uc_promo_code_redemptions}_redemption_id'), $code, $bulk_code,
    $promo_id, $user->uid, time());

  // Update the promotion to reflect the redemption.
  db_query("UPDATE {uc_promo_codes} SET redemptions = redemptions + 1, last_redemption = %d WHERE promo_code = '%s'", time(), $code);
}

// Downloads a file containing a bulk generated set of promotional codes.
function uc_promo_code_bulkgen($promo_id, $code) {
  // Load the data directly from the database.
  $result = db_query("SELECT * FROM {uc_promo_codes} WHERE UPPER(promo_code) = '%s'", strtoupper($code));

  if ($data = db_fetch_array($result)) {
    $filename = $code .'.csv';

    header('Content-Type: application/octet-stream');
    header('Content-Disposition: attachment; filename="' . $filename . '";');

    $parts = explode('-', $code);

    $codes = '';
    for ($i = 0; $i < $parts[2]; $i++) {
      $codes .= strtoupper(str_pad(dechex($i), 5, 'U' . md5($data['bulkgen_seed'] . $i)) . substr(md5($i . $promo_id . $data['bulkgen_seed']), 0, $parts[1] - 5)) .",\n";
    }

    echo rtrim($codes, ",\n");

    exit();
  }
  else {
    return drupal_not_found();
  }
}

// Workflow-ng action callback and form functions.
function uc_promo_user_add_download($account, $settings) {
  _user_table_action('allow', $settings['fid'], $account->uid, NULL);
}

function uc_promo_user_add_download_form($settings = array()) {
  if (!is_dir(variable_get('uc_file_base_dir', NULL))) {
    drupal_set_message(t('A file directory needs to be configured in <a href="!url">product feature settings</a> before a file can be selected.', array('!url' => url('admin/store/settings/products/edit/features'))), 'error');
  }
  $form['uc_file_filename'] = array(
    '#type' => 'textfield',
    '#title' => t('File download'),
    '#default_value' => $default_filename,
    '#autocomplete_path' => '_autocomplete_file',
    '#description' => t('The file that can be downloaded when product is purchased (enter a path relative to the %dir directory).', array('%dir' => variable_get('uc_file_base_dir', NULL))),
  );

  return $form;
}

function uc_promo_user_add_download_validate($form_id, $form_values) {
  if (!db_result(db_query("SELECT fid FROM {uc_files} WHERE filename = '%s'", $form_values['uc_file_filename']))) {
    form_set_error('uc_file_filename', t('%file is not a valid file or directory inside file download directory.', array('%file' => $form_values['uc_file_filename'])));
  }
}

function uc_promo_user_add_download_submit($form_id, $form_values) {
  return array('fid' => db_result(db_query("SELECT fid FROM {uc_files} WHERE filename = '%s'", $form_values['uc_file_filename'])));
}
