votingapi.drush.inc in Voting API 7.3

Generate votingapi votes, recalculate results for existing votes, or flush VotingAPI data entirely.

File

votingapi.drush.inc

<?php

/**
 * @file
 *  Generate votingapi votes, recalculate results for existing votes, or flush
 *  VotingAPI data entirely.
 */

/**
 * Implements of hook_drush_help().
 */
function votingapi_drush_help($section) {
  switch ($section) {
    case 'drush:generate-votes':
      return dt('Usage: drush generate-votes <entity_type> <vote_type>.');
    case 'drush:votingapi-recalculate':
      return dt('Usage: drush votingapi-recalculate <entity_type>.');
    case 'drush:votingapi-flush':
      return dt('Usage: drush votingapi-flush <entity_type>.');
  }
}

/**
 * Implements of hook_drush_command().
 */
function votingapi_drush_command() {
  $items['generate-votes'] = array(
    'description' => 'Creates dummy voting data.',
    'arguments' => array(
      'entity_type' => 'The type of entity to generate votes for.',
      'vote_type' => 'The type of votes to generate, defaults to \'percent\'.',
    ),
    'drupal dependencies' => array(
      'devel_generate',
    ),
    'options' => array(
      'kill' => 'Specify \'kill\' to delete all existing votes before generating new ones.',
      'age' => 'The maximum age, in seconds, of each vote.',
      'node_types' => 'A comma delimited list of node types to generate votes for, if the entity type is \'node\'.',
    ),
    'aliases' => array(
      'genv',
    ),
  );
  $items['votingapi-recalculate'] = array(
    'description' => 'Regenerates voting results from raw vote data.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_LOGIN,
    // Various D7 code assumes we have a uid.
    'arguments' => array(
      'entity_type' => 'The type of entity to recalculate vote results for.',
    ),
    'aliases' => array(
      'vcalc',
    ),
  );
  $items['votingapi-flush'] = array(
    'description' => 'Deletes all existing voting data.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_LOGIN,
    // Various D7 code assumes we have a uid.
    'arguments' => array(
      'entity_type' => 'The type of entity whose voting data should be flushed.',
    ),
    'aliases' => array(
      'vflush',
    ),
  );
  return $items;
}

/**
 * Command callback. Generate a number of votes.
 */
function drush_votingapi_generate_votes($entity_type = 'node', $vote_type = 'percent') {
  $options = array(
    'kill' => drush_get_option('kill'),
    'age' => drush_get_option('age'),
    'types' => drush_get_option('types'),
  );
  votingapi_generate_votes($entity_type, $vote_type, $options);
  drush_log(t('Generating @vtype votes for @etype entities.', array(
    '@vtype' => $vote_type,
    '@etype' => $entity_type,
  )), 'success');
}

/**
 * Utility function to generate votes.
 */
function votingapi_generate_votes($entity_type = 'node', $vote_type = 'percent', $options = array()) {
  module_load_include('inc', 'devel_generate');
  $options += array(
    'age' => 36000,
    'types' => array(),
    'kill' => FALSE,
  );
  if (!empty($options['kill_votes'])) {
    db_truncate('votingapi_vote');
    db_truncate('votingapi_cache');
  }
  if (($schema = drupal_get_schema($entity_type)) && ($entity_id_column = array_shift($schema['primary key']))) {

    // oh look we found a schema yay
  }
  else {
    $entity_type = 'node';
    $entity_id_column = 'nid';
  }
  $uids = devel_get_users();
  $query = db_select($entity_type, 'e')
    ->fields('e', array(
    $entity_id_column,
  ));
  if ($entity_type == 'node' && !empty($options['types'])) {
    $query
      ->condition('e.type', $options['types'], 'IN');
  }
  $results = $query
    ->execute()
    ->fetchAll(PDO::FETCH_ASSOC);
  foreach ($results as $entity) {
    _votingapi_cast_votes($entity_type, $entity[$entity_id_column], $options['age'], $uids, $vote_type);
  }
}

/**
 * Utility function to generate votes on a node by a set of users.
 */
function _votingapi_cast_votes($etype, $eid, $timestamp = 0, $uids = array(), $style = 'percent') {
  $votes = array();
  static $tags;
  if (!isset($tags)) {
    $tags = explode(' ', devel_create_greeking(30));
  }
  foreach ($uids as $uid) {
    switch ($style) {
      case 'percent':
        $votes[] = array(
          'uid' => $uid,
          'entity_type' => $etype,
          'entity_id' => $eid,
          'value_type' => 'percent',
          'timestamp' => REQUEST_TIME - mt_rand(0, $timestamp),
          'value' => mt_rand(1, 5) * 20,
          'tag' => $tags[mt_rand(0, 30)],
        );
        break;
      case 'points':
        if (rand(0, 3)) {
          $votes[] = array(
            'uid' => $uid,
            'entity_type' => $etype,
            'entity_id' => $eid,
            'value_type' => 'points',
            'timestamp' => REQUEST_TIME - mt_rand(0, $timestamp),
            'value' => rand(0, 1) ? 1 : -1,
          );
        }
        break;
    }
  }
  votingapi_set_votes($votes, array());
}

/**
 * Command callback. Recalculate voting results.
 */
function drush_votingapi_recalculate($entity_type = 'node', $entity_id = NULL) {

  // Prep some starter query objects.
  $data = array();
  if (empty($entity_id)) {
    $votes = db_select('votingapi_vote', 'vv')
      ->fields('vv', array(
      'entity_type',
      'entity_id',
    ))
      ->condition('entity_type', $entity_type, '=')
      ->distinct(TRUE)
      ->execute()
      ->fetchAll(PDO::FETCH_ASSOC);
    $message = t('Rebuilt voting results for @type votes.', array(
      '@type' => $entity_type,
    ));
  }
  else {
    $votes[] = array(
      'entity_type' => $entity_type,
      'entity_id' => $entity_id,
    );
    $message = t('Rebuilt all voting results.');
  }
  foreach ($votes as $vote) {
    votingapi_recalculate_results($vote['entity_type'], $vote['entity_id'], TRUE);
  }
  drush_log($message, 'success');
}

/**
 * Command callback. Flush votes and results.
 */
function drush_votingapi_flush($entity_type = NULL, $entity_id = NULL) {
  if (drush_confirm(dt("Delete @type voting data?", array(
    '@type' => empty($entity_type) ? dt('all') : $entity_type,
  )))) {
    $cache = db_delete('votingapi_cache');
    $votes = db_delete('votingapi_vote');
    if (!empty($entity_type)) {
      $cache
        ->condition('entity_type', $entity_type);
      $votes
        ->condition('entity_type', $entity_type);
    }
    if (!empty($entity_id)) {
      $cache
        ->condition('entity_id', $entity_id);
      $votes
        ->condition('entity_id', $entity_id);
    }
    $cache
      ->execute();
    $votes
      ->execute();
    drush_log(t('Flushed vote data for @type entities.', array(
      '@type' => empty($entity_type) ? t('all') : $entity_type,
    )), 'success');
  }
}

Functions

Name	Description
drush_votingapi_flush	Command callback. Flush votes and results.
drush_votingapi_generate_votes	Command callback. Generate a number of votes.
drush_votingapi_recalculate	Command callback. Recalculate voting results.
votingapi_drush_command	Implements of hook_drush_command().
votingapi_drush_help	Implements of hook_drush_help().
votingapi_generate_votes	Utility function to generate votes.
_votingapi_cast_votes	Utility function to generate votes on a node by a set of users.