rate_expiration.module in Rate 7

File

expiration/rate_expiration.module

<?php

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Add configuration options to the widget form.
 */
function rate_expiration_form_rate_widget_form_alter(&$form, &$form_state) {
  if (isset($form['error'])) {

    // Do not add our fields on forms with an error.
    return;
  }
  if (!empty($form['#widget_id'])) {
    $widgets = variable_get(RATE_VAR_WIDGETS, array());
    $widget = $widgets[$form['#widget_id']];
  }
  else {
    $widget = new stdClass();
  }
  $form['expiration'] = array(
    '#type' => 'fieldset',
    '#title' => t('Expiration settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $options = array(
    -1 => t('Never'),
  ) + drupal_map_assoc(array(
    300,
    900,
    1800,
    3600,
    10800,
    21600,
    32400,
    43200,
    86400,
    172800,
    345600,
    604800,
    1209600,
    1814400,
    2419200,
  ), 'format_interval');
  $form['expiration']['expiration'] = array(
    '#type' => 'select',
    '#title' => t('Disable voting after this period'),
    '#options' => $options,
    '#default_value' => isset($widget->expiration) ? $widget->expiration : -1,
    '#description' => t('Time that has to elapse after creating a node before voting is disabled.'),
  );
  $form['expiration']['expiration_allow_override'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow override'),
    '#default_value' => isset($widget->expiration_allow_override) ? $widget->expiration_allow_override : FALSE,
    '#description' => t('When enabled, the expiration date can be customized in the node edit screen.'),
  );
}

/**
 * Implements hook_rate_widget_insert().
 */
function rate_expiration_rate_widget_insert($widget, $values) {
  $widget->expiration = $values['expiration'];
  $widget->expiration_allow_override = !empty($values['expiration_allow_override']);
}

/**
 * Implements hook_rate_widget_update().
 */
function rate_expiration_rate_widget_update($widget, $values) {
  $widget->expiration = $values['expiration'];
  $widget->expiration_allow_override = !empty($values['expiration_allow_override']);
}

/**
 * Implements hook_rate_widget_alter().
 */
function rate_expiration_rate_widget_alter($widget, $context) {
  extract($context);

  // Introduces $content_type and $content_id
  switch ($content_type) {
    case 'node':
      $node = node_load($content_id);
      break;
    case 'comment':
      if ($comment = comment_load($content_id)) {
        $node = node_load($comment->nid);
      }
      break;
  }
  if (isset($node)) {
    $configuration = _rate_expiration_get_node_values($node->nid);
    if (isset($configuration[$widget->name])) {
      $start = $configuration[$widget->name]->start;
      $end = $configuration[$widget->name]->end;
    }
    else {
      $start = 0;
      $end = 0;
    }
    isset($widget->expiration) or $widget->expiration = 0;
    if ($widget->expiration > 0) {
      !empty($end) or $end = $node->created + $widget->expiration;
    }
    if ($end > 0 && $end <= REQUEST_TIME || $start > 0 && $start > REQUEST_TIME) {
      $widget->mode = RATE_CLOSED;
    }
  }
}

/**
 * Get configuration for a widgets on a given node.
 */
function _rate_expiration_get_node_values($nid) {
  static $cache = array();
  if (isset($cache[$nid])) {
    return $cache[$nid];
  }
  $output = array();
  $sql = 'SELECT re.widget_name, re.start, re.end
  FROM {rate_expiration} re
  WHERE nid = :nid';
  $result = db_query($sql, array(
    ':nid' => $nid,
  ));
  foreach ($result as $record) {
    $output[$record->widget_name] = $record;
  }
  $cache[$nid] = $output;
  return $output;
}

/**
 * Implements hook_form_alter().
 *
 * Add the date selection to the node form.
 */
function rate_expiration_form_alter(&$form, &$form_state, $form_id) {
  if (!preg_match('/_node_form$/', $form_id)) {
    return;
  }
  $node = $form['#node'];

  // Get active rate widgets and filter widgets without the "allow override" option..
  $widgets = rate_get_active_widgets('node', $node->type);
  $widgets = array_filter($widgets, '_rate_expiration_filter_widgets');
  if (!$widgets) {

    // There no widgets for this nodetype with the "allow override" option.
    return;
  }

  // Get default values for all widgets.
  $defaults = empty($node->nid) ? array() : _rate_expiration_get_node_values($node->nid);
  foreach ($widgets as $widget) {
    if (isset($defaults[$widget->name])) {
      $startdate = $defaults[$widget->name]->start;
      $enddate = $defaults[$widget->name]->end;
    }
    else {
      $startdate = empty($node->created) ? REQUEST_TIME : $node->created;
      $enddate = NULL;

      // Decrement startdate to prevent voting from being disabled a few minutes after node
      // creation (may happen cause the date increment of 5 minutes).
      $startdate -= 180;
    }
    $container = 'rate_expiration_' . $widget->name;
    $form[$container] = array(
      '#type' => 'fieldset',
      '#title' => t('Expiration for %name widget', array(
        '%name' => $widget->title,
      )),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form[$container]["{$container}_begin"] = array(
      '#type' => 'date_select',
      '#title' => t('Enable voting'),
      '#description' => t('Leave empty to disable startdate.'),
      '#default_value' => $startdate ? format_date($startdate, 'custom', 'Y-m-d H:i:s') : NULL,
      '#date_increment' => 5,
    );
    $form[$container]["{$container}_end"] = array(
      '#type' => 'date_select',
      '#title' => t('Close voting on'),
      '#description' => $widget->expiration > 0 ? t('Leave empty to allow for @interval after node creation', array(
        '@interval' => format_interval($widget->expiration),
      )) : t('Leave empty to allow forever.'),
      '#default_value' => $enddate ? format_date($enddate, 'custom', 'Y-m-d H:i:s') : NULL,
      '#date_increment' => 5,
    );
  }
}

/**
 * Array_filter() callback. Filter widgets without the allow_override option.
 */
function _rate_expiration_filter_widgets($item) {
  return !empty($item->expiration_allow_override);
}

/**
 * Implements hook_node_insert().
 */
function rate_expiration_node_insert($node) {
  global $user;
  $timezone = is_null($user->timezone) ? variable_get('date_default_timezone', 0) : $user->timezone;
  if (!is_numeric($timezone)) {

    // Convert textual timezone to numeric offset.
    $timezone = new DateTimeZone($timezone);
    $timezone = $timezone
      ->getOffset(new DateTime('now', $timezone));
  }

  // Get active rate widgets and filter widgets without the "allow override" option..
  $widgets = rate_get_active_widgets('node', $node->type);
  $widgets = array_filter($widgets, '_rate_expiration_filter_widgets');
  foreach ($widgets as $widget) {
    $timezone = is_null($user->timezone) ? variable_get('date_default_timezone', 0) : $user->timezone;
    $container = 'rate_expiration_' . $widget->name;
    $begin = "{$container}_begin";
    $end = "{$container}_end";
    $begin = $node->{$begin} ? (int) strtotime($node->{$begin} . 'Z') - $timezone : 0;
    $end = $node->{$end} ? (int) strtotime($node->{$end} . 'Z') - $timezone : 0;

    // Correct empty dates which are not 0 cause of timezone handling.
    $begin = $begin <= 86400 ? 0 : $begin;
    $end = $end <= 86400 ? 0 : $end;
    if (!empty($begin) || !empty($end)) {
      db_insert('rate_expiration')
        ->fields(array(
        'nid' => $node->nid,
        'widget_name' => $widget->name,
        'start' => $begin,
        'end' => $end,
      ))
        ->execute();
    }
  }
}

/**
 * Implements hook_node_update().
 */
function rate_expiration_node_update($node) {
  global $user;
  $timezone = is_null($user->timezone) ? variable_get('date_default_timezone', 0) : $user->timezone;
  if (!is_numeric($timezone)) {

    // Convert textual timezone to numeric offset.
    $timezone = new DateTimeZone($timezone);
    $timezone = $timezone
      ->getOffset(new DateTime('now', $timezone));
  }

  // Get active rate widgets and filter widgets without the "allow override" option..
  $widgets = rate_get_active_widgets('node', $node->type);
  $widgets = array_filter($widgets, '_rate_expiration_filter_widgets');
  foreach ($widgets as $widget) {
    $container = 'rate_expiration_' . $widget->name;
    $begin = "{$container}_begin";
    $end = "{$container}_end";
    $begin = $node->{$begin} ? (int) strtotime($node->{$begin} . 'Z') - $timezone : 0;
    $end = $node->{$end} ? (int) strtotime($node->{$end} . 'Z') - $timezone : 0;

    // Correct empty dates which are not 0 cause of timezone handling.
    $begin = $begin <= 86400 ? 0 : $begin;
    $end = $end <= 86400 ? 0 : $end;
    if (empty($begin) && empty($end)) {
      db_delete('rate_expiration')
        ->condition('nid', $node->nid)
        ->condition('widget_name', $widget->name)
        ->execute();
    }
    else {
      $exists = db_select('rate_expiration', 're')
        ->fields('re', array(
        'start',
        'end',
      ))
        ->condition('re.nid', $node->nid)
        ->condition('re.widget_name', $widget->name)
        ->countQuery()
        ->execute()
        ->fetchField();
      if ($exists) {
        db_update('rate_expiration')
          ->fields(array(
          'start' => $begin,
          'end' => $end,
        ))
          ->condition('nid', $node->nid)
          ->condition('widget_name', $widget->name)
          ->execute();
      }
      else {
        db_insert('rate_expiration')
          ->fields(array(
          'nid' => $node->nid,
          'widget_name' => $widget->name,
          'start' => $begin,
          'end' => $end,
        ))
          ->execute();
      }
    }
  }
}

/**
 * Implements hook_node_delete().
 */
function rate_expiration_node_delete($node) {
  db_delete('rate_expiration')
    ->condition('nid', $node->nid)
    ->execute();
}

Functions

Name	Description
rate_expiration_form_alter	Implements hook_form_alter().
rate_expiration_form_rate_widget_form_alter	Implements hook_form_FORM_ID_alter().
rate_expiration_node_delete	Implements hook_node_delete().
rate_expiration_node_insert	Implements hook_node_insert().
rate_expiration_node_update	Implements hook_node_update().
rate_expiration_rate_widget_alter	Implements hook_rate_widget_alter().
rate_expiration_rate_widget_insert	Implements hook_rate_widget_insert().
rate_expiration_rate_widget_update	Implements hook_rate_widget_update().
_rate_expiration_filter_widgets	Array_filter() callback. Filter widgets without the allow_override option.
_rate_expiration_get_node_values	Get configuration for a widgets on a given node.