?? GreyFile

?? GreyFile — Mystic File Browser

Current path: home/webdevt/prestashop17/classes/webservice/

?? Go up: /home/webdevt/prestashop17/classes

?? Editing: WebserviceSpecificManagementAttachments.php

<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

declare(strict_types=1);

use PrestaShop\PrestaShop\Core\File\FileUploader;
use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\HttpFoundation\Response;

/**
 * This class is responsible for managing Attachement through webservice
 */
class WebserviceSpecificManagementAttachmentsCore implements WebserviceSpecificManagementInterface
{
    /**
     * @var WebserviceOutputBuilder
     */
    protected $objOutput;

/**
     * @var WebserviceRequest
     */
    protected $wsObject;

/**
     * The configuration parameters of the current resource
     *
     * @var array
     */
    public $resourceConfiguration;

/**
     * @var int
     */
    protected $attachmentId;

/**
     * @var array|null
     */
    protected $displayFile;

/*
     * ------------------------------------------------
     * GETTERS & SETTERS
     * ------------------------------------------------
     */

/**
     * @param WebserviceOutputBuilder $obj
     *
     * @return WebserviceSpecificManagementInterface
     */
    public function setObjectOutput(WebserviceOutputBuilderCore $obj)
    {
        $this->objOutput = $obj;

return $this;
    }

/**
     * Get Object Output
     */
    public function getObjectOutput()
    {
        return $this->objOutput;
    }

/**
     * Set Webservice Object
     *
     * @param WebserviceRequestCore $obj
     */
    public function setWsObject(WebserviceRequestCore $obj)
    {
        $this->wsObject = $obj;

return $this;
    }

/**
     * Get Webservice Object
     */
    public function getWsObject()
    {
        return $this->wsObject;
    }

/**
     * Get content
     *
     * @return string
     */
    public function getContent()
    {
        if ($this->displayFile) {
            // if displayFile is set, present the file (download)
            $this->getObjectOutput()->setHeaderParams('Content-Type', $this->displayFile['mime']);
            $this->getObjectOutput()->setHeaderParams('Content-Length', $this->displayFile['file_size']);
            $this->getObjectOutput()->setHeaderParams('Content-Disposition', 'attachment; filename="' . utf8_decode($this->displayFile['file_name']) . '"');

return file_get_contents($this->displayFile['file']);
        }

// Emulate non-specific management
        $this->getWsObject()->setObjectSpecificManagement(null);

return '';
    }

/**
     * Manage attachements
     *
     * @return bool
     */
    public function manage()
    {
        $this->manageAttachments();

return $this->getWsObject()->getOutputEnabled();
    }

/**
     * That part was inherited from WebserviceSpecificManagementImages (which uses deeper api path).
     * Looping for 6 segments is excessive as only the [1] and [2] indices is used for attachments.
     *
     * The explanation for the mapping can be seen further down "Available cases api/...".
     * If urlSegment[1] is set to 'file', binary operations are done (file upload/download)
     * Otherwise default webservice operations are done (read/write Model information using XML/json).
     *
     * Examples:
     * [GET] https://domain.tld/api/attachments/ give a response in XML/json with all attachments.
     * [POST] https://domain.tld/api/attachments/ only creates model information (similar to any other default api), no file information.
     * [POST] https://domain.tld/api/attachments/file creates an attachment AND uploads a file for it.
     *
     * [PUT] https://domain.tld/api/attachments/$id_attachment here urlSegment[1] is id_attachment, updates model information only.
     * [PUT] https://domain.tld/api/attachments/file/$id_attachment here urlSegment[1] is 'file' and urlSegment[2] is id_attachment, updates file (binary) only.
     *
     * [GET] https://domain.tld/api/attachments/$id_attachment gives a response in XML/json for the attachment model information.
     * [GET] https://domain.tld/api/attachments/file/$id_attachment downloads the id_attachment file
     */
    public function manageAttachments()
    {
        if (isset($this->getWsObject()->urlSegment)) {
            for ($i = 1; $i < 6; ++$i) {
                if (count($this->getWsObject()->urlSegment) == $i) {
                    $this->getWsObject()->urlSegment[$i] = '';
                }
            }
        }

if ($this->getWsObject()->urlSegment[0] != '') {
            /** @var ObjectModel */
            $object = new Attachment();
            $this->getWsObject()->resourceConfiguration = $object->getWebserviceParameters();
        }

/*
         * Available cases api/...:
         *
         * [Utilizes default webservice handling by emulating non-specific management]
         *  attachments/ ("attachment_list")
         *      GET     (xml/json) (list of attachments)
         *  attachments/[1,+] ("attachment_description") (N-3)
         *      GET     (xml/json)
         *      PUT     (xml/json) (update)
         *      DELETE
         *
         * [Specific management for file upload/download}
         *  attachments/file/
         *      POST    (bin) (create new attachment)
         *      POST    (multipart) (create new attachment)
         *  attachments/file/[1,+] (file management)
         *      GET     (bin) (download file)
         *      PUT     (bin) (upload/update file)
         *      PUT    (multipart) (upload/update file)
         *      DELETE
         */
        if ($this->getWsObject()->urlSegment[1] == 'file') {
            // File handling (upload/download)
            switch ($this->getWsObject()->method) {
                case 'GET':
                case 'HEAD':
                    $this->displayFile = $this->executeFileGetAndHead();
                    break;
                case 'POST':
                case 'PUT':
                    $this->executeFileAddAndEdit();

// Emulate get/head to return output
                    $this->getWsObject()->method = 'GET';
                    $this->getWsObject()->urlSegment[1] = $this->attachmentId;
                    $this->getWsObject()->urlSegment[2] = '';
                    $this->getWsObject()->executeEntityGetAndHead();
                    break;
                case 'DELETE':
                    $attachment = new Attachment((int) $this->getWsObject()->urlSegment[1]);
                    $attachment->delete();
                    break;
            }
        } else {
            // Default handling via WebserviceRequest
            switch ($this->getWsObject()->method) {
                case 'GET':
                case 'HEAD':
                    $this->getWsObject()->executeEntityGetAndHead();
                    break;
                case 'PUT':
                    $this->getWsObject()->executeEntityPut();
                    break;
                case 'DELETE':
                    $this->getWsObject()->executeEntityDelete();
                    break;
            }
        }

// Need to set an object for the WebserviceOutputBuilder object in any case
        // because schema need to get webserviceParameters of this object
        if (isset($object)) {
            $this->getWsObject()->objects['empty'] = $object;
        }
    }

/**
     * Handles attachment file download
     *
     * @throws WebserviceException if attachment is not existing or file not available
     *
     * @return array<string, string> File details
     */
    public function executeFileGetAndHead(): array
    {
        $attachmentId = (int) $this->getWsObject()->urlSegment[2];
        $attachment = new Attachment($attachmentId);
        if (empty($attachment->id)) {
            throw new WebserviceException(
                sprintf(
                    'Attachment %d not found',
                    $attachmentId
                ),
                [
                    1,
                    Response::HTTP_INTERNAL_SERVER_ERROR,
                ]
            );
        }

// Physical file location
        $file = _PS_DOWNLOAD_DIR_ . $attachment->file;
        // Check if file exists
        if (!file_exists($file)) {
            throw new WebserviceException(
                sprintf(
                    'Unable to load the attachment file for attachment %d',
                    $attachmentId
                ),
                [
                    1,
                    Response::HTTP_INTERNAL_SERVER_ERROR,
                ]
            );
        }

// Return file details
        return [
            'file' => $file,
            'mime' => $attachment->mime,
            'file_name' => $attachment->file_name,
            'file_size' => $attachment->file_size,
        ];
    }

/**
     * Handles file upload
     *
     * Creates new attachment or replaces existing with a new file.
     * [PUT] update existing attachment file
     * [POST] create new attachment
     */
    public function executeFileAddAndEdit(): void
    {
        // Load attachment without checking the method, because of
        // PUT which is cleared the $_FILES var in multipart/form context
        $attachmentId = null;
        if (isset($this->getWsObject()->urlSegment[2])) {
            $attachmentId = (int) $this->getWsObject()->urlSegment[2];
        }

$attachment = new Attachment($attachmentId);

$maximumSize = ((int) Configuration::get('PS_ATTACHMENT_MAXIMUM_SIZE')) * 1024 * 1024;
        $uploader = new FileUploader(
            _PS_DOWNLOAD_DIR_,
            $maximumSize
        );

if (isset($_FILES['file'])) {
            // Standard HTTP upload
            $fileToUpload = $_FILES['file'];
        } else {
            // Get data from binary
            $fileToUpload = file_get_contents('php://input');
        }

try {
            $file = $uploader->upload($fileToUpload);
            if (!empty($attachment->id)) {
                unlink(_PS_DOWNLOAD_DIR_ . $attachment->file);
            }

$attachment->file = $file['id'];
            $attachment->file_name = $file['file_name'];
            $attachment->mime = $file['mime_type'];
            $attachment->name[Configuration::get('PS_LANG_DEFAULT')] = $_POST['name'] ?? $file['file_name'];

if (!empty($attachment->id)) {
                $attachment->update();
            } else {
                $attachment->add();
            }
            // Remember affected entity
            $this->attachmentId = $attachment->id;
        } catch (MaximumSizeExceeded $e) {
            $this->getWsObject()->errors[] = $this->trans(
                'The file you are trying to upload is %2$d KB, which is larger than the maximum size allowed of %1$d KB.',
                [$maximumSize, $e->getMessage()],
                'Admin.Notifications.Error'
            );
        } catch (FailedToCopyException $e) {
            $this->getWsObject()->errors[] = $this->trans(
                'Failed to copy the file.',
                [],
                'Admin.Catalog.Notification'
            );
        }
    }

/**
     * @param string $message
     * @param array $params
     * @param string $domain
     *
     * @return string
     */
    protected function trans(string $message, array $params, string $domain): string
    {
        return Context::getContext()->getTranslator()->trans($message, $params, $domain);
    }
}

?? index.php | ?? Edit | ??? Delete
?? SQLUtils.php | ?? Edit | ??? Delete
?? WebserviceException.php | ?? Edit | ??? Delete
?? WebserviceKey.php | ?? Edit | ??? Delete
?? WebserviceOutputBuilder.php | ?? Edit | ??? Delete
?? WebserviceOutputInterface.php | ?? Edit | ??? Delete
?? WebserviceOutputJSON.php | ?? Edit | ??? Delete
?? WebserviceOutputXML.php | ?? Edit | ??? Delete
?? WebserviceRequest.php | ?? Edit | ??? Delete
?? WebserviceSpecificManagementAttachments.php | ?? Edit | ??? Delete
?? WebserviceSpecificManagementImages.php | ?? Edit | ??? Delete
?? WebserviceSpecificManagementInterface.php | ?? Edit | ??? Delete
?? WebserviceSpecificManagementSearch.php | ?? Edit | ??? Delete