dummy.patch

diff --git a/modules/custom/petitions_data/petitions_data.module b/modules/custom/petitions_data/petitions_data.module
index 78e1e86..0934db0 100644
--- a/modules/custom/petitions_data/petitions_data.module
+++ b/modules/custom/petitions_data/petitions_data.module
@@ -67,3 +67,23 @@ function petitions_data_form($form, &$form_state) {
 
   return system_settings_form($form);
 }
+
+function petitions_data_petition_is_open($petition_id){
+  $is_open = FALSE;
+  // Check cache before querying the API.
+  if (!$petition_close_date = cache_get($petition_id, 'petition_close_date')) {
+    // Load the petition via the API retrieve method.
+    $petition = PetitionsRetrieveRawFactory::create()->load($petition_id);
+    // Confirm that the query returns a petition.
+    if (!empty($petition['results'])) {
+      // Confirm that the petition has not been removed.
+      if ($petition['results'][0]['status'] == 'open') {
+        $petition_close_date = $petition['results'][0]['deadline'];
+      }
+    }
+  }
+  if ($petition_close_date > time()) {
+    $is_open = TRUE;
+  }
+  return $is_open;
+}
diff --git a/modules/custom/signatures_queue/classes/SignaturesQueue.inc b/modules/custom/signatures_queue/classes/SignaturesQueue.inc
index 175e170..25db9a5 100644
--- a/modules/custom/signatures_queue/classes/SignaturesQueue.inc
+++ b/modules/custom/signatures_queue/classes/SignaturesQueue.inc
@@ -136,13 +136,27 @@ class SignaturesQueue extends DrupalQueue {
   }
 
   /**
-   * Generates a random petition ID.
+   * Returns a random petition ID.
+   *
+   * Returns an ID associated with a real, open petition, if one is available,
+   * or generates a random string if not.
    *
    * @return string
-   *   A 25 character random alpha-numeric ID. This is like mongo-generated
-   *   petition IDs.
+   *   A 25 character alpha-numeric ID.
    */
   protected static function generateRandomPetitionID() {
+    // Get a real, open petition ID if one is available.
+    $petitions = PetitionsIndexRawFactory::create()->setStatus('open')->load();
+    if (!empty($petitions['results'])) {
+      shuffle($petitions['results']);
+      foreach ($petitions['results'] as $result) {
+        if ($result['deadline'] > time()) {
+          return $result['id'];
+        }
+      }
+    }
+
+    // Fall back to returning a random string.
     return self::generateRandomString(25);
   }
 
diff --git a/modules/custom/signatures_queue/includes/initiate_signature_validation.inc b/modules/custom/signatures_queue/includes/initiate_signature_validation.inc
new file mode 100644
index 0000000..01770f3
--- /dev/null
+++ b/modules/custom/signatures_queue/includes/initiate_signature_validation.inc
@@ -0,0 +1,271 @@
+<?php
+
+/**
+ * @file
+ * The "initiate signature validation" workflow.
+ *
+ * Retrieve and delete batches of signatures from signatures_submitted_queue,
+ * send a validation email, then store signature info in
+ * signatures_pending_validation_queue.
+ */
+
+/**
+ * Initiates signature validation.
+ *
+ * @param string $server_name
+ *   The name of the active server.
+ * @param string $worker_name
+ *   An arbitrary worker identifier.
+ *
+ * @return bool
+ *   Returns TRUE if the workflow executes successfully or FALSE if not.
+ */
+function signatures_queue_initiate_signature_validation($job_id, $server_name, $worker_name) {
+  $watchdog_suffix = _signatures_queue_watchdog_suffix('initiate_signature_validation', $job_id, $server_name, $worker_name);
+
+  // Retrieve and delete signatures from the signatures_submitted_queue.
+  $signatures = _signatures_queue_retrieve_submitted_signatures($watchdog_suffix);
+
+  // Return if there's nothing to do.
+  if (empty($signatures)) {
+    return TRUE;
+  }
+
+  // Assign secret validation keys to each signature.
+  $signatures = _signatures_queue_assign_validation_keys($signatures);
+
+  // Add md5 evaluation key to prevent spam.
+  $signatures = _signatures_queue_add_md5_evaluation_keys($signatures);
+
+  // Send validation emails.
+  $signatures = _signatures_queue_send_validation_emails($signatures, $watchdog_suffix);
+
+  // Advance successfully-processed signatures to the next workflow.
+  _signatures_queue_advance_successful_signatures($signatures['sent'], $watchdog_suffix);
+
+  // Return failed signatures to the queue for re-processing.
+  _signatures_queue_return_failed_signatures($signatures['not sent'], $watchdog_suffix);
+
+  return TRUE;
+}
+
+/**
+ * Retrieve and delete signatures from the signatures_submitted_queue.
+ *
+ * @param int $batch_size
+ *   The number of signatures to process in this batch.
+ *
+ * @return array
+ *   Array of signature submissions.
+ */
+function _signatures_queue_retrieve_submitted_signatures($watchdog_suffix, $batch_size = 0) {
+  // If this function is called directly, the calling function can determine
+  // batch size by passing it as a parameter. Otherwise use admin-defined batch
+  // size, or default to 1.
+  if (empty($batch_size)) {
+    $batch_size = variable_get('signatures_queue_initiate_signature_validation_batch_size', SIGNATURES_QUEUE_BATCH_SIZE_DEFAULT);
+  }
+
+  // Retrieve items from signatures_submitted_queue.
+  $signatures = array();
+  $queue = SignaturesQueue::get('signatures_submitted_queue');
+  $queue->createQueue();
+  $number_of_items = $queue->numberOfItems();
+
+  // Return if the queue is empty.
+  if (!$number_of_items) {
+    watchdog('signatures_queue', 'signatures_submitted_queue is empty. No validation emails will be sent. @suffix', array(
+      '@suffix' => $watchdog_suffix,
+    ), WATCHDOG_INFO);
+    return $signatures;
+  }
+
+  // Process the queue.
+  for ($i = 0; $i < $batch_size; $i++) {
+    $item = $queue->claimItem();
+
+    // claimItem() returns FALSE when there are no more items in the queue.
+    if (!$item) {
+      break;
+    }
+
+    $signatures[] = $item->data;
+
+    // Remove item from signatures_submitted_queue. (AWS SQS only guarantees you
+    // can retrieve each message once.) If we don't successfully complete
+    // processing, we should re-queue, rather than just leave the item sitting
+    // in the queue).
+    $queue->deleteItem($item);
+  }
+
+  if ($i) {
+    watchdog('signatures_queue', '@number records retrieved and deleted from signatures_submitted_queue. @suffix', array(
+      '@number' => number_format($i),
+      '@suffix' => $watchdog_suffix,
+    ), WATCHDOG_INFO);
+  }
+  else {
+    watchdog('signatures_queue', 'signatures_submitted_queue contains @number record(s), but none were retrieved. @suffix', array(
+      '@number' => number_format($number_of_items),
+      '@suffix' => $watchdog_suffix,
+    ), WATCHDOG_ERROR);
+  }
+
+  return $signatures;
+}
+
+/**
+ * Assign secret validation keys to each signature.
+ *
+ * @param array $signatures
+ *   Array of submitted signatures.
+ *
+ * @return array
+ *   Array of submitted signatures with secret validation keys assigned.
+ */
+function _signatures_queue_assign_validation_keys(array $signatures) {
+  $signatures_with_keys = array();
+
+  // Generate secret validation keys.
+  foreach ($signatures as $signature) {
+    $email = $signature['email'];
+    $timestamp = $signature['timestamp_submitted'];
+    $petition_id = $signature['petition_id'];
+    $salt = variable_get('signatures_queue_salt', '');
+    $signature['secret_validation_key'] = sha1($email . $timestamp . $petition_id . $salt);
+    $signatures_with_keys[] = $signature;
+  }
+
+  return $signatures_with_keys;
+}
+
+/**
+ * Add md5 evaluation key to prevent spam.
+ *
+ * @param array $signatures
+ *   Array of submitted signatures.
+ *
+ * @return array
+ *   Array of submitted signatures with evaluation keys.
+ */
+function _signatures_queue_add_md5_evaluation_keys(array $signatures) {
+  $signatures_with_keys = array();
+
+  // Generate secret validation keys.
+  foreach ($signatures as $signature) {
+    $signature['md5_encryption_key'] = md5($signature['secret_validation_key']);
+    $signatures_with_keys[] = $signature;
+  }
+
+  return $signatures_with_keys;
+}
+
+/**
+ * Send validation emails.
+ *
+ * @param array $signatures
+ *   Array of submitted signatures.
+ *
+ * @return array
+ *   Array of signatures organized like this:
+ *     array('sent' => $signatures_sent, 'not sent' => $signatures_not_sent)
+ */
+function _signatures_queue_send_validation_emails(array $signatures, $watchdog_suffix) {
+  $signatures_mailed = array('sent' => array(), 'not sent' => array());
+
+  // TODO Looks like we can only call drupal_mail() one-by-one. Is there any way
+  // to submit these in bulk? Or do we need to make an API call to for every
+  // send?
+  foreach ($signatures as $signature) {
+    // Confirm that the petition is open.
+    if (petitions_data_petition_is_open($signature['petition_id'])) {
+      // Send validation email.
+      $to = $signature['email'];
+      global $language;
+      $params = array('signature info' => $signature);
+      $result = drupal_mail('signatures_queue', 'initiate_signature_validation', $to, $language, $params);
+
+      // TODO Figure out how we determine success/failure here...
+      $text = 'This is where a message gets sent to ' . $signature['first_name'] . ' ' . $signature['last_name'];
+      drupal_set_message($text);
+      // VERIFY SUCCESS HERE.
+      if ($result) {
+        $signatures_mailed['sent'][] = $signature;
+      }
+      else {
+        $signatures_mailed['not sent'][] = $signature;
+      }
+    }
+  }
+
+  // Identify the active mail system.
+  // @todo There should be a nicer way to do this once the broader question of
+  //   mail handling has been addressed per PT-1003.
+  $mail_systems = variable_get('mail_system', array(
+    'default-system' => 'DefaultMailSystem',
+  ));
+  if (!empty($mail_systems['default-system']) && is_string($mail_systems['default-system'])) {
+    $active_mail_system = $mail_systems['default-system'];
+  }
+  else {
+    $active_mail_system = 'DefaultMailSystem';
+  }
+
+  // Log successes.
+  if (!empty($signatures_mailed['sent'])) {
+    watchdog('signatures_queue', '@number signature validation emails sent via @mail_system. @suffix', array(
+      '@number' => number_format(count($signatures_mailed['sent'])),
+      '@mail_system' => $active_mail_system,
+      '@suffix' => $watchdog_suffix,
+    ), WATCHDOG_INFO);
+  }
+
+  // Log failures.
+  if (!empty($signatures_mailed['not sent'])) {
+    watchdog('signatures_queue', '@number signature validation emails failed via @mail_system. (Will try again.) @suffix', array(
+      '@number' => number_format(count($signatures_mailed['not sent'])),
+      '@mail_system' => $active_mail_system,
+      '@suffix' => $watchdog_suffix,
+    ), WATCHDOG_ERROR);
+  }
+
+  return $signatures_mailed;
+}
+
+/**
+ * Advances signatures to "signatures_pending_validation_queue".
+ *
+ * @param array $signatures
+ *   An array of signatures.
+ */
+function _signatures_queue_advance_successful_signatures(array $signatures, $watchdog_suffix) {
+  $queue = SignaturesQueue::get('signatures_pending_validation_queue');
+  $queue->createQueue();
+  foreach ($signatures as $signature) {
+    $queue->createItem($signature);
+  }
+
+  watchdog('signatures_queue', '@number records added to signatures_pending_validation_queue. @suffix', array(
+    '@number' => number_format(count($signatures)),
+    '@suffix' => $watchdog_suffix,
+  ), WATCHDOG_INFO);
+}
+
+/**
+ * Returns signatures to "signatures_submitted_queue".
+ *
+ * @param array $signatures
+ *   An array of signatures.
+ */
+function _signatures_queue_return_failed_signatures(array $signatures, $watchdog_suffix) {
+  $queue = SignaturesQueue::get('signatures_submitted_queue');
+  $queue->createQueue();
+  foreach ($signatures as $signature) {
+    $queue->createItem($signature);
+  }
+
+  watchdog('signatures_queue', '@number records returned to signatures_submitted_queue. @suffix', array(
+    '@number' => number_format(count($signatures)),
+    '@suffix' => $watchdog_suffix,
+  ), WATCHDOG_INFO);
+}