modules/cubalaya/cubalaya.module

<?php

/**
 * Implementation of hook_perm
 *
 * @return array of permission strings
 */
function cubalaya_perm() {
  return array('administer cubalaya settings', 'view cubalaya nodes', 'administer cubalaya nodes', 'view cubalaya logs');
}


/**
 * Implementation of hook_help
 *
 * @param string $section - Defines section of the site
 * @return Help Text
 */
function cubalaya_help($section) {
  switch ($section) {
    case 'admin/settings#cubalaya' :
    case 'admin/help#cubalaya':
      return '<p>' . t('Configure your Cubalaya data here such as Account ID.') . '</p>';
    case 'admin/settings/cubalaya' :
      return '<p>' . t('Fill out the form below with your Cubalaya settings. The ID is provided to you by Cubalaya and contains numeric characters only. Fill out one of the height OR width fields - not both. This will limit the size of the images for you.') . '</p>';
  }
}


/**
 * Implementation of hook_menu
 *
 * @param boolean $may_cache - Defines if the menus being returned are statically cachable or dynamic
 * @return array of menu items
 */
function cubalaya_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array(
      'path' => 'admin/settings/cubalaya',
      'callback' => 'drupal_get_form',
      'callback arguments' => array('cubalaya_admin_form'),
      'access' => user_access('administer cubalaya settings'),
      'title' => t('Cubalaya'),
      'description' => t('Configure your Cubalaya data here, such as Account ID.'),
    );
    $items[] = array(
      'path' => 'admin/logs/cubalaya',
      'callback' => 'cubalaya_logs',
      'access' => user_access('view cubalaya logs'),
      'title' => t('Cubalaya'),
      'description' => t('View Cubalaya Clicks.'),
    );
  }
  else {
    $items[] = array(
      'path' => 'cubalaya/' . arg(1),
      'callback' => 'cubalaya_redirect',
      'callback arguments' => array(arg(1), (arg(2) == 'test')),
      'type' => MENU_CALLBACK,
      'access' => TRUE,
    );
  }

  return $items;
}


/**
 * Logs callback page
 *
 * @return page output - themed table in this case
 */
function cubalaya_logs() {
  $result = db_query("SELECT
                        FROM_UNIXTIME(c.timestamp, '%%d-%m-%y') as day,
                        c.nid nid,
                        count(*) as count
                      FROM cubalaya_hits c
                      GROUP BY day, c.nid WITH ROLLUP
                      ");


  $max = 0;
  $data = array();
  while($line = db_fetch_object($result)) {
    if (empty($line->day)) {
      //No day - this is the overall total...
    }
    else {
      //Day is set - is the nid?
      if(empty($line->nid)) {
        //Nid not set, total for that day
        $data[$line->day]['total'] = $line->count;
        if ($data[$line->day]['total'] > $max) { $max = $data[$line->day]['total']; }
      }
      else {
        //Nid is set, total for that node on that day
        $data[$line->day]['nid'][$line->nid] = $line->count;
      }
    }
  }


  $rows = array();
  foreach ($data as $day => $day_data) {
    $row = array();

    $row[] = $day;
    $row[] = $day_data['total'];
    $row[] = theme('cubalaya_day_breakdown', $day_data, $max);

    $rows[] = $row;
  }

  drupal_add_css(drupal_get_path('module', 'cubalaya') . '/cubalaya.css');
  $headers = array(
    array('data' => 'Date',  'style'=>'width: 60px'),
    array('data' => 'Total', 'style'=>'width: 40px'),
    'Breakdown'
    );
  return theme('table', $headers, $rows, array('style' => 'width: 100%;'));
}


/**
 * Pass in an array of hits per node for that day - get out a bar split relateively per day
 *
 * @param array $data - array of hits for that day per node
 * @param integer $max - maximum number of hits in period being displayed - used for percentage purposes
 * @return rendered output
 */
function theme_cubalaya_day_breakdown($data, $max) {
  $output = '<div class="cubalaya_bar">';

  $first = true;
  foreach ($data['nid'] as $nid => $count) {
    $output .= '<div class="cubalaya_breakdown_day ' . ($first ? 'first ' : '') . 'node_' . $nid . '" style="width: ' . (98.0 * $count / $max) . '%; "><!-- --></div>';
    $first = false;
  }

  $output .= '</div>';

  return $output;
}


/**
 * Redirect Callback
 *
 * @param integer $nid - Node ID of Cubalaya Product
 * @param boolean $testing - If true, then DO NOT record the hit in the database
 * @return if node is cubalaya product then no return (redirects instead), otherwise a 404.
 */
function cubalaya_redirect($nid, $testing = FALSE) {
  if ($node = node_load($nid)) {
    if ($node->type == 'cubalaya') {
      $settings = variable_get('cubalaya', array());

      $keywords = explode(',', $node->keywords);

      array_walk($keywords, 'trim');
      $keywords = implode('-', $keywords);

      $path = $node->link_type . '-' . $keywords;

      if (!$testing) {
        db_query("INSERT INTO {cubalaya_hits} VALUES(%d, %d)", $node->nid, time());
      }

      drupal_goto('http://www.cubalaya.co.uk/' . $path, $testing ? NULL : 'inId=' . $settings['settings']['id'], NULL, 301);
    }
  }
  return drupal_not_found();
}


/**
 * Implementation of hook_requirements
 *
 * @param string $phase - represents drupal phase (eg install or runtime)
 * @return array of requirement data
 */
function cubalaya_requirements($phase) {
  $requirements = array();
  // Ensure translations don't break at install time
  $t = get_t();

  // Report status
  if ($phase == 'runtime') {
    $requirements['cubalaya'] = array( 'title' => t('Cubalaya'), );


    $settings = variable_get('cubalaya', NULL);
    if(is_array($settings)) {
      $errors = array();

      //Check if the account ID is set
      if (!isset($settings['settings']['id'])) {
        $errors[] = $t('There is no account ID.');
      }

      //Check if the thumbnail sizes are set.
      if (!isset($settings['thumbnail']['width']) || !isset($settings['thumbnail']['height'])) {
        $errors[] = $t('There are no thumbnail settings.');
      }

      //If no errors, set a nice output - otherwise set and error output.
      if (empty($errors)) {
        $requirements['cubalaya']['value'] = $t('The module seems to be configured correctly.');
      }
      else {
        $requirements['cubalaya']['value'] = $t('There are configuration errors... please <a href="@url">rectify them</a>', array('@url' => url('admin/settings/cubalaya'), ));
        $requirements['cubalaya']['description'] = theme('item_list', $errors);
        $requirements['cubalaya']['severity'] = REQUIREMENT_ERROR;
      }
    }
    else {
      //No settings done yet, set a severe warning
      $requirements['cubalaya']['value'] = $t('No configuration found.');
      $requirements['cubalaya']['description'] = $t('please <a href="@url">configure this module</a>.', array('@url' => url('admin/settings/cubalaya'),));
      $requirements['cubalaya']['severity'] = REQUIREMENT_ERROR;
    }
  }

  return $requirements;
}


/**
 * Implementation of hook_access
 *
 * @param string $op - Operation on $node
 * @param object $node - Node Object
 * @return boolean
 */
function cubalaya_access($op, $node) {
  if ($op == 'view') {
    return user_access('administer cubalaya nodes');
  }

  else {
    return user_access('administer cubalaya nodes');
  }
}


/**
 * Implementation of hook_node_info
 *
 * @return array containing information about the Node - appears with the Create Content section
 */
function cubalaya_node_info() {
  return array(
    'cubalaya' => array(
      'name' => t('Cubalaya Product'),
      'module' => 'cubalaya',
      'description' => t("This is a cubalaya product which gets associated with other nodes."),
    )
  );
}


/**
 * Implementation of hook_form
 *
 * @param object $node - the Node object
 * @return array - structured as per the Forms API
 */
function cubalaya_form(&$node) {
  $type = node_get_types('type', $node);

  $form['#attributes'] = array('enctype' => 'multipart/form-data');

  // We need to define form elements for the node's title and body.
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Product Title'),
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
    '#description' => t('Enter the title of the product here'),
  );

  $form['keywords'] = array(
    '#type' => 'textfield',
    '#title' => t('Product Keywords'),
    '#required' => TRUE,
    '#default_value' => $node->keywords,
    '#weight' => -3,
    '#description' => t('Enter some keywords for this product, command separated'),
  );

  $form['link_type'] = array(
    '#type' => 'select',
    '#title' => t('What type of link would you like?'),
    '#required' => TRUE,
    '#default_value' => $node->link_type,
    '#options' => array('OP' => 'Offers Page (OP)', 'DP' => 'Deal Page (DP)', 'DC' => 'Direct Connect (DC)'),
    '#weight' => 0,
    '#description' => t('Enter some keywords for this product, command separated'),
  );

  if ($node->thumbnail) {
    $rows = array();
    foreach (image_get_info($node->thumbnail) as $key => $value) {
      $rows[] = array($key, $value);
    }
    $form['thumbnail_preview'] = array('#title' => t('Current Thumbnail'), '#value' => theme('table', NULL, $rows));
    $form['thumbnail'] = array('#type' => 'value', '#value' => $node->thumbnail);
  }

  $form['new_thumbnail'] = array(
    '#type' => 'file',
    '#title' => t('Image Thumbnail'),
    '#weight' => 4,
    '#description' => t('Attach an image to represent this product.'),
  );

  if ($node->thumbnail) {
    $form['new_thumbnail']['#description'] = t('An image is already attached, adding an image here will replace the previous image.');
  }


  return $form;
}


/**
 * Implementation of hook_validate
 *
 * @param Object $node - Node Object being validated
 */
function cubalaya_validate(&$node) {

  if (preg_match('|[^a-z0-9,]|i', $node->keywords)) {
    form_set_error('keywords', t('Please use alpha-numeric characters for the keyword and separate by comma.'));
  }

  if (empty($node->thumbnail) && empty($_FILES['files']['tmp_name']['new_thumbnail'])) {
    form_set_error('new_thumbnail', t('You must attach a thumbnail to this product'));
  }
  else if (!empty($_FILES['files']['tmp_name']['new_thumbnail']) && !in_array($_FILES['files']['type']['new_thumbnail'], array('image/png', 'image/gif', 'image/jpg', 'image/jpeg'))) {
    form_set_error('new_thumbnail', t('Please only attach PNG, GIF or JPEG images.'));
  }


  //These need to be done in two steps to make sure the top level folder exists.

  //Check for the cubalaya folder
  $path = file_directory_path() . '/cubalaya';
  file_check_directory($path, FILE_CREATE_DIRECTORY, 'new_thumbnail');

  //Check for the cubalaya/source folder
  $path = file_directory_path() . '/cubalaya/source';
  file_check_directory($path, FILE_CREATE_DIRECTORY, 'new_thumbnail');
}


/**
 * Implementation of hook_submit
 *
 * @param Object $node - Node object being submitted
 */
function cubalaya_submit(&$node) {
  $dest = file_create_path('cubalaya/source');

  if ($file = file_check_upload('new_thumbnail')) {
    $uploaded = file_save_upload($file, $dest);
  }

  if(is_object($uploaded)) {
    $node->thumbnail = $uploaded->filepath;
  }
}


/**
 * Implementation of hook_insert
 *
 * @param Object $node - Node object being inserted
 */
function cubalaya_insert(&$node) {
  db_query("INSERT INTO {node_cubalaya} VALUES(%d, '%s', '%s', '%s')", $node->nid, $node->keywords, $node->link_type, $node->thumbnail);
}


/**
 * Implementation of hook_update. This deletes any existing data and calls the insert function
 *
 * @param Object $node - Node object being updated
 */
function cubalaya_update(&$node) {
  db_query("DELETE FROM {node_cubalaya} WHERE nid=%d", $node->nid);
  cubalaya_insert($node);
}


/**
 * Implementation of hook_load
 *
 * @param Object $node - Node object being loaded
 * @return Object to be appended onto Node
 */
function cubalaya_load($node) {
  return db_fetch_object(db_query("SELECT * FROM {node_cubalaya} WHERE nid = %d", $node->nid));
}


/**
 * Implementation of hook_view
 *
 * @param Object $node - Node object being viewed
 * @param boolean $teaser - if view is teaser
 * @param boolean $page - if view is page
 * @return Node object
 */
function cubalaya_view($node, $teaser = FALSE, $page = FALSE) {
  $node = node_prepare($node, $teaser);

  $node->content['product_thumbnail'] = array(
    '#value' => theme('cubalaya_thumbnail', $node),
    '#weight' => 1,
  );
  $node->content['cubalaya_link'] = array(
    '#value' => l('Test Link', 'cubalaya/' . $node->nid . '/test', array('target' => '_blank')),
    '#weight' => 2,
  );


  return $node;
}


/**
 * Theme function to render a thumbnail for a node
 *
 * @param Object $node - Node Object being themed
 * @return Output HTML
 */
function theme_cubalaya_thumbnail($node) {
  if ($node->type != 'cubalaya') {
    return t('Not a Cubalaya Node');
  }

  $settings = variable_get('cubalaya', array());

  if (!($thumbnail_dst = cubalaya_get_thumbnail($node->thumbnail))) {
    $thumb_not_found_src = drupal_get_path('module', 'cubalaya') . '/images/thumbnail-not-available.png';

    if (!($thumbnail_dst = cubalaya_get_thumbnail($thumb_not_found_src))) {
      return "ERROR!!!";
    }
  }

  $output  = '<p>' . l(t($node->title), 'cubalaya/' . $node->nid) . '</p>';
  $output .= '<p>' . l(theme('image', $thumbnail_dst, $node->title, $node->title), 'cubalaya/' . $node->nid, array(), NULL, NULL, FALSE, TRUE) . '</p>';

  return $output;
}


/**
 * Function to get the path to a thumbnail
 *
 * @param string $src - Path to Source image
 * @return Either path to thumbnail OR FALSE is thumbnail creation failed
 */
function cubalaya_get_thumbnail($src) {
  //If source doesn't exist, return false
  if (!is_file($src)) {
    return FALSE;
  }

  //Get settings
  $settings = variable_get('cubalaya', array('thumbnail' => array('height' => 64, 'width' => ''), ));

  //Get a hash of the source.
  $src_hash = md5($src . $settings['thumbnail']['height'] . $settings['thumbnail']['width']);


  //Check the destination folder structure exists first...
  //Check for the cubalaya folder
  $path = file_directory_path() . '/cubalaya';
  if (!file_check_directory($path, FILE_CREATE_DIRECTORY, 'thumbnail')) return false;

  //Check for the cubalaya/thumbs folder
  $path = file_directory_path() . '/cubalaya/thumbs';
  if (!file_check_directory($path, FILE_CREATE_DIRECTORY, 'thumbnail')) return false;


  $dst = file_create_path('cubalaya/thumbs') . '/' . $src_hash . '.jpg';

  if (is_file($dst)) {
    //File exists - return the path
    return $dst;
  }
  else {
    //File doesn't exist - create it and return the path
    if ($details = image_get_info($src)) {
      if ($settings['thumbnail']['height'] > 0) {
        //Scale based in limited height...
        $scale = $settings['thumbnail']['height'] / $details['height'];
      }
      else {
        //Scale based in limited width...
        $scale = $settings['thumbnail']['width'] / $details['width'];
      }

      $width = $details['width'] * $scale;
      $height = $details['height'] * $scale;
      ini_set('memory_limit', '32M');
      if (image_resize($src, $dst, $width, $height)) {
        //If it worked - return the destination image path
        return $dst;
      }
      else {
        //Return false
        return FALSE;
      }
    }
    else {
      //Unable to get details on image - fail to create thumbnail
      return FALSE;
    }
  }

  //We shouldn't really ever get here, but if we do - assume something has gone wrong getting the thumbnail!
  return FALSE;
}


/**
 * Admin form callback
 *
 * @return array structured as per Forms API with System Settings buttons
 */
function cubalaya_admin_form() {
  $settings = variable_get('cubalaya', array());

  $form = array();

  $form['cubalaya'] = array(
    '#tree' => TRUE,
    );

  $form['cubalaya']['settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Settings'),
  );

  $form['cubalaya']['thumbnail'] = array(
    '#type' => 'fieldset',
    '#title' => t('Thumbnail Settings'),
  );


  $form['cubalaya']['settings']['id'] = array(
    '#title' => t('Account ID'),
    '#type' => 'textfield',
    '#description' => t('This is your account ID - usually a positive number.'),
    '#required' => TRUE,
    '#default_value' => isset($settings['settings']['id']) ? $settings['settings']['id'] : 0,
  );

  $form['cubalaya']['thumbnail']['width'] = array(
    '#title' => t('Thumbnail Width'),
    '#type' => 'textfield',
    '#description' => t('Maxmimum width of a thumbnail.'),
    '#default_value' => isset($settings['thumbnail']['width']) ? $settings['thumbnail']['width'] : '',
  );

  $form['cubalaya']['thumbnail']['height'] = array(
    '#title' => t('Thumbnail Height'),
    '#type' => 'textfield',
    '#description' => t('Maximum height of a thumbnail.'),
    '#default_value' => isset($settings['thumbnail']['height']) ? $settings['thumbnail']['height'] : '',
  );

  return system_settings_form($form);
}


/**
 * Validate the Admin Form
 *
 * @param string $form_id - unique ID for form
 * @param array $form_values - array of form values entered
 */
function cubalaya_admin_form_validate($form_id, $form_values) {
  $empty_width  = empty($form_values['cubalaya']['thumbnail']['width']);
  $empty_height = empty($form_values['cubalaya']['thumbnail']['height']);
  if ( ! ($empty_width xor $empty_height)) {
    //THIS ISN'T WORKING - IT WONT HIGHLIGHT THE FIELDS...
    form_set_error('cubalaya][thumbnail', t('You must fill out only one of the thumbnail size fields.'));
  }
}


/**
 * Implementation of hook_block
 *
 * @param string $op - Operation being performed on the block
 * @param mixed $delta - ID for this particular block
 * @param array $edit - values from configuration
 * @return array, depends on $op. See API for more details.
 */
function cubalaya_block($op = 'list', $delta = 0, $edit = array()) {
  if ($op == 'list') {
    $blocks[0]['info'] = t('Cubalaya Products Block');
    return $blocks;
  }
  else if ($op == 'view') {
    $products = cubalaya_get_associate_products();
    if (count($products)) {
      $nodes = array();
      foreach ($products as $nid) {
        $nodes[] = node_load($nid);
      }

      if (!empty($nodes)) {
        return array(
          'title' => t('Cubalaya'),
          'content' => theme('cubalaya_products_block', $nodes) . theme('cubalaya_image_link'),
        );
      }
    }
  }
}


/**
 * Theem function to render a cubalaya image link - used in the block.
 *
 * @return unknown
 */
function theme_cubalaya_image_link() {
  return l(theme('image', drupal_get_path('module', 'cubalaya') . '/images/logo_85_25.png'), 'http://www.cubalaya.co.uk', array('target'=>'_blank'), NULL, NULL, TRUE, TRUE);
}


/**
 * Theme function to attach products to a block - exposed as theme to allow sites to manipulate the output.
 *
 * @param array $products - list of product nodes.
 * @return HTML output for a set of thumbnails
 */
function theme_cubalaya_products_block($products = array()) {
  $output = '';
  foreach ($products as $node) {
    $output .= theme('cubalaya_thumbnail', $node);
  }
  return $output;
}


/**
 * Implementation of hook_nodeapi
 *
 * @param object $node - Node Object being operated on
 * @param string $op - Operation String, for example 'load'
 * @param mixed $a3 - depends on $op, see API
 * @param mixed $a4 - depends on $op, see API
 * @return mixed - depends on $op, see API
 */
function cubalaya_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
  switch ($op) {
    case 'load' :
      if ($node->type == 'cubalaya') break;
      $node_vocabs = taxonomy_get_vocabularies('cubalaya');

      $node_cubalaya_terms = array();
      foreach ($node_vocabs as $v) {
        $terms = taxonomy_node_get_terms_by_vocabulary($node->nid, $v->vid);
        $node_cubalaya_terms += $terms;
      }

      if (count($node_cubalaya_terms)) {
        $result = db_query(
          "SELECT tn.nid nid, count(*) cnt FROM {term_node} tn, node n WHERE tn.tid IN (%s) AND n.nid = tn.nid AND n.type = 'cubalaya' GROUP BY tn.nid ORDER BY cnt DESC",
          implode(", ", array_keys($node_cubalaya_terms))
        );

        $cubalaya_nodes = array();
        while ($line = db_fetch_object($result)) {
          $cubalaya_nodes[] = $line->nid;
        }

        $output['cubalaya'] = $cubalaya_nodes;
        return $output;
      }
      return array('cubalaya' => array());
    case 'view' :
      //We do this as we're only interested in getting the cubalaya block visible is we're VIEWING the node AND its in page view.
      if ($a4) {
        cubalaya_get_associate_products($node->cubalaya);
      }
  }
}


/**
 * Static cache to allow data to be passed from nodeapi to block rendering
 *
 * @param array $product_ids - Array of product Node ID's
 * @return statically cached product node ID's
 */
function cubalaya_get_associate_products($product_ids = NULL) {
  static $products = array();

  if (isset($product_ids)) {
    $products = $product_ids;
  }

  return $products;
}


function cubalaya_disable() {
  cubalaya_node_access_disabling(TRUE);
  node_access_rebuild();
}


function cubalaya_node_access_disabling($set = NULL) {
  static $disabling = false;
  if ($set !== NULL) {
    $disabling = $set;
  }
  return $disabling;
}


function cubalaya_enable() {
  node_access_rebuild();
}


function cubalaya_node_access_records($node) {
  if (cubalaya_node_access_disabling()) {
    return;
  }

  if ($node->type == 'cubalaya') {
    $grants = array();
    $grants[] = array(
      'realm' => 'cubalaya_product',
       'gid' => TRUE,
       'grant_view' => TRUE,
       'grant_update' => FALSE,
       'grant_delete' => FALSE,
      'priority' => 0,
    );

    return $grants;
  }
}


function cubalaya_node_grants($account, $op) {
  if ($op == 'view' && user_access('administer cubalaya settings', $account)) {
    $grants['cubalaya_product'] = array(1);
  }

  if (($op == 'update' || $op == 'delete') && user_access('edit private content', $account)) {
    $grants['cubalaya_product'] = array(1);
  }

  return $grants;
}