class JsonSubrequestDenormalizer in Subrequests 8

Hierarchy

• class \Drupal\subrequests\Normalizer\JsonSubrequestDenormalizer implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface

1 string reference to 'JsonSubrequestDenormalizer'

subrequests.services.yml in ./subrequests.services.yml

subrequests.services.yml

1 service uses JsonSubrequestDenormalizer

subrequests.denormalizer.subrequest.json in ./subrequests.services.yml

Drupal\subrequests\Normalizer\JsonSubrequestDenormalizer

File

src/Normalizer/JsonSubrequestDenormalizer.php, line 14

Namespace

Drupal\subrequests\Normalizer

class JsonSubrequestDenormalizer implements DenormalizerInterface {

  /**
   * Denormalizes data back into an object of the given class.
   *
   * @param mixed $data data to restore
   * @param string $class the expected class to instantiate
   * @param string $format format the given data was extracted from
   * @param array $context options available to the denormalizer
   *
   * @return object
   */
  public function denormalize($data, $class, $format = NULL, array $context = []) {
    if (!Parser::isValidSubrequest($data)) {
      throw new \RuntimeException('The provided blueprint contains an invalid subrequest.');
    }
    $data['path'] = parse_url($data['uri'], PHP_URL_PATH);
    $data['query'] = parse_url($data['uri'], PHP_URL_QUERY) ?: [];
    if (isset($data['query']) && !is_array($data['query'])) {
      $query = [];
      parse_str($data['query'], $query);
      $data['query'] = $query;
    }
    $data = NestedArray::mergeDeep([
      'body' => '',
      'headers' => [],
    ], $data, parse_url($data['path']));

    /** @var \Symfony\Component\HttpFoundation\Request $master_request */
    $master_request = $context['master_request'];
    $request = Request::create($data['path'], static::getMethodFromAction($data['action']), empty($data['body']) ? $data['query'] : Json::decode($data['body']), $master_request->cookies ? (array) $master_request->cookies
      ->getIterator() : [], $master_request->files ? (array) $master_request->files
      ->getIterator() : [], [], empty($data['body']) ? '' : $data['body']);

    // Maintain the same session as in the master request.
    $request
      ->setSession($master_request
      ->getSession());

    // Replace the headers by the ones in the subrequest.
    foreach ($data['headers'] as $name => $value) {
      $request->headers
        ->set($name, $value);
    }
    $this::fixBasicAuth($request);

    // Add the content ID to the sub-request.
    $content_id = empty($data['requestId']) ? md5(serialize($data)) : $data['requestId'];
    $request->headers
      ->set('Content-ID', '<' . $content_id . '>');
    $request->attributes
      ->set(RequestTree::SUBREQUEST_ID, $content_id);

    // If there is a parent, then add the ID to construct the tree.
    if (!empty($data['waitFor'])) {
      $request->attributes
        ->set(RequestTree::SUBREQUEST_PARENT_ID, $data['waitFor']);
    }
    return $request;
  }

  /**
   * Checks whether the given class is supported for denormalization by this
   * normalizer.
   *
   * @param mixed $data Data to denormalize from
   * @param string $type The class to which the data should be denormalized
   * @param string $format The format being deserialized from
   *
   * @return bool
   */
  public function supportsDenormalization($data, $type, $format = NULL) {
    return $format === 'json' && $type === Request::class && is_array($data) && JsonBlueprintDenormalizer::arrayIsKeyed($data);
  }

  /**
   * Gets the HTTP method from the list of allowed actions.
   *
   * @param string $action
   *   The action name.
   *
   * @return string
   *   The HTTP method.
   */
  public static function getMethodFromAction($action) {
    switch ($action) {
      case 'create':
        return Request::METHOD_POST;
      case 'update':
        return Request::METHOD_PATCH;
      case 'replace':
        return Request::METHOD_PUT;
      case 'delete':
        return Request::METHOD_DELETE;
      case 'exists':
        return Request::METHOD_HEAD;
      case 'discover':
        return Request::METHOD_OPTIONS;
      default:
        return Request::METHOD_GET;
    }
  }

  /**
   * Adds the decoded username and password headers for Basic Auth.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request to fix.
   */
  protected static function fixBasicAuth(Request $request) {

    // The server will not set the PHP_AUTH_USER and PHP_AUTH_PW for the
    // subrequests if needed.
    if ($request->headers
      ->has('Authorization')) {
      $header = $request->headers
        ->get('Authorization');
      if (strpos($header, 'Basic ') === 0) {
        list($user, $pass) = explode(':', base64_decode(substr($header, 6)));
        $request->headers
          ->set('PHP_AUTH_USER', $user);
        $request->headers
          ->set('PHP_AUTH_PW', $pass);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
JsonSubrequestDenormalizer::denormalize	public	function	Denormalizes data back into an object of the given class.
JsonSubrequestDenormalizer::fixBasicAuth	protected static	function	Adds the decoded username and password headers for Basic Auth.
JsonSubrequestDenormalizer::getMethodFromAction	public static	function	Gets the HTTP method from the list of allowed actions.
JsonSubrequestDenormalizer::supportsDenormalization	public	function	Checks whether the given class is supported for denormalization by this normalizer.