pantheon_apachesolr: handle curl config for local development

Author: Pantheon Automation

modules/pantheon/pantheon_apachesolr/Pantheon_Apache_Solr_Service.php

@@ -453,7 +453,7 @@ protected function _makeHttpRequest($url, $options = array()) {
     if (!isset($ch)) {
       // The parent PHPSolrClient library assumes http
       // $url = str_replace('http://', 'https://', $url);
-      list($ch, $opts) = pantheon_curl_setup($url, NULL, $port, NULL);
+      list($ch, $opts) = pantheon_apachesolr_curl_setup($url, $port);
 
       // These options only need to be set once
       $opts = pantheon_apachesolr_curlopts($opts);      
@@ -486,12 +486,19 @@ protected function _makeHttpRequest($url, $options = array()) {
       return NULL;
     }
 
-    // mimick the $result object from drupal_http_request()
+    // mimic the $result object from drupal_http_request()
     // TODO; better error handling
     $result = new stdClass();
     list($split, $result->data) = explode("\r\n\r\n", $response, 2);
     $split = preg_split("/\r\n|\n|\r/", $split);
-    list($result->protocol, $result->code, $result->status_message) = explode(' ', trim(array_shift($split)), 3);
+
+    $status_line = trim(array_shift($split));
+    $status_parts = explode(' ', $status_line, 3);
+    
+    $result->protocol = isset($status_parts[0]) ? $status_parts[0] : '';
+    $result->code = isset($status_parts[1]) ? $status_parts[1] : 0;
+    $result->status_message = isset($status_parts[2]) ? $status_parts[2] : 'Unknown';
+    
     // Parse headers.
     $result->headers = array();
     while (!empty($split) && $line = trim(array_shift($split))) {

modules/pantheon/pantheon_apachesolr/Pantheon_Search_Api_Solr_Service.php

@@ -20,16 +20,25 @@ function __construct(array $options) {
 
     // pantheon_curl_setup will determine whether binding.pem needed and return
     // path in options if so.
-    list($ch, $opts) = pantheon_curl_setup("", NULL, $options['port'], NULL);
-    if ( isset($opts[CURLOPT_SSLCERT]) ) {
-      $stream_context_ssl = array('local_cert' => $opts[CURLOPT_SSLCERT]);
+    list($ch, $opts) = pantheon_apachesolr_curl_setup("", $options['port']);
+    $sslContext = array();
+
+    // Use ssl cert if provided
+    if (isset($opts[CURLOPT_SSLCERT])) {
+        $sslContext['local_cert'] = $opts[CURLOPT_SSLCERT];
     } else {
-      $stream_context_ssl = array(
-        'verify_peer' => (bool)$opts[CURLOPT_SSL_VERIFYPEER],
-        'verify_peer_name' => (bool)$opts[CURLOPT_SSL_VERIFYHOST]
-      );
+        // Add peer verification settings if available.
+        if (isset($opts[CURLOPT_SSL_VERIFYPEER])) {
+            $sslContext['verify_peer'] = (bool) $opts[CURLOPT_SSL_VERIFYPEER];
+        }
+        if (isset($opts[CURLOPT_SSL_VERIFYHOST])) {
+            $sslContext['verify_peer_name'] = (bool) $opts[CURLOPT_SSL_VERIFYHOST];
+        }
+    }
+    
+    if ($sslContext) {
+        $this->setStreamContext(stream_context_create(array('ssl' => $sslContext)));
     }
-    $this->setStreamContext(stream_context_create(array('ssl' => $stream_context_ssl)));
 
     // Adding in general settings for Search API
     $options += array(

modules/pantheon/pantheon_apachesolr/pantheon_apachesolr.info

@@ -1,7 +1,7 @@
 name = Pantheon Apache Solr
 description = Exposes Pantheon's ApacheSolr Service
 package = Pantheon
-version = "7.x-1.1"
+version = "7.x-1.1.1"
 files[] = Pantheon_Apache_Solr_Service.php
 files[] = Pantheon_Search_Api_Solr_Service.php
 configure = admin/config/search/pantheon

modules/pantheon/pantheon_apachesolr/pantheon_apachesolr.module

@@ -171,16 +171,6 @@ function pantheon_apachesolr_platform_detected() {
   return isset($_ENV['PANTHEON_ENVIRONMENT']);
 }
 
-/**
- * Return the path to the directory containing the certificates.
- */
-function pantheon_apachesolr_certs_dir() {
-  if (pantheon_apachesolr_platform_detected()) {
-    return $_ENV['HOME'] . '/certs';
-  }
-  return './';
-}
-
 /**
  * Display an error message if not running on the Pantheon platform.
  */
@@ -224,7 +214,7 @@ function pantheon_apachesolr_post_schema_exec($schema) {
 
   $url = 'https://'. $host .'/'. $path;
 
-  list($ch, $opts) = pantheon_curl_setup($url, NULL, PANTHEON_APACHESOLR_PORT, NULL);
+  list($ch, $opts) = pantheon_apachesolr_curl_setup($url, PANTHEON_APACHESOLR_PORT);
 
   $file = fopen($schema, 'r');
   // set (or override) remaining headers
@@ -368,7 +358,7 @@ function pantheon_apachesolr_query_submit($form, &$form_state) {
   $path = 'sites/self/environments/'. variable_get('pantheon_environment', 'dev') .'/index';
   $url = 'https://'. $host .'/'. $path . $form_state['values']['query'];
 
-  list($ch, $opts) = pantheon_curl_setup($url, NULL, PANTHEON_APACHESOLR_PORT, NULL);
+  list($ch, $opts) = pantheon_apachesolr_curl_setup($url, PANTHEON_APACHESOLR_PORT);
   $opts = pantheon_apachesolr_curlopts($opts);
   $opts[CURLOPT_HEADER] = 0;
 
@@ -548,7 +538,7 @@ function pantheon_apachesolr_status($form, &$form_state) {
 
   $url = 'https://'. $host . '/' . $path;
 
-  list($ch, $opts) = pantheon_curl_setup($url, NULL, PANTHEON_APACHESOLR_PORT, NULL);
+  list($ch, $opts) = pantheon_apachesolr_curl_setup($url, PANTHEON_APACHESOLR_PORT);
 
   $opts = pantheon_apachesolr_curlopts($opts);
   $opts[CURLOPT_CONNECTTIMEOUT] = 5;
@@ -620,7 +610,7 @@ function pantheon_apachesolr_status($form, &$form_state) {
   $url = 'https://'. $host . '/' . $path;
 
   $opts = array();
-  list($ch, $opts) = pantheon_curl_setup($url, NULL, PANTHEON_APACHESOLR_PORT, NULL);
+  list($ch, $opts) = pantheon_apachesolr_curl_setup($url, PANTHEON_APACHESOLR_PORT);
 
   unset($opts[CURLOPT_HTTPHEADER]);
   $opts[CURLOPT_CONNECTTIMEOUT] = 5;
@@ -719,7 +709,7 @@ function pantheon_apachesolr_requirements($phase) {
 
       $url = 'https://'. $host . '/' . $path;
 
-      list($ch, $opts) = pantheon_curl_setup($url, NULL, PANTHEON_APACHESOLR_PORT, NULL);
+      list($ch, $opts) = pantheon_apachesolr_curl_setup($url, PANTHEON_APACHESOLR_PORT);
       $opts = pantheon_apachesolr_curlopts($opts);
 
 
@@ -759,3 +749,39 @@ function pantheon_apachesolr_requirements($phase) {
   }
   return $requirements;
 }
+
+/**
+ * Initializes a cURL handle with default options, or delegates to Pantheon's
+ * `pantheon_curl_setup()` if available.
+ *
+ * When running on the Pantheon platform, this function uses the pre-configured
+ * `pantheon_curl_setup()` logic. Otherwise, it sets up a basic cURL handle with
+ * common defaults for communicating with Apache Solr.
+ *
+ * @param string $url  The URL to set via CURLOPT_URL.
+ * @param int    $port The port to set via CURLOPT_PORT.
+ *
+ * @return array{0: resource, 1: array} An array containing the initialized cURL handle
+ * and an array of the options applied.
+ */
+function pantheon_apachesolr_curl_setup($url, $port) {
+  // If on pantheon, handled in prepend...
+  if (function_exists("pantheon_curl_setup")) {
+    return pantheon_curl_setup($url, NULL, $port, NULL);
+  }
+
+  // create a new cURL resource
+  $ch = curl_init();
+
+  // default options for most cases
+  $opts = array(
+    CURLOPT_URL => $url,
+    CURLOPT_HEADER => 1,
+    CURLOPT_PORT => $port,
+    CURLOPT_RETURNTRANSFER => 1,
+    CURLOPT_HTTPHEADER => array('Content-Type: application/json', 'X-Ignore-Agent: 1'),
+  );
+
+  curl_setopt_array($ch, $opts);
+  return array($ch, $opts);
+}