class DataProviderFile in RESTful 7.2

Class DataProviderFile.

@package Drupal\restful\Plugin\resource\DataProvider

Hierarchy

class \Drupal\restful\Plugin\resource\DataProvider\DataProvider implements DataProviderInterface
- class \Drupal\restful\Plugin\resource\DataProvider\DataProviderEntity implements DataProviderEntityInterface
  - class \Drupal\restful\Plugin\resource\DataProvider\DataProviderFile implements DataProviderInterface

Expanded class hierarchy of DataProviderFile

1 file declares its use of DataProviderFile

DataProviderFileTest.php in tests/modules/restful_test/src/Plugin/resource/DataProvider/DataProviderFileTest.php: Contains \Drupal\restful_test\Plugin\resource\DataProvider\DataProviderFileTest.

File

src/Plugin/resource/DataProvider/DataProviderFile.php, line 21: Contains \Drupal\restful\Plugin\resource\DataProvider\DataProviderFile.

Namespace

Drupal\restful\Plugin\resource\DataProvider

View source

class DataProviderFile extends DataProviderEntity implements DataProviderInterface {

  /**
   * Constructs a DataProviderFile object.
   */
  public function __construct(RequestInterface $request, ResourceFieldCollectionInterface $field_definitions, $account, $plugin_id, $resource_path, array $options, $langcode = NULL) {
    parent::__construct($request, $field_definitions, $account, $plugin_id, $resource_path, $options, $langcode);
    $file_options = empty($this->options['options']) ? array() : $this->options['options'];
    $default_values = array(
      'validators' => array(
        'file_validate_extensions' => array(),
        'file_validate_size' => array(),
      ),
      'scheme' => file_default_scheme(),
      'replace' => FILE_EXISTS_RENAME,
    );
    $this->options['options'] = drupal_array_merge_deep($default_values, $file_options);
  }

  /**
   * {@inheritdoc}
   */
  public function create($object) {
    $files = $this
      ->getRequest()
      ->getFiles();
    if (!$files) {
      throw new BadRequestException('No files sent with the request.');
    }
    $ids = array();
    foreach ($files as $file_info) {

      // Populate the $_FILES the way file_save_upload() expects.
      $name = $file_info['name'];
      foreach ($file_info as $key => $value) {
        $files['files'][$key][$name] = $value;
      }
      if (!($file = $this
        ->fileSaveUpload($name, $files))) {
        throw new BadRequestException('Unacceptable file sent with the request.');
      }

      // Required to be able to reference this file.
      file_usage_add($file, 'restful', 'files', $file->fid);
      $ids[] = $file->fid;
    }
    $return = array();
    foreach ($ids as $id) {

      // The access calls use the request method. Fake the view to be a GET.
      $old_request = $this
        ->getRequest();
      $this
        ->getRequest()
        ->setMethod(RequestInterface::METHOD_GET);
      try {
        $return[] = array(
          $this
            ->view($id),
        );
      } catch (ForbiddenException $e) {

        // A forbidden element should not forbid access to the whole list.
      }

      // Put the original request back to a POST.
      $this->request = $old_request;
    }
    return $return;
  }

  /**
   * An adaptation of file_save_upload() that includes more verbose errors.
   *
   * @param string $source
   *   A string specifying the filepath or URI of the uploaded file to save.
   * @param array $files
   *   Array containing information about the files.
   *
   * @return object
   *   The saved file object.
   *
   * @throws BadRequestException
   * @throws ServiceUnavailableException
   *
   * @see file_save_upload()
   */
  protected function fileSaveUpload($source, array $files) {
    static $upload_cache;
    $provider_options = $this
      ->getOptions();
    $options = $provider_options['options'];
    $validators = empty($options['validators']) ? NULL : $options['validators'];
    $destination = $options['scheme'] . "://";
    $replace = empty($options['replace']) ? NULL : $options['replace'];

    // Return cached objects without processing since the file will have
    // already been processed and the paths in _FILES will be invalid.
    if (isset($upload_cache[$source])) {
      return $upload_cache[$source];
    }

    // Make sure there's an upload to process.
    if (empty($files['files']['name'][$source])) {
      return NULL;
    }
    $this
      ->checkUploadErrors($source, $files);

    // Begin building file object.
    $file_array = array(
      'uid' => $this
        ->getAccount()->uid,
      'status' => 0,
      'filename' => trim(drupal_basename($files['files']['name'][$source]), '.'),
      'uri' => $files['files']['tmp_name'][$source],
      'filesize' => $files['files']['size'][$source],
    );
    $file_array['filemime'] = file_get_mimetype($file_array['filename']);
    $file = (object) $file_array;
    $extensions = '';
    if (isset($validators['file_validate_extensions'])) {
      if (isset($validators['file_validate_extensions'][0])) {

        // Build the list of non-munged extensions if the caller provided them.
        $extensions = $validators['file_validate_extensions'][0];
      }
      else {

        // If 'file_validate_extensions' is set and the list is empty then the
        // caller wants to allow any extension. In this case we have to remove
        // the validator or else it will reject all extensions.
        unset($validators['file_validate_extensions']);
      }
    }
    else {

      // No validator was provided, so add one using the default list.
      // Build a default non-munged safe list for file_munge_filename().
      $extensions = 'jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp';
      $validators['file_validate_extensions'] = array();
      $validators['file_validate_extensions'][0] = $extensions;
    }
    if (!empty($extensions)) {

      // Munge the filename to protect against possible malicious extension
      // hiding within an unknown file type (ie: filename.html.foo).
      $file->filename = file_munge_filename($file->filename, $extensions);
    }

    // Rename potentially executable files, to help prevent exploits (i.e. will
    // rename filename.php.foo and filename.php to filename.php.foo.txt and
    // filename.php.txt, respectively). Don't rename if 'allow_insecure_uploads'
    // evaluates to TRUE.
    if (!variable_get('allow_insecure_uploads', 0) && preg_match('/\\.(php|pl|py|cgi|asp|js)(\\.|$)/i', $file->filename) && substr($file->filename, -4) != '.txt') {
      $file->filemime = 'text/plain';
      $file->uri .= '.txt';
      $file->filename .= '.txt';

      // The .txt extension may not be in the allowed list of extensions. We
      // have to add it here or else the file upload will fail.
      if (!empty($extensions)) {
        $validators['file_validate_extensions'][0] .= ' txt';

        // Unlike file_save_upload() we don't need to let the user know that
        // for security reasons, your upload has been renamed, since RESTful
        // will return the file name in the response.
      }
    }

    // If the destination is not provided, use the temporary directory.
    if (empty($destination)) {
      $destination = 'temporary://';
    }

    // Assert that the destination contains a valid stream.
    $destination_scheme = file_uri_scheme($destination);
    if (!$destination_scheme || !file_stream_wrapper_valid_scheme($destination_scheme)) {
      $message = format_string('The file could not be uploaded, because the destination %destination is invalid.', array(
        '%destination' => $destination,
      ));
      throw new ServiceUnavailableException($message);
    }
    $file->source = $source;

    // A URI may already have a trailing slash or look like "public://".
    if (substr($destination, -1) != '/') {
      $destination .= '/';
    }
    $file->destination = file_destination($destination . $file->filename, $replace);

    // If file_destination() returns FALSE then $replace == FILE_EXISTS_ERROR
    // and there's an existing file so we need to bail.
    if ($file->destination === FALSE) {
      $message = format_string('The file %source could not be uploaded because a file by that name already exists in the destination %directory.', array(
        '%source' => $source,
        '%directory' => $destination,
      ));
      throw new ServiceUnavailableException($message);
    }

    // Add in our check of the the file name length.
    $validators['file_validate_name_length'] = array();

    // Call the validation functions specified by this function's caller.
    $errors = file_validate($file, $validators);

    // Check for errors.
    if (!empty($errors)) {
      $message = format_string('The specified file %name could not be uploaded.', array(
        '%name' => $file->filename,
      ));
      if (count($errors) > 1) {
        $message .= theme('item_list', array(
          'items' => $errors,
        ));
      }
      else {
        $message .= ' ' . array_pop($errors);
      }
      throw new ServiceUnavailableException($message);
    }

    // Move uploaded files from PHP's upload_tmp_dir to Drupal's temporary
    // directory. This overcomes open_basedir restrictions for future file
    // operations.
    $file->uri = $file->destination;
    if (!$this::moveUploadedFile($files['files']['tmp_name'][$source], $file->uri)) {
      watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array(
        '%file' => $file->filename,
        '%destination' => $file->uri,
      ));
      $message = 'File upload error. Could not move uploaded file.';
      throw new ServiceUnavailableException($message);
    }

    // Set the permissions on the new file.
    drupal_chmod($file->uri);

    // If we are replacing an existing file re-use its database record.
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = file_load_multiple(array(), array(
        'uri' => $file->uri,
      ));
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $file->fid = $existing->fid;
      }
    }

    // Change the file status from temporary to permanent.
    $file->status = FILE_STATUS_PERMANENT;

    // If we made it this far it's safe to record this file in the database.
    if ($file = file_save($file)) {

      // Add file to the cache.
      $upload_cache[$source] = $file;
      return $file;
    }

    // Something went wrong, so throw a general exception.
    throw new ServiceUnavailableException('Unknown error has occurred.');
  }

  /**
   * Checks of there is an error with the file upload and throws an exception.
   *
   * @param string $source
   *   The name of the uploaded file
   * @param array $files
   *   Array containing information about the files.
   *
   * @throws \Drupal\restful\Exception\BadRequestException
   * @throws \Drupal\restful\Exception\ServiceUnavailableException
   */
  protected function checkUploadErrors($source, array $files) {

    // Check for file upload errors and return FALSE if a lower level system
    // error occurred. For a complete list of errors:
    // See http://php.net/manual/features.file-upload.errors.php.
    switch ($files['files']['error'][$source]) {
      case UPLOAD_ERR_INI_SIZE:
      case UPLOAD_ERR_FORM_SIZE:
        $message = format_string('The file %file could not be saved, because it exceeds %maxsize, the maximum allowed size for uploads.', array(
          '%file' => $files['files']['name'][$source],
          '%maxsize' => format_size(file_upload_max_size()),
        ));
        throw new BadRequestException($message);
      case UPLOAD_ERR_PARTIAL:
      case UPLOAD_ERR_NO_FILE:
        $message = format_string('The file %file could not be saved, because the upload did not complete.', array(
          '%file' => $files['files']['name'][$source],
        ));
        throw new BadRequestException($message);
      case UPLOAD_ERR_OK:

        // Final check that this is a valid upload, if it isn't, use the
        // default error handler.
        if ($this::isUploadedFile($files['files']['tmp_name'][$source])) {
          break;
        }
      default:

        // Unknown error.
        $message = format_string('The file %file could not be saved. An unknown error has occurred.', array(
          '%file' => $files['files']['name'][$source],
        ));
        throw new ServiceUnavailableException($message);
    }
  }

  /**
   * Helper function that checks if a file was uploaded via a POST request.
   *
   * @param string $filename
   *   The name of the file.
   *
   * @return bool
   *   TRUE if the file is uploaded. FALSE otherwise.
   */
  protected static function isUploadedFile($filename) {
    return is_uploaded_file($filename);
  }

  /**
   * Helper function that moves an uploaded file.
   *
   * @param string $filename
   *   The path of the file to move.
   * @param string $uri
   *   The path where to move the file.
   *
   * @return bool
   *   TRUE if the file was moved. FALSE otherwise.
   */
  protected static function moveUploadedFile($filename, $uri) {
    return (bool) drupal_move_uploaded_file($filename, $uri);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DataProvider::$account	protected	property	The account authenticated from the request for entity access checks.
DataProvider::$fieldDefinitions	protected	property	The field definitions.
DataProvider::$langcode	protected	property	Determines the language of the items that should be returned.
DataProvider::$metadata	protected	property	Array of metadata. Use this as a mean to pass info to the render layer.
DataProvider::$options	protected	property	User defined options.
DataProvider::$pluginId	protected	property	Resource identifier.
DataProvider::$range	protected	property	Determines the number of items that should be returned when viewing lists.
DataProvider::$request	protected	property	The request
DataProvider::$resourcePath	protected	property	The resource path.
DataProvider::addOptions	public	function	Adds the options in the provided array to the data provider options. Overrides DataProviderInterface::addOptions
DataProvider::discover	public	function	Return the discovery information for the given entity. Overrides DataProviderInterface::discover
DataProvider::getAccount	public	function	Gets the authenticated account. Overrides DataProviderInterface::getAccount
DataProvider::getLangCode	public	function	Get the language code. Overrides DataProviderInterface::getLangCode
DataProvider::getLanguage	protected static	function	Gets the global language.
DataProvider::getMetadata	public	function	Returns the metadata collection. Overrides DataProviderInterface::getMetadata
DataProvider::getOptions	public	function	Gets the data provider options. Overrides DataProviderInterface::getOptions
DataProvider::getRange	public	function	Gets the range. Overrides DataProviderInterface::getRange
DataProvider::getRequest	public	function	Gets the request. Overrides DataProviderInterface::getRequest
DataProvider::getResourcePath	public	function	Get the resource path. Overrides DataProviderInterface::getResourcePath
DataProvider::index	public	function	List operation. Overrides CrudInterface::index	2
DataProvider::initResourceFieldCollection	protected	function	Initialize the empty resource field collection to bundle the output.
DataProvider::isNestedField	public static	function	Checks if the passed in string is a dot-nested field. Overrides DataProviderInterface::isNestedField
DataProvider::methodAccess	public	function	Checks if the provided field can be used with the current method. Overrides DataProviderInterface::methodAccess
DataProvider::parseRequestForListFilter	protected	function	Filter the query for list.
DataProvider::parseRequestForListPagination	protected	function	Parses the request object to get the pagination options.
DataProvider::parseRequestForListSort	protected	function	Parses the request to get the sorting options.
DataProvider::processFilterInput	public static	function	Processes the input for a filter and adds the appropriate defaults. Overrides DataProviderInterface::processFilterInput
DataProvider::setAccount	public	function	Sets the authenticated account. Overrides DataProviderInterface::setAccount
DataProvider::setHttpHeader	protected	function	Sets an HTTP header.
DataProvider::setLangCode	public	function	Sets the language code. Overrides DataProviderInterface::setLangCode
DataProvider::setOptions	public	function	Sets the options. Overrides DataProviderInterface::setOptions
DataProvider::setRange	public	function	Sets the range. Overrides DataProviderInterface::setRange
DataProvider::setRequest	public	function	Sets the request. Overrides DataProviderInterface::setRequest
DataProvider::setResourcePath	public	function	Set the resource path. Overrides DataProviderInterface::setResourcePath
DataProviderEntity::$bundles	protected	property	The entity bundles.
DataProviderEntity::$EFQClass	protected	property	The entity field query class.
DataProviderEntity::$entityType	protected	property	The entity type.
DataProviderEntity::addExtraInfoToQuery	protected	function	Adds query tags and metadata to the EntityFieldQuery. Overrides DataProvider::addExtraInfoToQuery
DataProviderEntity::addNestedFilter	protected	function	Add relational filters to EFQ.
DataProviderEntity::alterFilterQuery	protected	function	Placeholder method to alter the filters.
DataProviderEntity::alterSortQuery	protected	function	Placeholder method to alter the filters.
DataProviderEntity::canonicalPath	public	function	Generates the canonical path for a given path. Overrides DataProvider::canonicalPath
DataProviderEntity::checkEntityAccess	protected	function	Check access to CRUD an entity.	1
DataProviderEntity::checkPropertyAccess	protected static	function	Checks if the data provider user has access to the property.	1
DataProviderEntity::count	public	function	Counts the total results for the index call. Overrides CrudInterface::count
DataProviderEntity::defaultSortInfo	protected	function	Defines default sort fields if none are provided via the request URL.
DataProviderEntity::EFQObject	public	function	Gets a EFQ object. Overrides DataProviderEntityInterface::EFQObject
DataProviderEntity::entityPreSave	public	function	Allow manipulating the entity before it is saved. Overrides DataProviderEntityInterface::entityPreSave	2
DataProviderEntity::entityValidate	public	function	Validate an entity before it is saved. Overrides DataProviderEntityInterface::entityValidate
DataProviderEntity::getCacheFragments	public	function	Gets the entity context. Overrides DataProvider::getCacheFragments
DataProviderEntity::getColumnFromProperty	protected	function	Get the DB column name from a property.
DataProviderEntity::getEntityFieldQuery	protected	function	Initialize an EntityFieldQuery (or extending class).
DataProviderEntity::getEntityIdByFieldId	protected	function	Get the entity ID based on the ID provided in the request.
DataProviderEntity::getEntityInfo	protected	function	Get the entity info for the current entity the endpoint handling.
DataProviderEntity::getFieldsFromPublicNameItem	protected	function	Get the (reference) field information for a single item.
DataProviderEntity::getFieldsInfoFromPublicName	protected	function	Transform the nested public name into an array of Drupal field information.
DataProviderEntity::getIndexIds	public	function	Returns the ID to render for the current index GET request. Overrides DataProviderInterface::getIndexIds
DataProviderEntity::getQueryCount	protected	function	Prepare a query for RestfulEntityBase::count().	2
DataProviderEntity::getQueryForList	protected	function	Prepare a query for RestfulEntityBase::getList().	2
DataProviderEntity::getReferencedId	protected	function	Get referenced ID.
DataProviderEntity::getReferencedIds	protected	function	Get reference IDs for multiple values.
DataProviderEntity::initDataInterpreter	protected	function	Get the data interpreter. Overrides DataProvider::initDataInterpreter
DataProviderEntity::isMultipleValuOperator	protected static	function	Checks if the operator accepts multiple values.
DataProviderEntity::isValidConjunctionForFilter	protected static	function	Overrides DataProvider::isValidConjunctionForFilter(). Overrides DataProvider::isValidConjunctionForFilter
DataProviderEntity::isValidEntity	protected	function	Determine if an entity is valid, and accessible.
DataProviderEntity::isValidOperatorsForFilter	protected static	function	Overrides DataProvider::isValidOperatorsForFilter(). Overrides DataProvider::isValidOperatorsForFilter
DataProviderEntity::queryForListFilter	protected	function	Filter the query for list.
DataProviderEntity::queryForListPagination	protected	function	Set correct page (i.e. range) for the query for list.
DataProviderEntity::queryForListSort	protected	function	Sort the query for list.
DataProviderEntity::remove	public	function	Delete operation. Overrides CrudInterface::remove
DataProviderEntity::setPropertyValues	protected	function	Set properties of the entity based on the request, and save the entity.	2
DataProviderEntity::update	public	function	Update operation. Overrides CrudInterface::update
DataProviderEntity::validateBody	protected	function	Validates the body payload object for entities.
DataProviderEntity::validateFilters	protected	function	Validates the query parameters.
DataProviderEntity::view	public	function	Read operation. Overrides CrudInterface::view
DataProviderEntity::viewMultiple	public	function	Read operation. Overrides CrudInterface::viewMultiple
DataProviderFile::checkUploadErrors	protected	function	Checks of there is an error with the file upload and throws an exception.
DataProviderFile::create	public	function	Create operation. Overrides DataProviderEntity::create
DataProviderFile::fileSaveUpload	protected	function	An adaptation of file_save_upload() that includes more verbose errors.
DataProviderFile::isUploadedFile	protected static	function	Helper function that checks if a file was uploaded via a POST request.	1
DataProviderFile::moveUploadedFile	protected static	function	Helper function that moves an uploaded file.	1
DataProviderFile::__construct	public	function	Constructs a DataProviderFile object. Overrides DataProviderEntity::__construct

You are here

class DataProviderFile in RESTful 7.2

Hierarchy

File

Namespace

Members

API Navigation