DownloadAction created

Author: klimov-paul

DownloadAction.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * @link https://github.com/yii2tech
+ * @copyright Copyright (c) 2015 Yii2tech
+ * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
+ */
+
+namespace yii2tech\filestorage;
+
+use Yii;
+use yii\base\Action;
+use yii\di\Instance;
+use yii\helpers\FileHelper;
+use yii\web\NotFoundHttpException;
+use yii\web\Response;
+
+/**
+ * DownloadAction
+ *
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 1.1.0
+ */
+class DownloadAction extends Action
+{
+    /**
+     * @var StorageInterface|array|string file storage object or the application component ID of the file storage.
+     */
+    public $fileStorage = 'fileStorage';
+    /**
+     * @var array list of bucket names that this action should allow to use. If this property is not set,
+     * then the action allows to all buckets available in [[fileStorage]], unless they are listed in [[exceptBuckets]].
+     * If a bucket name appears in both [[onlyBuckets]] and [[exceptBuckets]], this action will NOT allow it to be used.
+     */
+    public $onlyBuckets;
+    /**
+     * @var array list of the bucket names, that this action should not allow to use.
+     * @see onlyBuckets
+     */
+    public $exceptBuckets = [];
+
+
+    /**
+     * Runs the action.
+     * @param string $bucket name of the file source bucket
+     * @param string $filename name of the file to be downloaded.
+     * @return Response response.
+     * @throws NotFoundHttpException if bucket or file does not exist.
+     */
+    public function run($bucket, $filename)
+    {
+        if (!$this->isBucketAllowed($bucket)) {
+            throw new NotFoundHttpException("Bucket '{$bucket}' does not exist.");
+        }
+
+        $this->fileStorage = Instance::ensure($this->fileStorage, 'yii2tech\filestorage\StorageInterface');
+
+        if (!$this->fileStorage->hasBucket($bucket)) {
+            throw new NotFoundHttpException("Bucket '{$bucket}' does not exist.");
+        }
+
+        $bucket = $this->fileStorage->getBucket($bucket);
+
+        if (!$bucket->fileExists($filename)) {
+            throw new NotFoundHttpException("File '{$filename}' does not exist at bucket '{$bucket->getName()}' does not exist.");
+        }
+
+        $response = Yii::$app->getResponse();
+        $response->content = $bucket->getFileContent($filename);
+
+        $response->format = Response::FORMAT_RAW;
+
+        $mimeType = FileHelper::getMimeTypeByExtension($filename);
+        if (empty($mimeType)) {
+            $mimeType = 'application/octet-stream';
+        }
+
+        $response->getHeaders()->add('Content-Type', $mimeType);
+
+        return $response;
+    }
+
+    /**
+     * Returns a value indicating whether the download from the specified bucket is allowed or not.
+     * @param string $bucketName the name of the bucket.
+     * @return boolean whether the download from the bucket is allowed or not.
+     */
+    protected function isBucketAllowed($bucketName)
+    {
+        return !in_array($bucketName, $this->exceptBuckets, true) && (empty($this->onlyBuckets) || in_array($bucketName, $this->onlyBuckets, true));
+    }
+}