You are here

Home » API reference » Webform Protected Downloads 8 » WebformProtectedDownloadsController.php

class WebformProtectedDownloadsController in Webform Protected Downloads 8

Class WebformProtectedDownloadsController.

@package Drupal\webform_protected_downloads\Controller

Hierarchy

Expanded class hierarchy of WebformProtectedDownloadsController

File

src/Controller/WebformProtectedDownloadsController.php, line 21

Namespace

Drupal\webform_protected_downloads\Controller
View source 
class WebformProtectedDownloadsController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * WebformProtectedDownloadsManager definition.
   *
   * @var \Drupal\webform_protected_downloads\WebformProtectedDownloadsManager
   */
  protected $webformProtectedDownloadsManager;

  /**
   * WebformProtectedDownloadsController constructor.
   *
   * @param \Drupal\webform_protected_downloads\WebformProtectedDownloadsManager $webform_protected_downloads_manager
   *   WebformProtectedDownloadsManager definition.
   */
  public function __construct(WebformProtectedDownloadsManager $webform_protected_downloads_manager) {
    $this->webformProtectedDownloadsManager = $webform_protected_downloads_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('webform_protected_downloads.manager'));
  }

  /**
   * Protected file download controller.
   */
  public function protectedFileDownload($hash) {

    // Get corresponding protected file entry from given URL hash.
    $webformProtectedDownload = $this->webformProtectedDownloadsManager
      ->getSubmissionByHash($hash);
    $webformSubmission = $webformProtectedDownload
      ->getWebformSubmission();
    $webform = $webformSubmission
      ->getWebform();

    // Get webform.
    $wpd_settings = $webform
      ->getThirdPartySettings('webform_protected_downloads');

    // Return error page if no results, inactive, expired, no webform found
    // or file not found.
    $expired = $webformProtectedDownload->expire->value < time() && $webformProtectedDownload->expire->value != "0";
    if (!$webformProtectedDownload || !$webformProtectedDownload
      ->isActive() || $expired || !$webform || !$wpd_settings['protected_file']) {
      switch ($wpd_settings['expired_link_page']) {
        case "homepage":
          $this
            ->messenger()
            ->addError($wpd_settings['error_message']);
          return $this
            ->redirect('<front>');
        case "page_reload":
          $this
            ->messenger()
            ->addError($wpd_settings['error_message']);
          return new RedirectResponse($webform
            ->toUrl()
            ->setAbsolute()
            ->toString());
        case "custom":
          $this
            ->messenger()
            ->addError($wpd_settings['error_message']);
          return new TrustedRedirectResponse($wpd_settings['custom_link_page']);
        default:
          throw new Exception\NotFoundHttpException();
      }
    }

    // Get file response.
    $response = $this
      ->sendProtectedFileResponse(current($wpd_settings['protected_file']));

    // Set onetime entry to inactive before returning.
    if ($webformProtectedDownload
      ->isOneTimeLink()) {
      $webformProtectedDownload
        ->set('active', FALSE)
        ->save();
    }
    return $response;
  }

  /**
   * Gets the file from fid and creates a download http response.
   */
  private function sendProtectedFileResponse($fid) {

    // Get all the needed parameters.
    $file = File::load($fid);
    if (!$file) {
      throw new Exception\NotFoundHttpException();
    }
    $uri = $file
      ->getFileUri($file);
    $mimeTypeGuesser = \Drupal::service('file.mime_type.guesser');

    // Set HTTP header parameters.
    $headers = array(
      'Content-Type' => $mimeTypeGuesser
        ->guess($uri) . '; name="' . Unicode::mimeHeaderEncode(basename($uri)) . '"',
      'Content-Length' => filesize($uri),
      'Content-Disposition' => 'attachment; filename="' . Unicode::mimeHeaderEncode($file
        ->getFilename()) . '"',
      'Cache-Control' => 'private',
    );
    return new BinaryFileResponse($uri, 200, $headers);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
WebformProtectedDownloadsController::$webformProtectedDownloadsManager protected property WebformProtectedDownloadsManager definition.
WebformProtectedDownloadsController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
WebformProtectedDownloadsController::protectedFileDownload public function Protected file download controller.
WebformProtectedDownloadsController::sendProtectedFileResponse private function Gets the file from fid and creates a download http response.
WebformProtectedDownloadsController::__construct public function WebformProtectedDownloadsController constructor.