Update to use PSR HTTP Message Response Interface as per @totten

civicrm · Jun 7, 2019 · d5ffdf7 · d5ffdf7
1 parent b29cb7e
commit d5ffdf7
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 21 deletions.
diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php
@@ -53,7 +53,7 @@
  * @method static array synchronizeUsers() Create CRM contacts for all existing CMS users.
  * @method static appendCoreResources(\Civi\Core\Event\GenericHookEvent $e) Callback for hook_civicrm_coreResourceList.
  * @method static alterAssetUrl(\Civi\Core\Event\GenericHookEvent $e) Callback for hook_civicrm_getAssetUrl.
- * @method static sendResponse(array $responseData) function to set HTTP status response and return specific response to client initially for assetBuilder content.
+ * @method static sendResponse(\Psr\Http\Message\ResponseInterface $response) function to handle RepsoseInterface for delivering HTTP Responses.
  */
 class CRM_Utils_System {
 
@@ -1864,18 +1864,11 @@ public static function createDefaultCrudLink($crudLinkSpec) {
 
   /**
    * Return an HTTP Response with appropriate content and status code set.
-   * @param array $responseData
+   * @param \Psr\Http\Message\ResponseInterface $response
    */
-  public static function sendResponse($responseData) {
+  public static function sendResponse(\Psr\Http\Message\ResponseInterface $response) {
     $config = CRM_Core_Config::singleton();
-    if (!empty($responseData['statusCode'])) {
-      $config->userSystem->setStatusCode($responseData['statusCode']);
-    }
-    if (!empty($responseData['mimeType'])) {
-      self::setHttpHeader('Content-Type', $responseData['mimeType']);
-    }
-    echo $responseData['content'];
-    self::civiExit();
+    $config->userSystem->sendResponse($response);
   }
 
 }
diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php
@@ -947,16 +947,19 @@ public function synchronizeUsers() {
 
   /**
    * Set the HTTP Status Code for a request
-   * @param string $statusCode
+   * @param \Psr\Http\Message\ResponseInterface $response
    */
-  public function setStatusCode($statusCode) {
+  public function sendResponse(\Psr\Http\Message\ResponseInterface $response) {
     if (function_exists('http_response_code')) {
       // PHP 5.4+
-      http_response_code($statusCode);
+      http_response_code($response->getStatusCode());
     }
     else {
-      header('X-PHP-Response-Code: ' . $statusCode, TRUE, $statusCode);
+      header('X-PHP-Response-Code: ' . $response->getStatusCode(), TRUE, $statusCode->getStatusCode());
     }
+    CRM_Utils_System::setHeader('Content-Type', $response->getHeaderLine('Content-Type'));
+    echo $response->getBody();
+    CRM_Utils_System::civiExit();
   }
 
 }
diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php
@@ -865,17 +865,21 @@ public function synchronizeUsers() {
 
   /**
    * Set the HTTP Status Code for a request
-   * @param string $statusCode
+   * @param \Psr\Http\Message\ResponseInterface $response
    */
-  public function setStatusCode($statusCode) {
-    status_header($statusCode);
+  public function sendResponse(\Psr\Http\Message\ResponseInterface $response) {
+    // use WordPress function status_header to ensure 404 response is sent
+    status_header($response->getStatusCode());
     if (function_exists('http_response_code')) {
       // PHP 5.4+
-      http_response_code($statusCode);
+      http_response_code($response->getStatusCode());
     }
     else {
-      header('X-PHP-Response-Code: ' . $statusCode, TRUE, $statusCode);
+      header('X-PHP-Response-Code: ' . $response->getStatusCode(), TRUE, $statusCode->getStatusCode());
     }
+    CRM_Utils_System::setHeader('Content-Type', $response->getHeaderLine('Content-Type'));
+    echo $response->getBody();
+    CRM_Utils_System::civiExit();
   }
 
 }
diff --git a/Civi/Core/AssetBuilder.php b/Civi/Core/AssetBuilder.php
@@ -342,7 +342,7 @@ public function setCacheEnabled($cacheEnabled) {
   public static function pageRun() {
     // Beg your pardon, sir. Please may I have an HTTP response class instead?
     $asset = self::pageRender($_GET);
-    \CRM_Utils_System::sendResponse($asset);
+    \CRM_Utils_System::sendResponse(new \GuzzleHttp\Psr7\Response($asset['statusCode'], ['Content-Type' => $asset['mimeType']], $asset['content']));
   }
 
   /**