allow served filename to be different

fixes #52

Author: guruofgentoo

keg_storage/backends/azure.py

@@ -313,6 +313,7 @@ def link_to(
             path: str,
             operation: typing.Union[base.ShareLinkOperation, str],
             expire: typing.Union[arrow.Arrow, datetime],
+            output_path: typing.Optional[str] = None,
     ) -> str:
         if not self.account_url or not self.key:
             raise ValueError('Cannot create a SAS URL without account credentials')
@@ -336,6 +337,7 @@ def link_to(
             account_key=self.key,
             permission=perms,
             expiry=expire,
+            content_disposition=f'attachment;filename={output_path}' if output_path else None,
         )
         escaped_path = urllib.parse.quote(path, safe="")
         url = urllib.parse.urljoin(self.account_url, '{}/{}'.format(self.bucket, escaped_path))

keg_storage/backends/base.py

@@ -170,7 +170,8 @@ def link_to(
             self,
             path: str,
             operation: typing.Union[ShareLinkOperation, str],
-            expire: typing.Union[arrow.Arrow, datetime]
+            expire: typing.Union[arrow.Arrow, datetime],
+            output_path: typing.Optional[str] = None,
     ) -> str:
         """
         Returns a URL allowing direct the specified operations to be performed on the given path
@@ -351,7 +352,8 @@ def link_to(
             self,
             path: str,
             operation: typing.Union[ShareLinkOperation, str],
-            expire: typing.Union[arrow.Arrow, datetime]
+            expire: typing.Union[arrow.Arrow, datetime],
+            output_path: typing.Optional[str] = None,
     ) -> str:
         """
         Create a URL pointing to the given `linked_endpoint` containing a JWT authorizing the user
@@ -380,7 +382,9 @@ def link_to(
             operation=operation,
             expire=expire
         )
-        return flask.url_for(self.linked_endpoint, token=token.decode(), _external=True)
+        return flask.url_for(
+            self.linked_endpoint, token=token.decode(), output_path=output_path, _external=True
+        )
 
 
 class FileNotFoundInStorageError(Exception):

keg_storage/backends/s3.py

@@ -268,7 +268,8 @@ def link_to(
             self,
             path: str,
             operation: typing.Union[ShareLinkOperation, str],
-            expire: typing.Union[arrow.Arrow, datetime]
+            expire: typing.Union[arrow.Arrow, datetime],
+            output_path: typing.Optional[str] = None,
     ) -> str:
         operation = ShareLinkOperation.as_operation(operation)
         if operation.name is None:
@@ -278,6 +279,8 @@ def link_to(
         extra_params = {}
         if operation == ShareLinkOperation.download:
             method = 'get_object'
+            if output_path:
+                extra_params['ResponseContentDisposition'] = f'attachment;filename={output_path}'
         elif operation == ShareLinkOperation.upload:
             method = 'put_object'
             extra_params = {'ContentType': 'application/octet-stream'}

keg_storage/plugin.py

@@ -106,10 +106,16 @@ def get(self):
         if not token_data.allow_download:
             flask.abort(403)
 
+        headers = {}
+        output_path = flask.request.args.get('output_path')
+        if output_path:
+            headers['Content-Disposition'] = f'attachment; filename={output_path}'
+
         fp = storage.open(token_data.path, backends.FileMode.read)
         return flask.Response(
             fp.iter_chunks(),
             mimetype='application/octet-stream',
+            headers=headers,
         )
 
     def on_upload_success(self, token_data: backends.InternalLinkTokenData):

keg_storage/tests/test_backend_azure.py

@@ -323,8 +323,23 @@ def test_link_to(self, expire: Union[arrow.Arrow, datetime.datetime],
         assert qs['se'] == ['2019-01-02T03:04:05Z']
         assert qs['sp'] == [perms]
         assert qs['sig']
+        assert 'rscd' not in qs
         assert 'sip' not in qs
 
+    def test_link_to_with_output_path(self):
+        expire = arrow.get(2019, 1, 2, 3, 4, 5)
+        ops = base.ShareLinkOperation.download
+        storage = create_storage()
+        url = storage.link_to(
+            'abc/def.txt',
+            operation=ops,
+            expire=expire,
+            output_path='myfile.txt',
+        )
+        parsed = urlparse.urlparse(url)
+        qs = urlparse.parse_qs(parsed.query)
+        assert qs['rscd'] == ['attachment;filename=myfile.txt']
+
     def test_sas_create_container_url(self):
         storage = backends.AzureStorage(
             **{"sas_container_url": "https://foo.blob.core.windows.net/test?sp=rwdl"}

keg_storage/tests/test_backend_s3.py

@@ -362,3 +362,25 @@ def test_link_to_success(self, m_boto, op, method, extra_params):
             ExpiresIn=3600,
             Params={'Bucket': 'bucket', 'Key': 'foo/bar', **extra_params}
         )
+
+    @freezegun.freeze_time('2020-04-27')
+    def test_link_to_download_output_path(self, m_boto):
+        op = ShareLinkOperation.download
+        method = 'get_object'
+        extra_params = {'ResponseContentDisposition': 'attachment;filename=myfile.txt'}
+        s3 = backends.S3Storage('bucket', aws_region='us-east-1')
+        s3.client.generate_presigned_url.return_value = 'https://localhost/foo'
+
+        result = s3.link_to(
+            path='foo/bar',
+            operation=op,
+            expire=arrow.get(2020, 4, 27, 1),
+            output_path='myfile.txt'
+        )
+        assert result == 'https://localhost/foo'
+
+        s3.client.generate_presigned_url.assert_called_once_with(
+            ClientMethod=method,
+            ExpiresIn=3600,
+            Params={'Bucket': 'bucket', 'Key': 'foo/bar', **extra_params}
+        )

keg_storage/tests/test_views.py

@@ -74,12 +74,31 @@ def test_get_success(self, tmp_path: pathlib.Path):
             operation=ShareLinkOperation.download,
             expire=arrow.utcnow().shift(hours=1)
         )
+        assert 'output_path' not in url
 
         resp = self.client.get(url, headers={'StorageRoot': str(tmp_path)})
         assert resp.status_code == 200
         assert resp.content_type == 'application/octet-stream'
         assert resp.body == b'foo'
 
+    def test_get_with_output_path(self, tmp_path: pathlib.Path):
+        storage = create_local_storage(tmp_path)
+        storage.upload(io.BytesIO(b'foo'), 'abc.txt')
+        assert tmp_path.joinpath('abc.txt').exists()
+
+        url = storage.link_to(
+            path='abc.txt',
+            operation=ShareLinkOperation.download,
+            expire=arrow.utcnow().shift(hours=1),
+            output_path='myfile.txt',
+        )
+
+        resp = self.client.get(url, headers={'StorageRoot': str(tmp_path)})
+        assert resp.status_code == 200
+        assert resp.content_type == 'application/octet-stream'
+        assert resp.content_disposition == 'attachment; filename=myfile.txt'
+        assert resp.body == b'foo'
+
     @pytest.mark.parametrize('method', ['post', 'put'])
     def test_post_put_operation_not_allowed(self, tmp_path: pathlib.Path, method: str):
         storage = create_local_storage(tmp_path)