modules/banner/banner.module

<?php
// $Id: banner.module,v 1.73 2007/01/30 21:53:10 wulff Exp $

/**
 * TOC
 * Defines
 * Hook implementations
 * Page handlers
 * Menu callbacks
 * Public functions
 * Validation functions
 * Utility functions
 * Form functions
 * Theme functions
 */

// FIXME: we need a way to update the internal banner cache ($node->cache)
// FIXME: call _banner_refresh_cache when updating nodes
// FIXME: add admin notification on new banner submission
// FIXME: check that 'administer banners' role can delete/edit all banners.
// FIXME: check: only show stats to admin or banner owner
// FIXME: add banner type to admin overviews?
// FIXME: test availability of remote banner (do it when trying to get size)?
// FIXME: add help text on  admin/banner and admin/help/banner

// TODO: 'text banner', 'image banner', etc. as individual node types

// die('<pre>'. print_r($foo, true) .'</pre>');
// die('<pre>'. $foo .'</pre>');

/**
 * @file
 * Banner system for rotating ads and other content.
 */

define('BANNER_PENDING', 0);
define('BANNER_ENABLED', 1);
define('BANNER_DAY_LIMIT', 2);
define('BANNER_WEEK_LIMIT', 3);
define('BANNER_DISABLED', 4);
define('BANNER_BLOCKED', 5);
define('BANNER_DENIED', 6);

define('BANNER_UPLOAD', 0);
define('BANNER_TEXT', 1);
define('BANNER_JAVASCRIPT', 2);
define('BANNER_REMOTE', 3);

define('BANNER_CACHE_DB', 0);
define('BANNER_CACHE_FILE', 1);

/**
 * Hook implementations
 */

/**
 * Implementation of hook_access().
 */
function banner_access($op, $node) {
  global $user;

  if ($op == 'view') {
    // if the user owns this banner, let them see it
    // this is necessary because publishing status is set according to workflow
    if ($user->uid == $node->uid) {
      return TRUE;
    }
  }

  if ($op == 'create') {
    return user_access('create banners');
  }

  if ($op == 'update' || $op == 'delete') {
    if (user_access('administer banners') || ($user->uid == $node->uid)) {
      return TRUE;
    }
  }
}

/**
 * Implementation of hook_block().
 */
function banner_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
      $vid = variable_get('banner_vocabulary', 0);
      $terms = taxonomy_get_tree($vid);
      foreach($terms as $term) {
        $blocks[$term->tid]['info'] = $term->name;
      }
      return $blocks;
    case 'configure':
      $form['banner_block_'. $delta .'_count'] = array(
        '#type' => 'select',
        '#title' => t('Banner count'),
        '#default_value' => variable_get('banner_block_'. $delta .'_count', 1),
        '#options' => drupal_map_assoc(range(1, 5)),
        '#description' => t('Number of banners to show from the selected banner group.'),
      );
      return $form;
    case 'save':
      variable_set('banner_block_'. $delta .'_count', $edit['banner_block_'. $delta .'_count']);
      return;
    case 'view':
      $count = variable_get('banner_block_'. $delta .'_count', 1);
      $block['subject'] = variable_get('banner_block_'. $delta .'_title', '');
      $block['content'] = banner_display($delta, $count);
      return $block;
  }
}

/**
 * Implementation of hook_cron().
 */
function banner_cron() {
  $notifications = array();
  $time = time();

  // reset 1 day counters (1 day minus 5 minutes to prevent loosing an hour)
  if (($time - variable_get('banner_timestamp_day', '0')) >= 86100) {
    variable_set('banner_timestamp_day', $time);
    $param['reset_day_counters'] = 1;

    // add notification e-mails to the queue
    $result = db_query('SELECT n.nid, n.title, b.views_day, b.views_week, b.views, b.clicks_day, b.clicks_week, b.clicks, n.uid, b.notify_failed FROM {node} n INNER JOIN {banner} b ON n.vid = b.vid WHERE notify_day = 1 AND workflow < 4');
    while ($banner = db_fetch_object($result)) {
      $notifications[] = array(
        'subject' => variable_get('site_name', 'drupal') .':'. t("'%banner' banner daily notification", array('%banner' => "$banner->title")),
        'message' => variable_get('banner_daily_notification', _banner_get_body('daily_notify')),
        'banner' => $banner,
      );
    }

    // FIXME: only run this if the scheduler module is enabled
/*
    if (variable_get('banner_renewal', 0)) {
      // add renewal reminder e-mails to the queue
      $result = db_query('SELECT title, day_views, week_views, views, day_clicks, week_clicks, clicks, uid, unpublish_date, failed_notify, id FROM {banner} WHERE reminder_sent = 0 AND unpublish_date > 0 AND unpublish_date <= %d AND (status = 1 OR status = 2 OR status = 3 OR status = 4)', ($time + variable_get('banner_renewal_time', 0)));
      while ($banner = db_fetch_object($result)) {
        $notifications[] = array(
          'subject' => variable_get('site_name', 'drupal') .': '. t("'%banner' banner expiring soon", array('%banner' => "$banner->title")),
          'message' => variable_get('banner_renewal_message', _banner_get_body('renewal')),
          'banner' => $banner,
        );
        db_query('UPDATE {banner} SET notify_sent = 1 WHERE nid = '. $banner->nid);
      }
    }
*/
  }

  // reset 7 day counters (1 week minus 5 minutes to prevent loosing an hour)
  if (($time - variable_get('banner_timestamp_week', '0')) >= 604500) {
    variable_set('banner_timestamp_week', $time);
    $param['reset_week_counters'] = 1;

    // add notification e-mails to the queue
    $result = db_query('SELECT n.nid, n.title, b.views_day, b.views_week, b.views, b.clicks_day, b.clicks_week, b.clicks, n.uid FROM {node} n INNER JOIN {banner} b ON n.vid = b.vid WHERE notify_day = 1 AND workflow < 4');
    while ($banner = db_fetch_object($result)) {
      $notifications[] = array(
        'subject' => variable_get('site_name', 'drupal') .': '. t("'%banner' banner weekly notification", array('%banner' => "$banner->title")),
        'message' => variable_get('banner_weekly_notification', _banner_get_body('weekly_notify')),
        'banner' => $banner,
      );
    }
  }

  // limit general cron functionality to once every 5 minutes
  if (($time - variable_get('banner_timestamp_gc', '0')) >= 300) {
    variable_set('banner_timestamp_gc', $time);
    $param['refresh_cache'] = true; // we set this because we do an isset check below
  }

  // reset counters
  if (isset($param)) {
    _banner_refresh_cache($param);
  }

  // send notification e-mails
  foreach ($notifications as $notification) {
    _banner_mail($notification['subject'], $notification['message'], $notification['banner']);
  }
}

/**
 * Implementation of hook_delete().
 */
function banner_delete($node) {
  db_query('DELETE FROM {banner} WHERE nid=%d', $node->nid);
}

/**
 * Implementation of hook_form().
 */
function banner_form(&$node) {
  // general settings
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#description' => t("A name for this banner, used in administration only, e.g. 'job opening', 'product launch'."),
    '#required' => TRUE,
    '#weight' => -9,
  );
  $form['body'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $node->body,
    '#rows' => 5,
    '#description' => t('Enter a description of the banner. This will be shown in the administrator overview and on banner comment pages.'),
    '#weight' => -8,
  );

  $form['format'] = filter_form($node->format);
  $form['format']['#weight'] = -7;

  // add forms for banner settings
  $form['banner'] = _banner_form_banner($node);

  $form['notifications'] = _banner_form_notifications($node);
  $form['limits'] = _banner_form_limits($node);
  if (user_access('administer banners') && $node->nid) {
    $form['statistics'] = _banner_form_statistics($node);
  }

  return $form;
}

/**
 * Implementation of hook_form_alter().
 */
function banner_form_alter($form_id, &$form) {
  if ($form_id == 'banner_node_form') {
    // hide 'published' checkbox, status is set in hook_validate
    $form['options']['status']['#type'] = 'hidden';
  }

  // hide options from banner vocabulary editing form
  if ($form_id == 'taxonomy_form_vocabulary') {
    if ($form['vid']['#value'] == variable_get('banner_vocabulary', '')) {
      $form['help_forum_vocab'] = array(
        '#value' => t('This is the designated banner group vocabulary. Some of the normal vocabulary options have been removed.'),
        '#weight' => -1,
      );
      $form['nodes']['banner'] = array('#type' => 'checkbox', '#value' => 1, '#title' => t('banner'), '#attributes' => array('disabled' => '' ));
      unset($form['hierarchy']);
      unset($form['relations']);
      unset($form['tags']);
      unset($form['multiple']);
      $form['required'] = array('#type' => 'value', '#value' => 1);
    }
  }
}

/**
 * Implementation of hook_help().
 */
function banner_help($section) {
  switch ($section) {
    case 'admin/help#banner':
      return t("
<h2>Banner modes</h2>
<dl>
<dt>Upload</dt><dd>Use the upload mode if you want to use an uploaded image or a text file
as a banner. Enter the basic banner information and click 'File attachments' on
the node edit form. You can add as many files as you wish to your banner, but
only the first file on the list will be used. If you are uploading a text file,
the text '%url' is replaced by the banner URL (e.g. banner/7) when the banner
is displayed.</dd>
<dt>Text</dt><dd>Use the text mode if you wish to enter the banner text directly on the
node edit form. Enter the banner text in the 'Content' field. The text '%url'
is replaced by the banner URL (e.g. banner/7) when the banner is displayed.</dd>
<dt>JavaScript</dt><dd>Use the JavaScript mode if you wish to use a piece of JavaScript to
display your banner. Enter the JavaScript in the 'Content' field. This won't
support Google ads without manual modification of your site template to include
Google's JavaScript.</dd>
<dt>Remote</dt><dd>Use the remote mode to use a remote image as a banner. Enter the URL of
the remote image in the 'Content' field.</dd>
</dl>
      ");
    case 'admin/modules#description':
      return t('An advertising system.');
    case 'node/add#banner':
      return t('Banners are texts or images which are shown in fixed locations on each page.');
    case 'admin/banner':
      return '<p>'. t('This is a list of your banners.') .'</p>';
    case 'admin/settings/banner':
      return '<p>'. t('Choose banner cache and notification settings.') .'</p>';
  }
}

/**
 * Implementation of hook_insert().
 */
function banner_insert($node) {
  $fields = _banner_get_fields();
  $keys = array_keys($fields);
  foreach ($node as $key => $value) {
    if ($value && in_array($key, $keys)) {
      // this is a banner field, insert it
      $k[] = $key;
      $v[] = $value;
      $s[] = is_int($fields[$key]) ? '%d' : "'%s'";
    }
  }

  $status = _banner_get_status($node->workflow);

  // FIXME: this and the code in _menu() has race condition written all over it...
  $cache_todo = variable_get('banner_cache_todo', array());
  array_push($cache_todo, $node->nid);
  variable_set('banner_cache_todo', $cache_todo);

  db_query('INSERT INTO {banner} ('. implode(',', $k) .') VALUES ('. implode(',', $s) .')', $v);
  db_query('UPDATE {node} SET status = %d WHERE nid = %d', $status, $node->nid);
}

/**
 * Implementation of hook_load().
 */
function banner_load($node) {
  $fields = array_keys(_banner_get_fields());

  // remove nid and vid from field list
  unset($fields[0]);
  unset($fields[1]);

  $banner = db_fetch_object(db_query('SELECT '. implode(',', $fields) .' FROM {banner} WHERE vid=%d', $node->vid));
  return $banner;
}

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

  if ($may_cache) {
    // create content
    $items[] = array(
      'path' => 'node/add/banner',
      'title' => t('Banner'),
      'access' => user_access('create banners'),
    );

    // 'my banners' page
    $items[] = array(
      'path' => 'banner/view',
      'title' => t('My banners'),
      'access' => user_access('create banners'),
      'callback' => 'banner_page',
      'weight' => 1,
    );
    $items[] = array(
      'path' => 'banner/view/mine',
      'title' => t('All'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => 1,
    );
    $items[] = array(
      'path' => 'banner/view/active',
      'title' => t('Active'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 2,
    );
    $items[] = array(
      'path' => 'banner/view/enabled',
      'title' => t('Enabled'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 3,
    );
    $items[] = array(
      'path' => 'banner/view/pending',
      'title' => t('Pending'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 4,
    );
    $items[] = array(
      'path' => 'banner/view/blocked',
      'title' => t('Blocked'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 5,
    );

    // admin menu
    $items[] = array(
      'path' => 'admin/content/banner',
      'title' => t('Banners'),
      'description' => t('List and edit banners.'),
      'access' => user_access('administer banners'),
      'callback' => 'banner_admin',
    );
    $items[] = array(
      'path' => 'admin/content/banner/list',
      'title' => t('List'),
      'access' => user_access('administer banners'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -1,
    );
    $items[] = array(
      'path' => 'admin/content/banner/refresh',
      'title' => t('Refresh cache'),
      'access' => user_access('administer banners'),
      'type' => MENU_LOCAL_TASK,
      'callback' => 'banner_admin',
    );

    // settings
    $items[] = array(
      'path' => 'admin/settings/banner',
      'title' => t('Banner'),
      'description' => t('Manage banner settings.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('banner_admin_settings'),
      'access' => user_access('administer site configuration'),
    );
  }
  else {
    if (arg(0) == 'banner' && is_numeric(arg(1))) {
      // redirect
      $items[] = array(
        'path' => 'banner/'. arg(1),
        'title' => t('Banner'),
        'access' => user_access('view banners'),
        'type' => MENU_CALLBACK,
        'callback' => 'banner_redirect',
        'callback arguments' => array(arg(1)),
      );
    }

    // from http://drupal.org/node/35739
    $stylesheet = drupal_get_path('theme', $GLOBALS['theme_key'] .'/banner.css');
    if (!file_exists($stylesheet)) {
      $stylesheet = drupal_get_path('module', 'banner') .'/banner.css';
    }
    drupal_add_css($stylesheet);
  }

  // render cache content for new banners
  // FIXME: simply re-render cache for banners with empty caches (with a limit of <n> per run)
  //        this should also make it simple to add a 'clear cache' function
  $cache_todo = variable_get('banner_cache_todo', array());
  foreach ($cache_todo as $nid) {
    $node = node_load($nid);
    $cache = "document.write('". str_replace(array("'", "\n", "\r"), array("\"", " ", " "), _banner_view($node)) ."');";
    db_query("UPDATE {banner} SET cache='%s' WHERE vid=%d", $cache, $node->vid);
  }
  variable_del('banner_cache_todo');

  return $items;
}

/**
 * Implementation of hook_node_info().
 */
function banner_node_info() {
  return array(
    'banner' => array(
      'name' => t('banner'),
      'module' => 'banner',
      'description' => t('Advertising banners or other rotating content.'),
      'body_label' => t('Description'),
    )
  );
}

/**
 * Implementation of hook_nodeapi().
 */
function banner_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'delete revision':
      db_query('DELETE FROM {banner} WHERE vid=%d', $node->vid);
      break;
  }
}

/**
 * Implementation of hook_perm().
 */
function banner_perm() {
  return array('administer banners', 'create banners', 'view banners');
}

/**
 * Implementation of hook_taxonomy().
 */
function banner_taxonomy($op, $type, $term = NULL) {
  if ($op == 'delete' && $term['vid'] == variable_get('banner_vocabulary', '')) {
    switch ($type) {
      case 'vocabulary':
        variable_del('banner_vocabulary');
    }
  }
}

/**
 * Implementation of hook_validate().
 */
function banner_validate(&$node, $form) {
  // check target url
  if ($node->mode != BANNER_JAVASCRIPT) {
    if (!valid_url($node->url, TRUE)) {
      form_set_error('url', t('You must enter a valid target URL for the banner.'));
    }
  }

  // check that required content for selected mode is present
  switch ($node->mode) {
    case BANNER_UPLOAD:
      if (!is_array($node->files)) {
        form_set_error('upload', t('You need to upload at least one file to use the selected mode.'));
      }
      break;
    case BANNER_TEXT:
      if (empty($node->banner_content)) {
        form_set_error('banner_content', t('You need to enter the banner text in the content field to use the selected mode.'));
      }
      break;
    case BANNER_JAVASCRIPT:
      if (empty($node->banner_content)) {
        form_set_error('banner_content', t('You need to enter the script in the content field to use the selected mode.'));
      }
      break;
    case BANNER_REMOTE:
      if (valid_url($node->banner_content, TRUE)) {
        // Have Drupal fetch a copy of the remote file for us.
        $result = drupal_http_request($node->banner_content, array(), 'GET');
        if ($result->code == 200) { // Status: OK
          // Acquire a temporary file.
          $file = tempnam(file_directory_temp(), 'file');
          $handle = fopen($file, 'wb');
          if ($handle) {
            // Copy our data into the temporary file
            fwrite($handle, $result->data);
            fclose($handle);
            if ((list($node->width, $node->height) = getimagesize($file))) {
              form_set_value($form['banner']['width'], $node->width);
              form_set_value($form['banner']['height'], $node->height);
            }
            else {
              drupal_set_message(t('Could not determine size of remote image.'), 'error');
            }
            // Delete our temporary file
            file_delete($file);
          }
          else {
            drupal_set_message(t('Could not create temporary file while attempting to determine size of remote image.'), 'error');
          }
        }
        else {
          drupal_set_message(t('Could not determine size of remote image: Unexpected response from remote webserver.'), 'error');
        }
      }
      else {
        form_set_error('banner_content', t('You need to enter a valid URL in the content field to use the selected mode.'));
      }
      break;
  }

  // get information from uploaded file
  if ($node->files) {
    foreach ($node->files as $file) {
      $file = (object)$file;

      if (!isset($active)) {
        // we use the first file on the list...
        $active = $file;
      }

      // ...and make sure that no files are listed
      $file->list = 0;
    }

    switch (_banner_type($file->filemime)) {
      case 'image':
      case 'swf':
        list($width, $height) = getimagesize($file->filepath);
        form_set_value($form['banner']['width'], $width);
        form_set_value($form['banner']['height'], $height);
        break;
      case 'text':
        break;
      default:
        form_set_error('upload', t('Unsupported file type.'));
    }
  }
}

/**
 * Implementation of hook_view().
 */
function banner_view(&$node, $teaser = FALSE, $page = FALSE) {
  global $user;

  $node = node_prepare($node, $teaser);

  $output = '';
  switch ($node->mode) {
    case BANNER_UPLOAD:
      $output .= theme('banner_view_upload', $node);
      break;
    case BANNER_TEXT:
      $output .= '<blockquote>';
      $output .= theme('banner_view_text', $node);
      $output .= '</blockquote>';
      break;
    case BANNER_JAVASCRIPT:
      $output .= theme('banner_view_javascript', $node); // FIXME: theme function missing?
      break;
    case BANNER_REMOTE:
      $output .= theme('banner_view_remote', $node);
  }

  if ($teaser == TRUE) {
    if (user_access('administer banners') || (user_access('create banners') && $user->uid == $node->uid)) {
      $output .= _banner_view_statistics($node);
    }

//    $node->teaser .= $output;
    $node->banner_content['teaser']['#value'] .= $output;
  }
  else {
    if (user_access('administer banners') || (user_access('create banners') && $user->uid == $node->uid)) {
      // don't show full info on node preview
      if ($node->nid) {
        $output .= _banner_view_overview($node);
        $output .= _banner_view_statistics($node);
        $output .= _banner_view_limits($node);

        // if (module_exists('scheduler')) {} // FIXME: display scheduling information

        $output .= _banner_view_notifications($node);
      }
    }

    $node->banner_content['banner_body'] = array(
      '#value' => $output,
      '#weight' => 1,
    );
  }

  return $node;
}

/**
 * Implementation of hook_update().
 */
function banner_update($node) {
  // FIXME: if limits have changed, update workflow & status to match - do it here to catch revisions

  if ($node->revision) {
    banner_insert($node);
  }
  else {
    $fields = _banner_get_fields();
    $keys = array_keys($fields);

    $node->cache = "document.write('". str_replace(array("'", "\n", "\r"), array("\"", " ", " "), _banner_view($node)) ."');";

    foreach ($node as $key => $value) {
      if (in_array($key, $keys)) {
        // this is a banner field, update it
        $param = $key;
        $param .= is_int($fields[$key]) ? '=%d' : "='%s'";
        $q[] = $param;
        if ($value) {
          $v[] = $value;
        }
        else {
          $v[] = $fields[$key];
        }
      }
    }
    $v[] = $node->vid;

    $status = _banner_get_status($node->workflow);

    db_query('UPDATE {banner} SET '. implode(',', $q) .' WHERE vid=%d', $v);
    db_query('UPDATE {node} SET status = %d WHERE nid = %d', $status, $node->nid);

    // reset stats if requested
    if ($node->reset_day) {
      db_query('UPDATE {banner} SET views_day=0, clicks_day=0 WHERE vid=%d', $v, $node->vid);
    }
    if ($node->reset_week) {
      db_query('UPDATE {banner} SET views_week=0, clicks_week=0 WHERE vid=%d', $v, $node->vid);
    }
    if ($node->reset_total) {
      db_query('UPDATE {banner} SET views=0, clicks=0 WHERE vid=%d', $v, $node->vid);
    }
  }
}

/**
 * Page handlers
 */

/**
 * Page handler for admin page
 */
function banner_admin() {
  $op = arg(2);

  switch ($op) {
    case 'refresh':
      $output = _banner_admin_refresh();
      break;
    default: // list
      $output = _banner_admin_overview();
  }

  return $output;
}

/**
 * Page handler for settings page
 */
function banner_admin_settings() {
  // FIXME: reset number of cache files (see original module) -- but do it in a _validate function

  // check for required modules
  $requirements = '';
  if (!module_exists('upload')) {
    $requirements .= '<p>'. t('The <a href="@url">upload module</a> must be enabled and configured if you wish to use uploaded images or text files as banners.', array('@url' => 'http://drupal.org/handbook/modules/upload')) .'</p>';
  }
  if (!module_exists('scheduler')) {
    $requirements .= '<p>'. t('The <a href="@url">scheduler module</a> must be installed and configured if you wish to set publishing and unpublishing dates for banners.', array('@url' => 'http://drupal.org/project/scheduler')) .'</p>';
  }
  if (!module_exists('taxonomy')) {
    $requirements .= '<p>'. t('The <a href="@url">taxonomy module</a> must be installed and configured.', array('@url' => 'http://drupal.org/handbook/modules/taxonomy')) .'</p>';
  }

  if (!empty($requirements)) {
    $form['requirements'] = array(
      '#type' => 'fieldset',
      '#title' => t('Requirements'),
    );
    $form['requirements']['scheduler'] = array(
      '#type' => 'markup',
      '#value' => $requirements,
    );
  }

  $mail_variables = '%username, %bannername, %sitename, %day_views, %day_clicks, %week_views, %week_clicks, %total_views, %total_clicks, %url, %expire';

  // cache settings
  $form['cache'] = array(
    '#type' => 'fieldset',
    '#title' => t('Cache settings'),
  );
  $form['cache']['banner_cache'] = array(
    '#type' => 'radios',
    '#title' => t('Cache handler'),
    '#default_value' => variable_get('banner_cache', 0),
    '#options' => array(
       BANNER_CACHE_DB   => t('database'),
       BANNER_CACHE_FILE => t('file'),
    ),
    '#description' => t('Choose a cache handler. Database caching has lower performance but always works.'),
    '#validate' => array('_banner_validate_cache' => array()),
  );
  $form['cache']['banner_cache_max'] = array(
    '#type' => 'select',
    '#title' => t('Maximum cache files'),
    '#default_value' => variable_get('banner_cache_max', 1),
    '#options' => drupal_map_assoc(array(1, 2, 3, 4, 5, 10, 25)),
    '#description' => t('If using the file cache handler, specify here the maximum number of cache files that should be created. Using only one cache file guarantees that banners will be disabled exactly when they cross a threshold such as being displayed the maximum allowed number of times. On busier sites, it can boost performance to use multiple cache files.'),
  );

  // user notification settings
  $form['notification'] = array(
    '#type' => 'fieldset',
    '#title' => t('User notification settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['notification']['banner_daily_notification'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of daily notification e-mail'),
    '#default_value' => variable_get('banner_daily_notification', _banner_get_body('daily_notify')),
    '#cols' => 70,
    '#rows' => 10,
    '#description' => t('Customize the body of the daily notification e-mail, only sent to banner owners when they enable daily notification. Available variables are: %mail_variables.', array('%mail_variables' => $mail_variables)),
  );
  $form['notification']['banner_weekly_notification'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of weekly notification e-mail'),
    '#default_value' => variable_get('banner_weekly_notification', _banner_get_body('weekly_notify')),
    '#cols' => 70,
    '#rows' => 10,
    '#description' => t('Customize the body of the weekly notification e-mail, only sent to banner owners when they enable weekly notification. Available variables are: %mail_variables.', array('%mail_variables' => $mail_variables)),
  );
  $form['notification']['banner_failed_notify'] = array(
    '#type' => 'select',
    '#title' => t('Disable notifications'),
    '#default_value' => variable_get('banner_failed_notify', 5),
    '#options' => array(t('Disabled'), 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20),
    '#description' => t('Disable notifications to user after this many failed mail attempts.'),
  );

  // reminder settings
  $form['reminder'] = array(
    '#type' => 'fieldset',
    '#title' => t('Renewal reminder settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['reminder']['banner_renewal'] = array(
    '#type' => 'radios',
    '#title' => t('Automatic renewal reminder'),
    '#default_value' => variable_get('banner_renewal', 0),
    '#options' => array(t('Disabled'), t('Enabled')),
    '#description' => t('If enabled, an automatic reminder can be e-mailed when an advertisement is about to expire. This e-mail can remind your customers that they need to renew their advertisement on your site.'),
  );
  $form['reminder']['banner_renewal_time'] = array(
    '#type' => 'select',
    '#title' => t('Send reminder'),
    '#default_value' => variable_get('banner_renewal_time', 0),
    '#options' => _banner_get_periods(),
    '#description' => t('Send the renewal reminder this long before the advertisement expires.'),
  );
  $form['reminder']['banner_renewal_message'] = array(
    '#type' => 'textarea',
    '#title' => t('Body of renewal reminder e-mail'),
    '#default_value' => variable_get('banner_renewal_message', _banner_get_body('renewal')),
    '#cols' => 70,
    '#rows' => 10,
    '#description' => t('Customize the body of the renewal reminder e-mail, only sent once to banner owners when their ad is about to expire. Available variables are: %mail_variables', array('%mail_variables' => $mail_variables)),
  );

  return system_settings_form($form);
}

/**
 * Page handler for 'my banners' page
 */
function banner_page() {
  global $user;

  // get latest versions of the banner node
  $query = 'SELECT n.nid FROM {node} n INNER JOIN {banner} b ON n.vid=b.vid WHERE n.uid='. $user->uid;
  switch (arg(2)) {
    case 'active':
      $active = array(BANNER_PENDING, BANNER_ENABLED, BANNER_DAY_LIMIT, BANNER_WEEK_LIMIT, BANNER_DISABLED);
      $query .= ' AND b.workflow IN ('. implode(',', $active) .')';
      break;
    case 'enabled':
      $query .= ' AND b.workflow='. BANNER_ENABLED;
      break;
    case 'pending':
      $query .= ' AND b.workflow='. BANNER_PENDING;
      break;
    case 'blocked':
      $query .= ' AND b.workflow='. BANNER_BLOCKED;
      break;
    default: // 'mine'
  }
  $query .= ' ORDER BY n.sticky DESC, n.created DESC';

  $result = pager_query(db_rewrite_sql($query), variable_get('default_nodes_main', 10));

  $output = '';
  if (db_num_rows($result)) {
    while ($node = db_fetch_object($result)) {
      $output .= node_view(node_load($node->nid), TRUE);
    }
    $output .= theme('pager', NULL, variable_get('default_nodes_main', 10));
  }
  else {
    $output .= theme('box', t('No banners found.'), '');
  }

  return $output;
}

/**
 * Menu callbacks
 */

/**
 * Update banner statistics and redirect user to target URL
 */
function banner_redirect() {
  global $user;

  $banner = node_load(arg(1));

  if ($banner) {
    // don't update banner stats for site admin or banner owner
    if ($user->uid != 1 && $user->uid != $banner->uid) {
      db_query('UPDATE {banner} SET clicks = clicks + 1, clicks_day = clicks_day + 1, clicks_week = clicks_week + 1 WHERE nid = %d', arg(1));
    }

    if ($banner->clicks_max > 0 && ($banner->clicks + 1) == $banner->clicks_max) {
      watchdog('special', t("banner: '%banner' %status, reached max of %clicks clicks.", array('%banner' => l($banner->title, 'node/'. $banner->id, NULL, NULL, FALSE, TRUE), '%status' => _banner_workflow(BANNER_BLOCKED), '%clicks' => $banner->max_clicks)));
      db_query('UPDATE {banner} SET workflow = %d WHERE vid = %d', BANNER_BLOCKED, $banner->vid);
//      _banner_refresh_cache(); // FIXME
    }

    // redirect to the banner's target url
    header('Location: '. $banner->url);
    exit();
  }
  else {
    drupal_not_found();
  }
}

/**
 * Public functions
 */

/**
 * Display one or more banners from the selected group.
 *
 * @param $group
 *   The banner group to display
 * @param $count
 *   The number of banners to show from the selected group
 * @return
 *   <script> tag for use in HTML
 */
function banner_display($group = 0, $count = 1) {
  global $base_url;

  if (user_access('view banners')) {
    $files = array('banner_db.php', 'banner_file.php');
    $tids = array();

    // Do we have *any* banners in this group?
    $banners = db_result(db_query("SELECT COUNT(*) FROM {node} n INNER JOIN {term_node} tn on n.nid = tn.nid INNER JOIN {banner} b ON b.nid = n.nid WHERE n.type = 'banner' AND tn.tid = %d AND b.workflow = %d", $group, BANNER_ENABLED));
    if($banners == 0) {
      return;
    }

    // only do taxonomy checking on nodes
    if (arg(0) == 'node' && is_numeric(arg(1))) {
      // get vocabularies associated with banners
      $vocabularies = taxonomy_get_vocabularies('banner');

      // ...but ignore the banner group vocabulary
      $vid = variable_get('banner_vocabulary', '');
      unset($vocabularies[$vid]);

      // get terms from current node associated with these vocabs
      foreach($vocabularies as $vocabulary) {
        if($terms = taxonomy_node_get_terms_by_vocabulary(arg(1), $vocabulary->vid)) {
          foreach ($terms as $term) {
            $tids[] = $term->tid;
          }
        }
      }
    }

    // see if we have any banners in the current group with one of these terms
    $comp = array();
    $result = db_query('SELECT tn2.tid FROM {node} n INNER JOIN {term_node} tn ON n.nid = tn.nid INNER JOIN {term_node} tn2 ON n.nid = tn2.nid INNER JOIN {banner} b ON n.vid = b.vid WHERE tn.tid = %d AND b.workflow = 1', $group);
    while ($row = db_fetch_array($result)) {
      $comp[] = $row['tid'];
    }

    $tids = array_intersect($tids, $comp);
    if (!$tids) {
      $tids[] = 0;
    }

    $url = $base_url .'/'. $files[variable_get('banner_cache', '0')];
    $qry = array(
      'group' => $group,
      'count' => $count,
      'terms' => implode(',', $tids),
      'max' => variable_get('banner_cache_max', 1),
      'path' => file_create_path(),
    );
    foreach ($qry as $key => $value) {
      $query[] = $key .'='. $value;
    }
    $source = url($url, implode('&amp;', $query));

    // FIXME: do something else for javascript banners?
    return '<script type="text/javascript" src="'. $source .'"></script>';
  }
}

/**
 * Validation functions
 */

/**
 * Make sure that the selected cache driver is present
 */
function _banner_validate_cache($form) {
  global $form_values;

  $cache_type = $form_values['banner_cache'];
  $filename = $cache_type ? 'banner_file.php' : 'banner_db.php';
  if (file_exists($filename)) {
    $output = @file_get_contents($filename);
    if (!$output) {
      form_set_error('banner_cache', t('Failed to access "%filename" due to improper file permissions. Unable to display banners.', array('%filename' => $filename)));
    }
  }
  else {
    form_set_error('banner_cache', t('Failed to access "%filename", file does not exist. Unable to display banners.', array('%filename' => $filename)));
  }
}

/**
 * Utility functions
 */

/**
 * Show list of all banners
 */
function _banner_admin_overview() {
  $headers = array(
    array('data' => t('Title'), 'field' => 'title'),
    array('data' => t('Status'), 'field' => 'workflow', 'sort' => 'asc'),
    array('data' => t('Owner'), 'field' => 'uid'),
    array('data' => t('Views'), 'field' => 'views'),
    array('data' => t('Clicks'), 'field' => 'clicks'),
    array('data' => t('Operations'), 'colspan' => 2)
  );

  $sql = 'SELECT n.*, b.*, u.name FROM {node} n INNER JOIN {banner} b ON n.vid=b.vid INNER JOIN {users} u ON n.uid=u.uid';
  $sql .= tablesort_sql($headers);

  $result = pager_query($sql, 25);

  if (db_num_rows($result) > 0) {
    $destination = drupal_get_destination();
    while ($node = db_fetch_object($result)) {
      $row = array();

      $row[] = $node->title;
      $row[] = _banner_workflow($node->workflow);
      $row[] = theme('username', $node);
      $row[] = $node->views;
      $row[] = $node->clicks;
      $row[] = array('data' => l(t('view'), 'node/'. $node->nid));
      $row[] = array('data' => l(t('edit'), 'node/'. $node->nid .'/edit', array(), $destination));

      $rows[] = $row;
    }
    if($pager = theme('pager', NULL, 25, 0)) {
      $rows[] = array(array('data' => $pager, 'colspan' => 9));
    }

    return theme('table', $headers, $rows);
  }
  else {
    return theme('box', t('No banners found.'), '');
  }
}

/**
 * Refresh banner cache
 */
function _banner_admin_refresh($param = array(), $max = 0) {
  $cache_type = variable_get('banner_cache', '0');

  if ($cache_type == BANNER_CACHE_FILE) {
    _banner_refresh_cache();
    drupal_set_message(t('File cache refreshed.'), 'status');
  }
  else {
    drupal_set_message(t("You are using the database cache. The database cache can't be refreshed."), 'error');
    drupal_goto('admin/banner');
  }

  return '';
}

/**
 * Return message body
 */
function _banner_get_body($message) {
  switch ($message) {
    case 'daily_notify':
      return t("Hello %username,\n\nHere is your daily summary for your '%bannername' banner on %sitename:\n\nToday:\n   Views:  %day_views\n   Clicks: %day_clicks\n\nThis week:\n   Views:  %week_views\n   Clicks: %week_clicks\n\nAll time:\n   Views:  %total_views\n   Clicks: %total_clicks\n\n--\nThis e-mail was automatically generated at your request.\nUnsubscribe here: %url");
    case 'weekly_notify':
      return t("Hello %username,\n\nHere is your weekly summary for your '%bannername' banner on %sitename:\n\nToday:\n   Views:  %day_views\n   Clicks: %day_clicks\n\nThis week:\n   Views:  %week_views\n   Clicks: %week_clicks\n\nAll time:\n   Views:  %total_views\n   Clicks: %total_clicks\n\n--\nThis e-mail was automatically generated at your request.\nUnsubscribe here: %url");
    case 'renewal':
      return t("Hello %username,\n\nYour advertisement '%bannername' on %sitename will expire on %expire. Please let us know if you are interested in renewing.\n\nTo date, this ad has been viewed %total_views times and clicked %total_clicks times.\n\nThank you!\n%sitename team");
    case 'upload_notify':
      return t("Hello %admin,\n\n%sitename user '%username' has uploaded a new banner titled, '%bannername'.\n\n%pending_url");
  }
}

/**
 * Return an array of banner database fields
 */
function _banner_get_fields() {
  return array(
    'nid' => 0,
    'vid' => 0,

    // basic information
    'url' => '',
    'target' => '',
    'workflow' => 0,
    'mode' => 0,
    'banner_content' => '',
    'cache' => '',

    // notifications
    'notify_day' => 0,
    'notify_week' => 0,
    'notify_failed' => 0,
    'notify_send' => 0,
    'notify_sent' => 0,

    // limits
    'chance' => 0,
    'clicks_max' => 0,
    'views_max' => 0,
    'views_week_max' => 0,
    'views_day_max' => 0,

    // statistics
    'views' => 0,
    'views_week' => 0,
    'views_day' => 0,
    'clicks' => 0,
    'clicks_week' => 0,
    'clicks_day' => 0,

    // file
    'width' => 0,
    'height' => 0,
  );
}

/**
 * Return description of banner status.
 */
function _banner_get_mode_options() {
  $modes = array();

  if (user_access('upload files')) {
    $modes[BANNER_UPLOAD] = t('upload');
  }
  $modes[BANNER_TEXT] = t('text');
  if (user_access('administer banners')) {
    $modes[BANNER_JAVASCRIPT] = t('javascript');
  }
  $modes[BANNER_REMOTE] = t('remote');

  return $modes;
}

/**
 * Return an array of reminder periods
 */
function _banner_get_periods() {
  return array(
      86400 => format_interval(86400),
     172800 => format_interval(172800),
     259200 => format_interval(259200),
     345600 => format_interval(345600),