Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix auth header and filename=undefined #659

Merged
merged 3 commits into from
Jun 18, 2018
Merged

fix auth header and filename=undefined #659

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e3b1bf
use Authorization header in media/v1/upload if enabled, instead of query
t3chguy Jun 15, 2018
c0b2151
allow omitting filename from upload entirely
t3chguy Jun 15, 2018
7fe3e2f
invert argument to make it positive without breaking backwards compat
t3chguy Jun 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/base-apis.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1071,6 +1071,10 @@ MatrixBaseApis.prototype.searchUserDirectory = function(opts) {
* @param {string=} opts.name Name to give the file on the server. Defaults
* to <tt>file.name</tt>.
*
* @param {boolean=} opts.omitFilename if true will not send the filename,
* e.g for encrypted file uploads where filename leaks are undesirable.
* Defaults to false.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to bang my, "positive arguments" drum again, ie. if (includeFilename) vs if (!omitFilename)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But then it's a breaking change unless you mean to default it to true

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, suggesting defaulting to true

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed that for you :)

*
* @param {string=} opts.type Content-type for the upload. Defaults to
* <tt>file.type</tt>, or <tt>applicaton/octet-stream</tt>.
*
Expand Down
32 changes: 27 additions & 5 deletions src/http-api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@ module.exports.MatrixHttpApi.prototype = {
* @param {string=} opts.name Name to give the file on the server. Defaults
* to <tt>file.name</tt>.
*
* @param {boolean=} opts.omitFilename if true will not send the filename,
* e.g for encrypted file uploads where filename leaks are undesirable.
* Defaults to false.
*
* @param {string=} opts.type Content-type for the upload. Defaults to
* <tt>file.type</tt>, or <tt>applicaton/octet-stream</tt>.
*
Expand Down Expand Up @@ -272,20 +276,38 @@ module.exports.MatrixHttpApi.prototype = {
}
});
let url = this.opts.baseUrl + "/_matrix/media/v1/upload";
url += "?access_token=" + encodeURIComponent(this.opts.accessToken);
url += "&filename=" + encodeURIComponent(fileName);

const queryArgs = [];

if (!opts.omitFilename && fileName) {
queryArgs.push("filename=" + encodeURIComponent(fileName));
}

if (!this.useAuthorizationHeader) {
queryArgs.push("access_token="
+ encodeURIComponent(this.opts.accessToken));
}

if (queryArgs.length > 0) {
url += "?" + queryArgs.join("&");
}

xhr.open("POST", url);
if (this.useAuthorizationHeader) {
xhr.setRequestHeader("Authorization", "Bearer " + this.opts.accessToken);
}
xhr.setRequestHeader("Content-Type", contentType);
xhr.send(body);
promise = defer.promise;

// dirty hack (as per _request) to allow the upload to be cancelled.
promise.abort = xhr.abort.bind(xhr);
} else {
const queryParams = {
filename: fileName,
};
const queryParams = {};

if (!opts.omitFilename && fileName) {
queryParams.filename = fileName;
}

promise = this.authedRequest(
opts.callback, "POST", "/upload", queryParams, body, {
Expand Down