uc_csv.drush.inc in Ubercart CSV 7.2

File

uc_csv.drush.inc

<?php

/**
 * Implementation of hook_drush_command().
 */
function uc_csv_drush_command() {
  $items = array();
  $items['uc-csv-export'] = array(
    'description' => dt('Run an export and place the exported file in the specified location, or in the same place where the command is called if unspecified.'),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'output-file' => dt('The relative path and file name to where you want the export file placed.'),
    ),
    'options' => array(
      'start' => array(
        'description' => dt('The start date of when the export should take place (yyyy-mm-dd)'),
        'example-value' => '2014-10-01',
      ),
      'end' => array(
        'description' => dt('The end date of when the export should end (yyyy-mm-dd)'),
        'example-value' => '2014-10-31',
      ),
      'shipping-address' => array(
        'description' => dt('Include the shipping address.'),
      ),
      'billing-address' => array(
        'description' => dt('Include the billing address.'),
      ),
      'products' => array(
        'description' => dt('Include the products.'),
      ),
      'file-type' => array(
        'description' => dt('Export type (defaults to csv).'),
      ),
      'order-by' => array(
        'description' => dt('How to order the report (defaults to order-id).'),
        'example-value' => 'order-id or last-name',
      ),
      'email' => array(
        'description' => dt('Optional: The email address to send the finished report to.'),
        'example-value' => '--email=[e-mail]',
      ),
      'examples' => array(
        'Export With Dates' => 'uc-csv-export export_file.csv --sd=2014-10-01 --ed=2014-10-31',
        'Export With Dates/Email' => 'uc-csv-export --sd=2014-10-01 --ed=2014-10-31--email=[e-mail]',
      ),
      'aliases' => array(
        'ucce',
      ),
    ),
  );
  $items['uc-csv-export-report'] = array(
    'description' => 'Run an export of a specific report (by id)',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'of' => dt('The relative path and file name to where you want the export file placed.'),
      'id' => dt('The machine ID of the report to be generated'),
    ),
    'options' => array(
      'ignore' => array(
        'description' => dt('Ignore state of previously exported entries (export all)'),
        'example-value' => 'true',
      ),
    ),
    'examples' => array(
      'export report 1' => 'uc-csv-export-report export_file.csv 1',
      'export report 1 ignore tracking' => 'uc-csv-export-report export_file.csv 1 --ignore=true',
    ),
    'aliases' => array(
      'ucer',
    ),
  );
  return $items;
}

/**
 * Implementation of drush_hook_COMMAND_validate().
 */
function drush_uc_csv_uc_csv_export_validate($of = NULL) {

  // check to make sure we have been provided a proper output file for dumping our
  // export to. This setting can be ignored if we are emailing a file
  $email = drush_get_option('email');
  if (empty($of) && empty($email)) {
    drush_set_error(dt('You did not specify a file name and location for your export file.'));
  }

  // check the dates to make sure they are in the proper format
  $start_date = drush_get_option('start-date');
  $end_date = drush_get_option('end-date');
  if (!empty($start_date) && strlen($start_date) != 10) {
    drush_set_error(dt('Your start date is not the proper length to be valid.'));
  }
  if (!empty($end_date) && strlen($end_date) != 10) {
    drush_set_error(dt('Your end date is not the proper length to be valid.'));
  }
  foreach (array(
    $start_date,
    $end_date,
  ) as $date) {
    list($year, $month, $day) = explode('-', $date);
    if (checkdate($month, $day, $year) === FALSE) {
      drush_set_error(dt('One of your specified dates was invalid. Please double check your date and try again.'));
    }
  }

  // Now we generate a report object and get the report
  $report = new stdClass();
}

/**
 * Drush export cvs file from ubercart command callback
 *
 * We need to basically create a report on the fly and create a report object to send
 * to the fuction which generates this
 */
function drush_uc_csv_export($of = NULL) {
  $form = $form_state = array();

  // Convert order-by into our legacy options so we don't have to re-write our schema
  $order_by = drush_get_option('order-by');
  $order_by($order_by != 'order-id' && $order_by != 'last-name') ? 'orderid' : $order_by;
  if ($order_by == 'last-name') {
    $order_by = 'last_name';
  }
  elseif ($order_by == 'order-id') {
    $order_by = 'orderid';
  }

  // Sanity check on the file type, defaulting to csv if all else fails
  $file_type = drush_get_option('file-type');
  $file_type($file_type != 'csv' && $file_type != 'xls') ? 'csv' : $file_type;

  // Simulate a report by generating the report object used by the creation process.
  // TODO: make all currently assigned items (save track) selectable as options in
  // the command line.
  $report = new stdClass();
  $report->volatile = TRUE;
  $report->shipping_address = drush_get_option('shipping-address');
  $report->billing_address = drush_get_option('billing-address');
  $report->products = drush_get_option('products');
  $report->track = FALSE;
  $report->start_date = drush_get_option('start-date');
  $report->end_date = drush_get_option('end-date');
  $report->file_type = $file_type;
  $report->order_by = $order_by;
  $report->report_name = !empty($of) ? $of : 'exported_report';
  $report->email_address = drush_get_option('email');
  $report->email_enable = !empty($report->email_address) ? TRUE : FALSE;

  // For now we will assume all statuses are to be exported as part of this report.
  // We may want to make it in the future so you can select which statuses are to
  // be exported, but that could be confusing.
  $result = db_query("SELECT order_status_id\n                      FROM {uc_order_statuses}\n                      ORDER BY weight ASC");
  while ($sdata = $result
    ->fetchObject()) {
    $statuses[] = $sdata->order_status_id;
  }
  $report->statuses = serialize($statuses);

  // Generate the report
  $data = uc_csv_select_report_to_export_submit($form, $form_state, $report);
  if ($report->email_enable == FALSE) {

    // Save the report to our specified location or right here if nothing selected.
    _uc_csv_save_report($report, $data['contents'], $report->report_name);
  }
}

/**
 * Make sure that we have a valid report id
 */
function drush_uc_csv_export_report_validate($of = NULL, $id = NULL) {

  // If they have not specified a file name then all bets are off
  if (empty($of)) {
    drush_set_error(dt('You must specify a file name for your report.'));
    return FALSE;
  }

  // if they haven't specified a report id, then all bets are off, but we shouldn't
  // get this since they are presented a list
  if (is_numeric($id)) {
    $result = db_query("SELECT * FROM {uc_csv_reports} WHERE rid=:rid;", array(
      ':rid' => $id,
    ));
    $report = $result
      ->fetchObject();
    if (empty($report->report_name) || !$report->report_name) {
      drush_set_error(dt('There is no report with an id of ' . $id));
      return FALSE;
    }
  }
}

/**
 * Do the report
 *
 * This follows the model used by the web interface, but allows for command line execution
 */
function drush_uc_csv_export_report($of, $id = NULL) {

  // if the id is null, then present a list of available reports to export and have them
  // select from that list
  if (empty($id)) {

    // Get a list of all of the available reports
    $options = array();
    $result = db_query('SELECT * from {uc_csv_reports} ORDER BY report_name ASC');
    while ($rdata = $result
      ->fetchObject()) {
      $options[$rdata->rid] = $rdata->report_name;
    }
    $choice = drush_choice($options, dt('Which report do you wish to export?'));
    $form_state = array();
    $form_state['values']['rid'] = $choice;
    $data = uc_csv_select_report_to_export_submit(array(), $form_state);
  }
  else {
    $form_state = array();
    $form_state['values']['rid'] = $id;
    $data = uc_csv_select_report_to_export_submit(array(), $form_state);
  }
  $of = drush_get_option('of');
  if (!empty($of)) {
    _uc_csv_save_report($data['report'], $data['contents'], $of);
  }
}

Functions

Name	Description
drush_uc_csv_export	Drush export cvs file from ubercart command callback
drush_uc_csv_export_report	Do the report
drush_uc_csv_export_report_validate	Make sure that we have a valid report id
drush_uc_csv_uc_csv_export_validate	Implementation of drush_hook_COMMAND_validate().
uc_csv_drush_command	Implementation of hook_drush_command().