ding_campaign.module

<?php

/**
 * @file
 * Provides campaign feature to various node types in Ding.
 */
define('DING_CAMPAIGN_PATH', drupal_get_path('module', 'ding_campaign'));
define('DING_CAMPAIGN_DEFAULT_COUNT', 3);

/**
 * Implements hook_menu().
 */
function ding_campaign_menu() {
  $items = array();

  $items['admin/config/ding/campaign'] = array(
    'title' => 'Ding! Campaign',
    'description' => 'Configure the Ding! campaign system.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ding_campaign_configure'),
    'access arguments' => array('access administration pages'),
    'file' => 'ding_campaign.admin.inc',
  );

  $items['node/%node/campaign_rules'] = array(
    'title' => 'Campaign rules',
    'description' => 'Edit campaign rules',
    'page callback' => 'ding_campaign_rules_admin',
    'page arguments' => array(1),
    'access arguments' => array('access campaign rules'),
    'file' => 'ding_campaign.admin.inc',
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
  );

  $items['ding_campaign/autocomplete/%'] = array(
    'title' => 'Campaign rule autocomplete',
    'description' => 'Autocomplete field for campaign rule values.',
    'page callback' => 'ding_campaign_admin_autocomplete',
    'page arguments' => array(2),
    'access arguments' => array('access campaign rules'),
    'file' => 'ding_campaign.admin.inc',
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
 * Implements hook_perimission().
 */
function ding_campaign_permission() {
  $perm = array();

  $perm['access campaign rules'] = array(
    'title' => t('Access campaign rules'),
    'description' => t('Enable access to campaign nodes display rules'),
  );

  return $perm;
}

/**
 * Implements hook_admin_paths().
 */
function ding_campaign_admin_paths() {
  $paths = array(
    'node/*/campaign_rules' => TRUE,
  );
  return $paths;
}

/**
 * Implements hook_theme().
 */
function ding_campaign_theme($existing, $type, $theme, $path) {
  $hooks = array();

  $hooks['ding_campaign'] = array(
    'variables' => array('content' => NULL),
    'template' => 'ding_campaign',
    'path' => DING_CAMPAIGN_PATH . '/templates/',
  );

  return $hooks;
}

/**
 * Displays certain campaigns.
 *
 * @param $context
 *   Display context used.
 * @param $count
 *   Count of campaigns to display.
 * @param $offset
 *   Offset of the first campaign in the database.
 *
 * @return
 *   HTML formatted string.
 */
function ding_campaign_display($context, $count, $offset, $style = 'medium') {

  $campaigns = ding_campaign_get_campaigns($context, $count, $offset);

  // There is at least one result.
  if (is_array($campaigns) && count($campaigns) > 0) {
    $block = '';

    // Loop through campaigns.
    foreach ($campaigns as $k => $v) {
      $node = node_load($v);
      $content = '';

      $camp_settings = field_get_items('node', $node, 'field_camp_settings');

      $base_class = 'ding-campaign-item';
      // Select the display for campaign type.
      switch ($camp_settings[0]['value']) {
        case 'plain':
          $camp_link = field_get_items('node', $node, 'field_camp_link');
          $camp_text_plain = field_get_items('node', $node, 'field_camp_text_plain');
          $content = '<div class="' . $base_class . ' ' . $base_class . '-id-' . $v . ' ding-campaign-item-plain"><a href="' . $camp_link[0]['value'] . '">' . $camp_text_plain[0]['value'] . '</a></div>';
          break;
        case 'image':
          $camp_link = field_get_items('node', $node, 'field_camp_link');
          $camp_image = field_get_items('node', $node, 'field_camp_image');

          $image_title = field_get_items('file', (object) ($camp_image[0]), 'field_file_image_title_text');
          $image_title = $image_title[0]['safe_value'];
          $image_alt = field_get_items('file', (object) ($camp_image[0]), 'field_file_image_alt_text');
          $image_alt = $image_alt[0]['safe_value'];

          if (empty($image_alt)) {
            $image_alt = $image_title;
          }

          $image_tag = theme('image_style', array(
            'style_name' => $style,
            'path' => $camp_image[0]['uri'],
            'alt' => $image_alt,
            'title' => $image_title,
          ));

          $link_tag = l($image_tag, $camp_link[0]['value'], array('html' => TRUE, 'absolute' => TRUE, 'attributes' => array('target' => '_blank')));
          $content = '<div class="' . $base_class . ' ' . $base_class . '-id-' . $v . ' ding-campaign-item-image">' . $link_tag . '</div>';
          break;
        case 'full':
          $camp_text_full = field_get_items('node', $node, 'field_camp_text_full');
          $content = '<div class="' . $base_class . ' ' . $base_class . '-id-' . $v . ' ding-campaign-item-full">' . $camp_text_full[0]['safe_value'] . '</div>';
          break;
      }

      $theme = 'ding_campaign';
      $block .= theme($theme, array('content' => $content));
    }
    return $block;
  }
}

/**
 * Fetch campaign from database according to context.
 *
 * @param $context
 * @param $limit
 * @param $offset
 *
 * @return
 */
function ding_campaign_get_campaigns($context, $limit, $offset) {

  $campaigns = array();

  // Process event campaigns.
  if ($context['page'] != NULL && isset($context['page']->nid) && $context['page']->type == 'ding_event') {
    $nid = $context['page']->nid;

    $result = db_query('SELECT r.cid, d.weight
      FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
      WHERE r.nid = :nid
        AND r.type = \'rule_event\'
        AND n.status = 1
        AND r.cid = d.cid
        AND r.cid = n.nid
      ORDER BY d.weight DESC', array(':nid' => (int) $nid))
      ->fetchAll();

    foreach ($result as $k => $v) {
      @$campaigns[$v->cid] += -50 + $v->weight;
    }
  }

  // Process news campaigns.
  if ($context['page'] != NULL && isset($context['page']->nid) && $context['page']->type == 'ding_news') {
    $nid = $context['page']->nid;

    $result = db_query('SELECT r.cid, d.weight
      FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
      WHERE r.nid = :nid
        AND r.type = \'rule_news\'
        AND n.status = 1
        AND r.cid = d.cid
        AND r.cid = n.nid
      ORDER BY d.weight DESC', array(':nid' => (int) $nid))
      ->fetchAll();

    foreach ($result as $k => $v) {
      @$campaigns[$v->cid] += -45 + $v->weight;
    }
  }

  // Process page campaigns.
  if ($context['page'] != NULL && isset($context['page']->nid)) {
    $nid = $context['page']->nid;

    $result = db_query('SELECT r.cid, d.weight
      FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
      WHERE r.nid = :nid
        AND r.type = \'rule_page\'
        AND n.status = 1
        AND r.cid = d.cid
        AND r.cid = n.nid
      ORDER BY d.weight DESC', array(':nid' => (int) $nid))
      ->fetchAll();

    foreach ($result as $k => $v) {
      @$campaigns[$v->cid] += -40 + $v->weight;
    }
  }

  // Process path-based campaigns.
  $result = db_query('SELECT r.cid, r.rule, d.weight
    FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
    WHERE r.type = \'rule_path\'
      AND n.status = 1
      AND r.cid = d.cid
      AND r.cid = n.nid
    ORDER BY d.weight DESC')
    ->fetchAll();

  $path = drupal_get_path_alias($_GET['q']);
  foreach ($result as $k => $v) {
    $page_match = drupal_match_path($path, $v->rule);

    if ($path != $_GET['q']) {
      $page_match = $page_match || drupal_match_path($_GET['q'], $v->rule);
    }

    if ($page_match) {
      @$campaigns[$v->cid] += -35 + $v->weight;
    }
  }

  // Process search campaigns.
  if ($context['search_term'] != NULL) {
    $terms = trim(drupal_strtolower($context['search_term']));
    $condition = $terms;
    $multiple = FALSE;

    // Multiple keywords, comma and/or space separated.
    if (strpos($terms, ',') || strpos($terms, ' ')) {
      $terms = preg_replace('/(,?\s+)/', ',', $terms);
      $terms = explode(',', $terms);
      $condition = $terms;
      $multiple = TRUE;
    }

    $query = db_select('ding_campaign_rules', 'r');
    $query->fields('r', array('cid'));
    $query->join('ding_campaign', 'd', 'r.cid = d.cid');
    $query->join('node', 'n', 'r.cid = n.nid');
    $query->addField('d', 'weight');
    $query->condition('n.status', 1, '=');
    $query->condition('r.type', 'rule_term', '=');
    if ($multiple) {
      $query->condition('r.rule', $condition, 'IN');
    }
    // Single keyword.
    else {
      $query->condition('r.rule', $condition);
    }
    $query->orderBy('d.weight', 'DESC');
    $result = $query->execute()->fetchAll();


    foreach ($result as $k => $v) {
      @$campaigns[$v->cid] += -30 + $v->weight;
    }
  }

  // Process library campaigns.
  if ($context['page'] != NULL && isset($context['page']->nid) && $context['page']->type == 'ding_library') {
    $nid = $context['page']->nid;

    $result = db_query('SELECT r.cid, d.weight
      FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
      WHERE r.nid = :nid
        AND r.type = \'rule_library\'
        AND n.status = 1
        AND r.cid = d.cid
        AND r.cid = n.nid
      ORDER BY d.weight DESC', array(':nid' => (int) $nid))
      ->fetchAll();

    foreach ($result as $k => $v) {
      @$campaigns[$v->cid] += -25 + $v->weight;
    }
  }

  // Process taxonomy campaigns.
  if ($context['taxonomy_term'] != NULL && isset($context['taxonomy_term']->tid)) {
    $tid = $context['taxonomy_term']->tid;

    $result = db_query('SELECT r.cid, d.weight
      FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
      WHERE r.nid = :tid
        AND r.type = \'rule_taxonomy\'
        AND n.status = 1
        AND r.cid = d.cid
        AND r.cid = n.nid
      ORDER BY d.weight DESC', array(':tid' => (int) $tid))
      ->fetchAll();

    foreach ($result as $k => $v) {
      @$campaigns[$v->cid] += -20 + $v->weight;
    }
  }

  // Process generic campaigns.
  $result = db_query('SELECT r.cid, d.weight
    FROM {ding_campaign_rules} r, {ding_campaign} d, {node} n
    WHERE r.type = \'rule_generic\'
      AND n.status = 1
      AND r.cid = d.cid
      AND r.cid = n.nid
    ORDER BY d.weight DESC')
    ->fetchAll();

  foreach ($result as $k => $v) {
    if (!isset($campaigns[$v->cid]) || $campaigns[$v->cid] == 0) {
      $campaigns[$v->cid] += -15 + $v->weight;
    }
  }

  asort($campaigns);

  return array_slice(array_keys($campaigns), $offset, $limit);
}

/**
 * Implements hook_form_alter().
 */
function ding_campaign_form_alter(&$form, &$form_state, $form_id) {
  // Alter the Campaign addition form.
  if ($form_id == 'ding_campaign_node_form') {
    // Remove the 'N/A' type radiobox.
    unset($form['field_camp_settings'][$form['field_camp_settings']['#language']]['#options']['_none']);
    // Remove the 'None' value from weight dropdown.
    unset($form['field_camp_weight'][$form['field_camp_weight']['#language']]['#options']['_none']);

    $lang = $form['field_camp_settings']['#language'];
    $form['field_camp_text_plain']['#states'] = array(
      'visible' => array(
        ':input[name=field_camp_settings[' . $lang . ']]' => array('value' => 'plain')
      )
    );

    $form['field_camp_image']['#states'] = array(
      'visible' => array(
        ':input[name=field_camp_settings[' . $lang . ']]' => array('value' => 'image')
      )
    );

    $form['field_camp_text_full']['#states'] = array(
      'visible' => array(
        ':input[name=field_camp_settings[' . $lang . ']]' => array('value' => 'full')
      )
    );

    $form['#validate'] = array('ding_campaign_campaign_node_form_validate');
  }
  else {
    $enabled_types = variable_get('ding_campaign_node_types', array());

    // Alter the specific node form, mentioned in Campaign settings.
    if (isset($form['#node']) && isset($enabled_types[$form['#form_id']]) && ($enabled_types[$form['#form_id']] === $form['#form_id'])) {
      $form['ding_campaigns_wrap'] = array(
        '#type' => 'fieldset',
        '#title' => 'Available campaigns',
      );

      $form['ding_campaigns_wrap']['ding_campaigns'] = array(
        '#type' => 'checkboxes',
        '#default_value' => isset($form['#node']->ding_campaigns) ? $form['#node']->ding_campaigns : array(),
        '#options' => ding_campaign_get_list(),
        '#description' => 'Select campaigns asociated with this node.',
      );
    }
  }
}

/**
 * Implements hook_node_insert().
 */
function ding_campaign_node_insert($node) {
  // Insert the campaign type node.
  if ($node->type == 'ding_campaign') {
    $node_type = field_get_items('node', $node, 'field_camp_settings');
    $node_weight = field_get_items('node', $node, 'field_camp_weight');

    $data = array(
      'cid' => $node->nid,
      'type' => $node_type[0]['value'],
      'weight' => $node_weight[0]['value'],
    );

    db_insert('ding_campaign')
      ->fields($data)
      ->execute();

    return;
  }

  $enabled_types = variable_get('ding_campaign_node_types', array());

  // Process other types of nodes (selected in backend).
  if (isset($enabled_types[$node->form_id]) && $enabled_types[$node->form_id] === $node->form_id) {
    if (isset($node->ding_campaigns) && is_array($node->ding_campaigns)) {
      foreach ($node->ding_campaigns as $k => $v) {
        $type = _ding_campaign_rule_by_type($node->type);
        $data = array(
          'nid' => $node->nid,
          'cid' => $v,
          'rule' => '[nid:' . $node->nid . ']',
          'type' => $type,
        );

        // Skip the unused campaigns.
        if ($v != 0) {
          db_insert('ding_campaign_rules')
            ->fields($data)
            ->execute();
        }
      }
    }
  }
}

/**
 * Implements hook_node_update().
 */
function ding_campaign_node_update($node) {
  // Update the campaign if needed.
  if ($node->type == 'ding_campaign') {
    $node_type = field_get_items('node', $node, 'field_camp_settings');
    $node_weight = field_get_items('node', $node, 'field_camp_weight');

    // Update campaign fields.
    $data = array(
      'type' => $node_type[0]['value'],
      'weight' => $node_weight[0]['value'],
    );

    db_update('ding_campaign')
      ->fields($data)
      ->condition('cid', $node->nid)
      ->execute();

    return;
  }

  $enabled_types = variable_get('ding_campaign_node_types', array());

  // Process other types of nodes (selected in backend).
  if (isset($enabled_types[$node->type . '_node_form']) && $enabled_types[$node->type . '_node_form'] === $node->type . '_node_form') {
    if (isset($node->ding_campaigns) && is_array($node->ding_campaigns)) {
      // Renew the assigned campaigns.
      db_delete('ding_campaign_rules')
        ->condition('nid', $node->nid)
        ->execute();

      foreach ($node->ding_campaigns as $k => $v) {
        $type = _ding_campaign_rule_by_type($node->type);

        $data = array(
          'nid' => $node->nid,
          'cid' => $v,
          'rule' => '[nid:' . $node->nid . ']',
          'type' => $type,
        );

        // Skip the unused campaigns.
        if ($v != 0) {
          db_insert('ding_campaign_rules')
            ->fields($data)
            ->execute();
        }
      }
    }
  }
}

/**
 * Implements hook_node_load().
 */
function ding_campaign_node_load($node) {
  $nids = array_keys($node);

  if ($node[$nids[0]]->type == 'ding_campaign') {
    $result = db_select('ding_campaign_rules')
      ->fields('ding_campaign_rules', array('rule', 'type'))
      ->condition('cid', $node[$nids[0]]->nid)
      ->execute()
      ->fetchAll();

    // Add assigned campaigns.
    if (is_array($result) && count($result) > 0) {
      foreach ($result as $k => $v) {
        $node[$nids[0]]->camp_rule[$k] = $v->rule;
        $node[$nids[0]]->camp_type[$k] = $v->type;
      }
    }

    return;
  }

  $enabled_types = variable_get('ding_campaign_node_types', array());

  // Process other types of nodes (selected in backend).
  if (isset($enabled_types[$node[$nids[0]]->type . '_node_form']) && $enabled_types[$node[$nids[0]]->type . '_node_form'] === $node[$nids[0]]->type . '_node_form') {
    $nids = array_keys($node);
    $or = db_or()->condition('type', 'rule_library')->condition('type', 'rule_page')->condition('type', 'rule_news')->condition('type', 'rule_event');
    $result = db_select('ding_campaign_rules')
      ->fields('ding_campaign_rules', array('cid'))
      ->condition('nid', $node[$nids[0]]->nid)
      ->condition($or)
      ->execute()
      ->fetchAll();

    foreach ($result as $k => $v) {
      $node[$nids[0]]->ding_campaigns[$v->cid] = $v->cid;
    }
  }
}

/**
 * Implements hook_node_delete().
 */
function ding_campaign_node_delete($node) {
  // Delete the campaign if needed.
  if ($node->type == 'ding_campaign') {
    db_delete('ding_campaign')
      ->condition('cid', $node->nid)
      ->execute();

    db_delete('ding_campaign_rules')
      ->condition('cid', $node->nid)
      ->execute();

    return;
  }

  $enabled_types = variable_get('ding_campaign_node_types', array());

  // Process other types of nodes (selected in backend).
  if (isset($enabled_types[$node->type . '_node_form']) && $enabled_types[$node->type . '_node_form'] === $node->type . '_node_form') {
    if (isset($node->ding_campaigns) && is_array($node->ding_campaigns)) {
      db_delete('ding_campaign_rules')
        ->condition('nid', $node->nid)
        ->execute();
    }
  }
}

/**
 * Fetch available campaigns.
 *
 * @return
 *   Array of campaigns with ids and titles.
 */
function ding_campaign_get_list() {
  $result = db_query("SELECT n.nid, n.title FROM {node} n
    WHERE n.status <> 0
      AND n.type = 'ding_campaign'
    ORDER BY n.title")
    ->fetchAll();

  $campaigns = array();

  foreach ($result as $k => $v) {
    $campaigns[$v->nid] = $v->title;
  }

  return $campaigns;
}

/**
 * Implements hook_ctools_plugin_directory().
 */
function ding_campaign_ctools_plugin_directory($module, $plugin) {
  if ($module == 'ctools') {
    return 'plugins/' . $plugin;
  }
}

/**
 * Custom node form validation.
 *
 * @see ding_campaign_form_alter()
 */
function ding_campaign_campaign_node_form_validate($form, &$form_state) {
  $input = $form_state['values'];
  $language = $input['language'];
  $campaign_type = $input['field_camp_settings'][$language][0]['value'];
  $t_vars = array('@type' => $campaign_type);

  // Forbid creation of campaign of type plain if the link is empty.
  if ($campaign_type == 'plain') {
    if (empty($input['field_camp_link'][$language][0]['value'])) {
      form_set_error('field_camp_link', t('Campaign of type <em>@type</em> requires a link.', $t_vars));
    }
  }

  // Force both image and link for image campaign types.
  if ($campaign_type == 'image') {
    if (empty($input['field_camp_link'][$language][0]['value']) || $input['field_camp_image'][$language][0]['fid'] == 0) {
      form_set_error('', t('Campaign of type <em>@type</em> requires an image and link.', $t_vars));
    }
  }
}

/**
 * Get rule name by node type.
 * @param string $node_type
 *   Node type.
 * @return string
 *   Rule name.
 */
function _ding_campaign_rule_by_type($node_type) {
  // Set rule type
  switch ($node_type) {
    case 'library':
      $type = 'rule_library';
      break;
    case 'ding_event':
      $type = 'rule_event';
      break;
    case 'ding_news':
      $type = 'rule_news';
      break;
    default:
      $type = 'rule_page';
  }
  return $type;
}