drupal/contributions/uc_affiliate.module

<?php
// $Id$

/**
 * @file
 * Tracks affiliate referrals and commissions.
 */
 
define ('ERROR_COMMISSION_NOT_NUMBER', 1);
define ('ERROR_COMMISSION_CANT_BE_NEGATIVE', 2);
define ('ERROR_COMMISSION_PERCENT_OUT_OF_BORDERS', 3);

define ('PRODUCT_ENABLED_FOR_AFFILIATES', 1);
define ('PRODUCT_DISABLED_FOR_AFFILIATES', 0);
define ('PRODUCT_DEFAULT_FOR_AFFILIATES', -1);

/**
 * Implementation of hook_help().
 */
function uc_affiliate_help($section = '') {
  switch ($section) {
    case 'admin/modules#description':
      return t('Tracks affiliate referrals and commissions');
      break;
    case 'admin/modules/affiliate':
      return t('Display user hierarchy.');
      break;
  }
}

/**
 * Implementation of hook_theme().
 */
function uc_affiliate_theme() {
  return array(
    'uc_affiliate_product_settings_table' => array(
      'arguments' => array('element' => NULL),
      'file' => 'uc_affiliate.pages.inc',
    )
  );
}

/**
 * Implementation of hook_perm().
 */
function uc_affiliate_perm() {
  return array('act as affiliate', 'administer affiliates');
}

/**
 * Implementation of hook_menu().
 */
function uc_affiliate_menu() {
  global $user;

  $items['admin/store/affiliate'] = array(
    'title' => 'Affiliates',
    'description' => 'Manage site affiliates',
    'page callback' => 'uc_affiliate_admin',
    'access arguments' => array('administer affiliates'),
    'file' => 'uc_affiliate.admin.inc',
  );
  $items['admin/store/affiliate/manage'] = array(
    'title' => 'Affiliates',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/store/affiliate/settings'] = array(
    'title' => 'Settings',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('uc_affiliate_admin_settings'),
    'access arguments' => array('administer affiliates'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'uc_affiliate.admin.inc',
    'weight' => 10,
  );
  $items['admin/store/affiliate/settings/global'] = array(
    'title' => 'Global',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/store/affiliate/reports'] = array(
    'title' => 'Reports',
    'page callback' => 'uc_affiliate_admin_daily_stats',
    'access arguments' => array('administer affiliates'),
    'file' => 'uc_affiliate.admin.inc',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/store/affiliate/reports/daily'] = array(
    'title' => 'Daily reports',
    'type' => MENU_DEFAULT_LOCAL_TASK ,
    'weight' => -10,
  );
  $items['admin/store/affiliate/reports/affiliate'] = array(
    'title' => 'Affiliate reports',
    'page callback' => 'uc_affiliate_admin_user_stats',
    'access arguments' => array('administer affiliates'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'uc_affiliate.admin.inc',
  );

  $items['user/affiliate/autocomplete'] = array(
    'title' => 'User autocomplete',
    'page callback' => 'uc_affiliate_autocomplete',
    'access arguments' => array('administer affiliates'),
    'type' => MENU_CALLBACK,
    'file' => 'uc_affiliate.pages.inc',
  );
  
  $items['user/%user/affiliate'] = array(
    'title' => 'Affiliate program',
    'access callback' => 'uc_affiliate_permissions',
    'access arguments' => array(1),
    'page callback' => 'uc_affiliate_dashboard',
    'page arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => -9,
    'file' => 'uc_affiliate.pages.inc',
  );
  $items['user/%user/affiliate/dashboard'] = array(
    'title' => 'Dashboard',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => 0,
  );
  $items['user/%user/affiliate/reports'] = array(
    'title' => 'Reports',
    'access callback' => 'uc_affiliate_permissions',
    'access arguments' => array(1),
    'page callback' => 'uc_affiliate_reports',
    'page arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 1,
    'file' => 'uc_affiliate.pages.inc',
  );
  $items['user/%user/affiliate/links'] = array(
    'title' => 'Links',
    'access callback' => 'uc_affiliate_permissions',
    'access arguments' => array(1),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('uc_affiliate_link_generator_form', 1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
    'file' => 'uc_affiliate.pages.inc',
  );

  /*// Removing Ubercart's "Orders" tab from affiliates
  $items[] = array(
    'path' => 'user/'. arg(1),
    'title' => t('User'),
    'type' => MENU_LOCAL_TASK || MENU_CREATED_BY_ADMIN,
    'callback' => 'uc_affiliate_stats',//'uc_affiliate_dashboard',
    'access' => 0
  );
  
  $items[] = array(
    'path' => 'user/'. arg(1) .'/view',
    'title' => t('View'),
    'access' => 0,
    'type' => MENU_CREATED_BY_ADMIN,
    'weight' => -10
  );
  
  $items[] = array(
    'path' => 'user/'. arg(1) .'/orders',
    'title' => t('Orders'),
    'description' => t('View your order history.'),
    'callback' => 'uc_order_history',
    'callback arguments' => array(arg(1)),
    'access' => 0,
    'type' => MENU_CREATED_BY_ADMIN,
  );*/

  $items['node/%node/edit/affiliate'] = array(
    'title' => 'Affiliate commission',
    'access callback' => 'uc_affiliate_product_access',
    'access arguments' => array(1),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('uc_affiliate_product_settings_form', 1),
    'type' => MENU_LOCAL_TASK,
    'weight' => -9,
    'file' => 'uc_affiliate.pages.inc',
  );

  return $items;
}

/**
 * Access callback for hook_menu().
 */
function uc_affiliate_permissions($affiliate = NULL) {
  global $user;
  
  if (!$affiliate) {
    $affiliate = $user;
  }

  return user_access('act as affiliate', $affiliate) && ($user->uid == $affiliate->uid || user_access('administer affiliates'));
}

/**
 * Checks access of product node.
 */
function uc_affiliate_product_access($node) {
  return ($node->type == 'product' && user_access('administer store'));
}

/**
 * Increment affiliate counts.
 */
function uc_affiliate_add_count($aff, $visits = 0, $users = 0, $sales = 0, $returns = 0, $commission = 0, $profit = 0) {
  $time = uc_affiliate_current_time();

  $res = db_fetch_object(db_query('SELECT affid, visits, users, sales, returns, commission, profit, time FROM {uc_affiliate_counts} WHERE affid=%d AND time=%d', $aff, $time));
  if ($res && $res->time) {
    db_query('UPDATE {uc_affiliate_counts} SET visits=(visits+%d), users=(users+%d), sales=(sales+%d), returns=(returns+%d), commission=(commission+%f), profit=(profit+%f) WHERE affid=%d AND time=%d', $visits, $users, $sales, $returns, $commission, $profit, $aff, $time);
  }
  else {
    db_query('INSERT {uc_affiliate_counts} (affid, visits, users, sales, returns, commission, profit, time) VALUES (%d, %d, %d, %d, %d, %f, %f, %d)', $aff, $visits, $users, $sales, $returns, $commission, $profit, $time);
  }
}

/**
 * Implementation of hook_exit().
 */
function uc_affiliate_exit($destination = NULL) {
  // this function sets $_SESSION['affid'] and increments click count
  uc_affiliate_click();
}

/**
 * Records affiliate ID in the user session and counts the click.
 */
function uc_affiliate_click() {
  if (isset($_REQUEST['a'])) {
    $affid = (int)$_REQUEST['a'];
    if ($affid) {
      // store affiliate id in session and increment click count
      if (!$_SESSION['affid']) {
        $_SESSION['affid'] = $affid;
        uc_affiliate_add_count($affid, 1, 0, 0, 0, 0);
      }
    }
  }
}

/**
 * Implementation of hook_add_to_cart_data().
 * Add tracking of which store each product comes from.
 */
function uc_affiliate_add_to_cart_data($form_values) {
  if (!empty($_SESSION['affid'])) {
    return array('affid' => $_SESSION['affid']);
  }
}

/**
 * Implementation of hook_order().
 */
function uc_affiliate_order($op, $order, $status) {
  switch ($op) {
    case 'update':
      if (in_array($status, variable_get('uc_affiliate_commission_order_status', array('completed')))) {
        uc_affiliate_process_sale($order);
      }
      elseif (in_array($status, variable_get('uc_affiliate_commission_return_status',  array('canceled')))) {
        uc_affiliate_process_return($order);
      }
  }
}

/**
 * Helper for hook_order(). Tracks affiliate commissions.
 * 
 * @param object $order
 *   Order to process.
 */
function uc_affiliate_process_sale($order) {
  global $user;

  // This prevents double commissions assigning.
  $result = db_result(db_query('SELECT COUNT(*) FROM {uc_affiliate_commissions} WHERE order_id = %d ORDER BY commission DESC', $order->order_id));
  if ($result) {
    return FALSE;
  }

  // Order ready for commission assignment
  $sales = array();

  // Sum the prices of products.
  foreach ($order->products as $product) {
    if (isset($product->data['affid']) && $affid = $product->data['affid']) {
      $sales[$affid][$product->nid]['count'] += $product->qty;
      $sales[$affid][$product->nid]['price'] += $product->qty * $product->price;
    }
  }

  if (!empty($sales)) {
    $level = 0;
    // Write commission records.
    foreach ($sales as $affid => $products) {
      foreach ($products as $nid => $total) {
        $commission = uc_affiliate_get_commission($nid, $affid, $total);
        // Allow other modules to affect on commission (can't use general
        // invoke because sending amount by reference).
        foreach (module_implements('uc_affiliate_pre_sale') as $module) {
          $function = $module .'_uc_affiliate_pre_sale';
          $function($order, $nid, $affid, $commission);
        }
        if ($commission > 0) {
          $commission_str = uc_affiliate_commission2str(uc_affiliate_get_product_commissions_data($nid, $affid), TRUE);

          $profit = $total['price'] - $commission;    

          $note = t('Level @level commission of (@comm_str * @count[@price] = @comm) recorded for affiliate @affiliate', array('@affiliate' => $affid, '@comm' => $commission, '@comm_str' => $commission_str, '@level' => $level, '@count' => $total['count'], '@price' => $total['price']));
          db_query('INSERT {uc_affiliate_commissions} (order_id, affid, level, commission, commission_notes) VALUES (%d, %d, %d, %f, "%s")', $order->order_id, $affid, $level, $commission, $note);
          uc_affiliate_add_count($affid, 0, 0, 1, 0, $commission, $profit);
          uc_order_comment_save($order->order_id, $user->uid, $note);      

          // Allow other modules to react on sale.         
          module_invoke_all('uc_affiliate_sale', $order, $nid, $affid, $commission);
        }
      }
    }
    return TRUE;
  }
  return FALSE;
}

/**
 * Helper for hook_order(). Tracks returns.
 * 
 * @param object $order
 *   Order to process.
 */
function uc_affiliate_process_return($order) {
  // This prevents double returns procesing.
  $result = db_result(db_query('SELECT COUNT(*) FROM {uc_affiliate_commissions} WHERE order_id = %d AND commission < 0', $order->order_id));
  if ($result) {
    return FALSE;
  }

  $result = db_query('SELECT order_id, affid, level, commission, commission_notes  FROM {uc_affiliate_commissions} WHERE order_id = %d AND level = 0 AND commission > 0', $order->order_id);
  while ($data = db_fetch_object($result)) {
    $return_amount = -$data->commission;

    // Allow other modules to affect on return amount (can't use general
    // invoke because sending amount by reference).
    foreach (module_implements('uc_affiliate_pre_return') as $module) {
      $function = $module .'_uc_affiliate_pre_return';
      $function($order, $data->affid, $return_amount);
    }

    if ($return_amount < 0) {
      $note = t('Return commissions (@comm) of order @order from affiliate @affiliate', array('@order' => $data->order_id, '@affiliate' => $data->affid, '@comm' => $return_amount));
      db_query('INSERT {uc_affiliate_commissions} (order_id, affid, level, commission, commission_notes) VALUES (%d, %d, %d, %f, "%s")', $data->order_id, $data->affid, $data->level, $return_amount, $note);
      uc_order_comment_save($data->order_id, $data->affid, $note);
      uc_affiliate_add_count($data->affid, 0, 0, 0, 1, $return_amount);

      // Allow other modules to react on return.
      module_invoke_all('uc_affiliate_return', $order, $data->affid, $return_amount);
    }
  }
  return TRUE;
}

/**
 * Get array of allowed products for selling through the affiliate network.
 *
 * @param $affid
 *   Affiliate ID (default - for all affiliates).
 * @return
 *   Array of product available for selling to specific affiliate.
 */
function uc_affiliate_get_affiliate_available_products($affid = NULL) {
  if (is_object($affid)) {
    $affid = $affid->uid;
  }

  // Prepare query.
  $query = 'SELECT DISTINCT(n.nid), n.title, COALESCE(uap.affid, 0) as "affid", uap.commission, COALESCE(uap.allowed, -1) as "allowed"
              FROM {uc_products} up
              LEFT JOIN {node} n ON n.nid = up.nid AND n.vid = up.vid
              LEFT JOIN {uc_affiliate_products} uap ON up.nid = uap.nid
            WHERE uap.affid = 0 OR uap.affid IS NULL';
  if ($affid) {
    $query .= ' OR uap.affid = %d';
  }
  $query .= ' ORDER BY uap.affid';
  $result = db_query($query, $affid);

  $allowed_by_default = variable_get('uc_affiliate_allow_products_by_default', TRUE);
  $products = array();
  while ($product = db_fetch_array($result)) {
    // We should skip default commission for specific affids, as it is already processed.
    if ($product['affid'] && $product['allowed'] == PRODUCT_DEFAULT_FOR_AFFILIATES) {
      continue;
    }

    if (($product['allowed'] == PRODUCT_DEFAULT_FOR_AFFILIATES && $allowed_by_default) || ($product['allowed'] == PRODUCT_ENABLED_FOR_AFFILIATES)) {
      $products[$product['nid']] = $product;
    }
    else {
      unset($products[$product['nid']]);
    }
  }

  return $products;
}

/**
 * Check if affiliate can sell a product.
 * @return
 *   TRUE or FALSE.
 * @param int $affid
 *   Affilite's UID.
 * @param int $nid
 *   Product NID.
 */
function uc_affiliate_is_affiliate_available_product($affid, $nid) {
  $products = uc_affiliate_get_affiliate_available_products($affid);
  return isset($products[$nid]);
}

/**
 * Check affiliate's activity since last 3 months.
 */
function uc_affiliate_is_affiliate_active($affid) {
  return db_result(db_query('SELECT COUNT(*) FROM {uc_affiliate_counts} WHERE affid = %d AND time > %d', $affid, strtotime("-30 days")));  
}

/**
 * Returns affiliate commission by given product and price.
 * 
 * @param int $nid
 *   Product NID.
 * @param int $affid
 *   Affiliate UID.
 * @param array $total[optional]
 *   Array with order item info.
 * @param int $total['count']
 *   Count of products in order item (for currency commissions).
 * @param int $total['price']
 *   Total price of order item (for percent commissions).
 * @param object $level[optional]
 *   Referral level.
 * @return
 *   Commission.
 */
function uc_affiliate_get_commission($nid, $affid, $total = NULL, $level = 0) {
  $data = uc_affiliate_get_product_commissions_data($nid, $affid);

  if (!$total) {
    $product = node_load($nid);
    $total = array(
      'count' => 1,
      'price' => $product->sell_price,
    );
  }

  switch ($data['commission'][$level]['type']) {
    case 'currency':
      $result = round($total['count'] * $data['commission'][$level]['value'], 3);
      break;
    case 'percent':
      $result = round($total['price'] * ($data['commission'][$level]['value']/100), 3);
      break;
  }

  if (variable_get('uc_affiliate_ceil_commission', TRUE)) {
    $result = ceil($result);
  }

  return $result;
}

/**
 * Get product's commissions data.
 *
 * @param $nid
 *   ID of product's node.
 * @param $affid
 *   Optional. Affiliate ID which want to sell this product (default - array of commissions for all affiliates).
 * @param $as_string
 *   Optional. If TRUE, will be returned string representation of commission structure.
 *
 * @return
 *   Array of product's commissions, or FALSE if nothing is specified.
 */
function uc_affiliate_get_product_commissions_data($nid, $affid = NULL, $options = array('fill_defaults' => TRUE, 'as_string' => FALSE)) {
  if (is_object($affid)) {
    $affid = $affid->uid;
  }

  // Prepare query.
  $query = 'SELECT uap.*, u.name as username FROM {uc_affiliate_products} uap LEFT JOIN {users} u ON u.uid = uap.affid WHERE (uap.nid = %d)';
  if ($affid) {
    $query .= ' AND ((uap.affid = %d)||(uap.affid = 0))';
  }
  $query .= ' ORDER BY u.name';
  $result = db_query($query, $nid, $affid);

  $commissions = array();
  while ($record = db_fetch_array($result)) {
    $record['commission'] = unserialize($record['commission']);
    $commissions[$record['affid']] = $record;
  }

  // In case when we show commissions table in admin area, we don't need this,
  // because default values should be shown as blank.
  if (!isset($options['fill_defaults']) || $options['fill_defaults']) {
    // Global product settings are always being stored in nid=0.
    if (isset($commissions[0])) {
      $global_product_settings = $commissions[0];
    }
    else {
      $global_product_settings = array(
        'allowed' => variable_get('uc_affiliate_allow_products_by_default', TRUE),
      );
    }

    // Fill up product's commission with global commission if it's not set.
    if (!isset($global_product_settings['commission']) || empty($global_product_settings['commission'])){
      $global_product_settings['commission'] = variable_get('uc_affiliate_commission', uc_affiliate_default_commission());
    }

    foreach ($commissions as $key => $commission){
      // if commission settings is blank, we should load global settings
      if (empty($commission['commission'])){
        $commissions[$key]['commission'] = $global_product_settings['commission'];
      }
    }
  }

  // Render as string if needed.
  if ((!isset($options['as_string']) || $options['as_string']) && !empty($commissions)) {
    foreach ($commissions as $key => $commission){
      $commissions[$key] = uc_affiliate_commission2str($commissions[$key]);
    }
  }

  // If certain affiliate provided, we should check allowance of the product for this affiliate.
  if ($affid) {
    if (uc_affiliate_is_affiliate_available_product($affid, $nid)) {
      // Fill defaults
      if (!$commissions[$affid]){
        $commissions[$affid] = $global_product_settings;
      }

      $commissions = $commissions[$affid];
    }
    else {
      $commissions = 0;
    }

  }

  return $commissions;
}

/**
 * Save product's commissions data to DB.
 *
 * @param array $data
 *   Array in format of:
 *     $data[$nid][$affid] = array(
 *       'commission' => $commission_array,
 *       'allowed' => PRODUCT_DISABLED_FOR_AFFILIATES | PRODUCT_ENABLED_FOR_AFFILIATES | PRODUCT_DEFAULT_FOR_AFFILIATES,
 *     )
 */
function uc_affiliate_set_product_commissions_data($data) {
  foreach ($data as $nid => $by_affid) {
    db_query('DELETE FROM {uc_affiliate_products} WHERE nid = %d', $nid);
    foreach ($by_affid as $affid => $comm) {
      $comm['nid'] = $nid;
      $comm['affid'] = $affid;
      if (is_array($comm['commission'])) {
        $comm['commission'] = serialize($comm['commission']);
      }
      drupal_write_record('uc_affiliate_products', $comm);
    }
  }
}

/**
 * Converts commission array to string representation.
 */
function uc_affiliate_commission2str($commission, $format_currency = FALSE, &$rec = FALSE) {
  $result = '';
  $context = array(
    'revision' => 'formatted-original',
    'location' => 'affiliate-commission',
  );

  if (is_array($commission) && !empty($commission)) {
    if (isset($commission['commission'])) {
      $commission['commission'] = uc_affiliate_commission2str($commission['commission'], $format_currency, $rec);
      return $commission;
    }
    
    $k = (string)key($commission);
    if (($k == 'value') || ($k == 'type')) {
      switch ($commission['type']) {
      case 'currency':
        if ($format_currency) {
          $result = uc_price($commission['value'], $context);
        }
        else {
          $result = $commission['value'];
        }
        break;
      case 'percent':
        $result = $commission['value'] .'%';
        break;
      }
      $rec = TRUE;
    }
    else {
      if (!empty($commission)) {
        foreach ($commission as $level => $data) {
          $arr[] = uc_affiliate_commission2str($data, $format_currency, $rec);
        }
        if ($rec) {
          $result = implode('; ', $arr);
        }
        $rec = FALSE;
      }
    }
  }
  return $result;
}

/**
 * Validate commission form element.
 */
function uc_affiliate_validate_commission($form_element, &$form_state) {
  $result = uc_affiliate_parse_commission($form_element['#value']);

  if (!is_array($result)) {
    if ($result == ERROR_COMMISSION_NOT_NUMBER) {
      form_set_error($form_element['#name'], t('Must be a positive number, percent or blank.'));
    }
    elseif ($result == ERROR_COMMISSION_CANT_BE_NEGATIVE) {
      form_set_error($form_element['#name'], t('Commission can not be negative.'));
    }
    elseif ($result == ERROR_COMMISSION_NOT_NUMBER) {
      form_set_error($form_element['#name'], t('Must be between 0% and 100%.'));
    }
    else {
      form_set_error($form_element['#name'], t('Something wrong happened during validation.'));
    }
  }
}

/**
 * Parse commission string and return array representation.
 */
function uc_affiliate_parse_commission($string, $return_serialized = FALSE) {
  $commissions = array();
  $string = trim($string);
  
  if ($string != '') {
    $chunks = explode(';', $string);
    if (!empty($chunks)) {
      foreach ($chunks as $value) {
        $value = trim($value);
        if (preg_match('@%$@', $value)) {
          $value = preg_replace('@%$@', '', $value);
          $type = 'percent';
        }
        else {
          $type = 'currency';
        }
        if (!is_numeric($value)) {
          return ERROR_COMMISSION_NOT_NUMBER;
        }
        else {
          $value = (float)$value;
          if ($value < 0) {
            return ERROR_COMMISSION_CANT_BE_NEGATIVE;
          }
          if ($type == 'percent') {
            if (($value < 0) || ($value > 100)) {
              return ERROR_COMMISSION_PERCENT_OUT_OF_BORDERS;
            }
          }
        }
        $commissions[] = array('type' => $type, 'value' => $value);
      }
    }
  }

  if ($return_serialized) {
    $commissions = serialize($commissions);
  }
  return $commissions;
}

/**
 * Returns serialized array representing default commission value.
 */
function uc_affiliate_default_commission() {
  return serialize(uc_affiliate_parse_commission('5%,3%,1%'));
}

/**
 * Get user's time value.
 */
function _user_time() {
  global $user;
  if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
    return (time() - date("Z")) + $user->timezone;
  }
  else {
    return (time() - date("Z")) + variable_get('date_default_timezone', 0);
  }
}

/**
 * Return the current time rounded down to the most recent chunk (day).
 */
function uc_affiliate_current_time() {
  $time = time();
  return $time - ($time % 86400);
}