From a18b1a649c5dd7fbb42fa2b1af0530542b8c3873 Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Mon, 18 Aug 2014 15:01:08 +0100 Subject: [PATCH 1/6] Added /matrix/content path, HS resource_for_content_repo attribute and FileUploadResource. Added stub methods. --- synapse/api/urls.py | 3 ++- synapse/app/homeserver.py | 12 +++++++++--- synapse/http/server.py | 28 ++++++++++++++++++++++++++++ synapse/server.py | 2 ++ 4 files changed, 41 insertions(+), 4 deletions(-) diff --git a/synapse/api/urls.py b/synapse/api/urls.py index 04970adb7..05ca00078 100644 --- a/synapse/api/urls.py +++ b/synapse/api/urls.py @@ -17,4 +17,5 @@ CLIENT_PREFIX = "/matrix/client/api/v1" FEDERATION_PREFIX = "/matrix/federation/v1" -WEB_CLIENT_PREFIX = "/matrix/client" \ No newline at end of file +WEB_CLIENT_PREFIX = "/matrix/client" +CONTENT_REPO_PREFIX = "/matrix/content" \ No newline at end of file diff --git a/synapse/app/homeserver.py b/synapse/app/homeserver.py index 3429a29a6..e5bd13a6e 100755 --- a/synapse/app/homeserver.py +++ b/synapse/app/homeserver.py @@ -24,9 +24,11 @@ from twisted.python.log import PythonLoggingObserver from twisted.web.resource import Resource from twisted.web.static import File from twisted.web.server import Site -from synapse.http.server import JsonResource, RootRedirect +from synapse.http.server import JsonResource, RootRedirect, FileUploadResource from synapse.http.client import TwistedHttpClient -from synapse.api.urls import CLIENT_PREFIX, FEDERATION_PREFIX, WEB_CLIENT_PREFIX +from synapse.api.urls import ( + CLIENT_PREFIX, FEDERATION_PREFIX, WEB_CLIENT_PREFIX, CONTENT_REPO_PREFIX +) from daemonize import Daemonize @@ -53,6 +55,9 @@ class SynapseHomeServer(HomeServer): def build_resource_for_web_client(self): return File("webclient") # TODO configurable? + def build_resource_for_content_repo(self): + return FileUploadResource("uploads") + def build_db_pool(self): """ Set up all the dbs. Since all the *.sql have IF NOT EXISTS, so we don't have to worry about overwriting existing content. @@ -101,7 +106,8 @@ class SynapseHomeServer(HomeServer): # [ ("/aaa/bbb/cc", Resource1), ("/aaa/dummy", Resource2) ] desired_tree = [ (CLIENT_PREFIX, self.get_resource_for_client()), - (FEDERATION_PREFIX, self.get_resource_for_federation()) + (FEDERATION_PREFIX, self.get_resource_for_federation()), + (CONTENT_REPO_PREFIX, self.get_resource_for_content_repo()) ] if web_client: logger.info("Adding the web client.") diff --git a/synapse/http/server.py b/synapse/http/server.py index bad2738bd..f86151e51 100644 --- a/synapse/http/server.py +++ b/synapse/http/server.py @@ -25,6 +25,7 @@ from twisted.web.server import NOT_DONE_YET from twisted.web.util import redirectTo import collections +import json import logging @@ -176,6 +177,33 @@ class RootRedirect(resource.Resource): return resource.Resource.getChild(self, name, request) +class FileUploadResource(resource.Resource): + isLeaf = True + + def __init__(self, directory): + resource.Resource.__init__(self) + self.directory = directory + + def render(self, request): + self._async_render(request) + return server.NOT_DONE_YET + + # @defer.inlineCallbacks + def _async_render(self, request): + request.setResponseCode(200) + request.setHeader(b"Content-Type", b"application/json") + + request.setHeader("Access-Control-Allow-Origin", "*") + request.setHeader("Access-Control-Allow-Methods", + "GET, POST, PUT, DELETE, OPTIONS") + request.setHeader("Access-Control-Allow-Headers", + "Origin, X-Requested-With, Content-Type, Accept") + + request.write(json.dumps({"url": "not_implemented"})) + request.finish() + defer.succeed("not implemented") + + def respond_with_json_bytes(request, code, json_bytes, send_cors=False): """Sends encoded JSON in response to the given request. diff --git a/synapse/server.py b/synapse/server.py index 0f7ac352a..d4c248148 100644 --- a/synapse/server.py +++ b/synapse/server.py @@ -72,6 +72,7 @@ class BaseHomeServer(object): 'resource_for_client', 'resource_for_federation', 'resource_for_web_client', + 'resource_for_content_repo', ] def __init__(self, hostname, **kwargs): @@ -140,6 +141,7 @@ class HomeServer(BaseHomeServer): resource_for_client resource_for_web_client resource_for_federation + resource_for_content_repo http_client db_pool """ From 35da1bf4a3ee6eeafec5965af05cefbb4bd3c0b5 Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Mon, 18 Aug 2014 15:50:55 +0100 Subject: [PATCH 2/6] Auth content uploads. Added a mapping function from request > filename. Added exception handling for content uploads. webclient: Only prefix the client API path on doRequest, not doBaseRequest (this would've broken the identity server auth too). Added matrixService.uploadContent. May not require mFileUpload anymore. --- synapse/app/homeserver.py | 2 +- synapse/http/server.py | 44 ++++++++++++++----- .../fileUpload/file-upload-service.js | 29 ++++++------ webclient/components/matrix/matrix-service.js | 18 ++++++-- 4 files changed, 62 insertions(+), 31 deletions(-) diff --git a/synapse/app/homeserver.py b/synapse/app/homeserver.py index e5bd13a6e..f7c1da920 100755 --- a/synapse/app/homeserver.py +++ b/synapse/app/homeserver.py @@ -56,7 +56,7 @@ class SynapseHomeServer(HomeServer): return File("webclient") # TODO configurable? def build_resource_for_content_repo(self): - return FileUploadResource("uploads") + return FileUploadResource("uploads", self.auth) def build_db_pool(self): """ Set up all the dbs. Since all the *.sql have IF NOT EXISTS, so we diff --git a/synapse/http/server.py b/synapse/http/server.py index f86151e51..7d6e225e7 100644 --- a/synapse/http/server.py +++ b/synapse/http/server.py @@ -180,28 +180,48 @@ class RootRedirect(resource.Resource): class FileUploadResource(resource.Resource): isLeaf = True - def __init__(self, directory): + def __init__(self, directory, auth, file_map_func=None): resource.Resource.__init__(self) self.directory = directory + self.auth = auth + if not file_map_func: + file_map_func = self.map_request_to_name + self.get_name_for_request = file_map_func + + @defer.inlineCallbacks + def map_request_to_name(self, request): + # auth the user + auth_user = yield self.auth.get_user_by_req(request) + logger.info("User %s is uploading a file.", auth_user) + defer.returnValue("boo2.png") def render(self, request): self._async_render(request) return server.NOT_DONE_YET - # @defer.inlineCallbacks + @defer.inlineCallbacks def _async_render(self, request): - request.setResponseCode(200) - request.setHeader(b"Content-Type", b"application/json") + try: + fname = yield self.get_name_for_request(request) - request.setHeader("Access-Control-Allow-Origin", "*") - request.setHeader("Access-Control-Allow-Methods", - "GET, POST, PUT, DELETE, OPTIONS") - request.setHeader("Access-Control-Allow-Headers", - "Origin, X-Requested-With, Content-Type, Accept") + with open(fname, "wb") as f: + f.write(request.content.read()) - request.write(json.dumps({"url": "not_implemented"})) - request.finish() - defer.succeed("not implemented") + respond_with_json_bytes(request, 200, + json.dumps({"url": "not_implemented2"}), + send_cors=True) + + except CodeMessageException as e: + logger.exception(e) + respond_with_json_bytes(request, e.code, + json.dumps(cs_exception(e))) + except Exception as e: + logger.error("Failed to store file: %s" % e) + respond_with_json_bytes( + request, + 500, + json.dumps({"error": "Internal server error"}), + send_cors=True) def respond_with_json_bytes(request, code, json_bytes, send_cors=False): diff --git a/webclient/components/fileUpload/file-upload-service.js b/webclient/components/fileUpload/file-upload-service.js index 5729d5da4..0826666fe 100644 --- a/webclient/components/fileUpload/file-upload-service.js +++ b/webclient/components/fileUpload/file-upload-service.js @@ -16,11 +16,12 @@ 'use strict'; +// TODO determine if this is really required as a separate service to matrixService. /* * Upload an HTML5 file to a server */ angular.module('mFileUpload', []) -.service('mFileUpload', ['$http', '$q', function ($http, $q) { +.service('mFileUpload', ['matrixService', '$q', function (matrixService, $q) { /* * Upload an HTML5 file to a server and returned a promise @@ -28,20 +29,18 @@ angular.module('mFileUpload', []) */ this.uploadFile = function(file) { var deferred = $q.defer(); - - // @TODO: This service runs with the do_POST hacky implementation of /synapse/demos/webserver.py. - // This is temporary until we have a true file upload service - console.log("Uploading " + file.name + "..."); - $http.post(file.name, file) - .success(function(data, status, headers, config) { - deferred.resolve(location.origin + data.url); - console.log(" -> Successfully uploaded! Available at " + location.origin + data.url); - }). - error(function(data, status, headers, config) { - console.log(" -> Failed to upload" + file.name); - deferred.reject(); - }); + console.log("Uploading " + file.name + "... to /matrix/content"); + matrixService.uploadContent(file).then( + function(response) { + console.log(" -> Successfully uploaded! Available at " + location.origin + response.data.url); + deferred.resolve(location.origin + response.data.url); + }, + function(error) { + console.log(" -> Failed to upload " + file.name); + deferred.reject(error); + } + ); return deferred.promise; }; -}]); \ No newline at end of file +}]); diff --git a/webclient/components/matrix/matrix-service.js b/webclient/components/matrix/matrix-service.js index 47828993a..b67beb007 100644 --- a/webclient/components/matrix/matrix-service.js +++ b/webclient/components/matrix/matrix-service.js @@ -54,13 +54,14 @@ angular.module('matrixService', []) params.access_token = config.access_token; + if (path.indexOf(prefixPath) !== 0) { + path = prefixPath + path; + } + return doBaseRequest(config.homeserver, method, path, params, data, undefined); }; var doBaseRequest = function(baseUrl, method, path, params, data, headers) { - if (path.indexOf(prefixPath) !== 0) { - path = prefixPath + path; - } return $http({ method: method, url: baseUrl + path, @@ -319,6 +320,17 @@ angular.module('matrixService', []) return doBaseRequest(config.identityServer, "POST", path, {}, data, headers); }, + uploadContent: function(file) { + var path = "/matrix/content"; + var headers = { + "Content-Type": undefined // undefined means angular will figure it out + }; + var params = { + access_token: config.access_token + }; + return doBaseRequest(config.homeserver, "POST", path, params, file, headers); + }, + // start listening on /events getEventStream: function(from, timeout) { var path = "/events"; From 590ab24c8544553ae5c21b729e35dcda998f1cec Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Mon, 18 Aug 2014 16:18:11 +0100 Subject: [PATCH 3/6] hs: Make the uploads directory if it doesn't exist. Namespace uploads by the base64 encoded user id of the uploader. Make a reasonable attempt to retry clashing upload paths. Try to guess a sensible file extension depending on the content type. --- synapse/http/server.py | 51 +++++++++++++++++++++++++++++++++++++----- 1 file changed, 46 insertions(+), 5 deletions(-) diff --git a/synapse/http/server.py b/synapse/http/server.py index 7d6e225e7..8502416fc 100644 --- a/synapse/http/server.py +++ b/synapse/http/server.py @@ -17,16 +17,19 @@ from syutil.jsonutil import ( encode_canonical_json, encode_pretty_printed_json ) -from synapse.api.errors import cs_exception, CodeMessageException +from synapse.api.errors import cs_exception, SynapseError, CodeMessageException +from synapse.util.stringutils import random_string from twisted.internet import defer, reactor from twisted.web import server, resource from twisted.web.server import NOT_DONE_YET from twisted.web.util import redirectTo +import base64 import collections import json import logging +import os logger = logging.getLogger(__name__) @@ -188,14 +191,52 @@ class FileUploadResource(resource.Resource): file_map_func = self.map_request_to_name self.get_name_for_request = file_map_func + if not os.path.isdir(self.directory): + os.mkdir(self.directory) + logger.info("FileUploadResource : Created %s directory.", + self.directory) + @defer.inlineCallbacks def map_request_to_name(self, request): # auth the user auth_user = yield self.auth.get_user_by_req(request) - logger.info("User %s is uploading a file.", auth_user) - defer.returnValue("boo2.png") - def render(self, request): + # namespace all file uploads on the user + prefix = base64.urlsafe_b64encode( + auth_user.to_string() + ).replace('=', '') + + # use a random string for the main portion + main_part = random_string(24) + + # suffix with a file extension if we can make one. This is nice to + # provide a hint to clients on the file information. + suffix = "" + if request.requestHeaders.hasHeader("Content-Type"): + content_type = request.requestHeaders.getRawHeaders( + "Content-Type")[0] + if (content_type.split("/")[0].lower() in + ["image", "video", "audio"]): + suffix = "." + content_type.split("/")[-1] + + file_path = os.path.join(self.directory, prefix + main_part + suffix) + logger.info("User %s is uploading a file to path %s", + auth_user.to_string(), + file_path) + + # keep trying to make a non-clashing file, with a sensible max attempts + attempts = 0 + while os.path.exists(file_path): + main_part = random_string(24) + file_path = os.path.join(self.directory, + prefix + main_part + suffix) + attempts += 1 + if attempts > 25: # really? Really? + raise SynapseError(500, "Unable to create file.") + + defer.returnValue(file_path) + + def render_POST(self, request): self._async_render(request) return server.NOT_DONE_YET @@ -208,7 +249,7 @@ class FileUploadResource(resource.Resource): f.write(request.content.read()) respond_with_json_bytes(request, 200, - json.dumps({"url": "not_implemented2"}), + json.dumps({"path": fname}), send_cors=True) except CodeMessageException as e: From 58548ab557bbbdd95644997e00777b0aec8532bc Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Mon, 18 Aug 2014 17:18:39 +0100 Subject: [PATCH 4/6] Implemented GETs for the ContentRepoResource. It all actually appears to be working. --- synapse/app/homeserver.py | 4 +- synapse/http/server.py | 71 ++++++++++++++++--- .../fileUpload/file-upload-service.js | 5 +- 3 files changed, 65 insertions(+), 15 deletions(-) diff --git a/synapse/app/homeserver.py b/synapse/app/homeserver.py index f7c1da920..ca102236c 100755 --- a/synapse/app/homeserver.py +++ b/synapse/app/homeserver.py @@ -24,7 +24,7 @@ from twisted.python.log import PythonLoggingObserver from twisted.web.resource import Resource from twisted.web.static import File from twisted.web.server import Site -from synapse.http.server import JsonResource, RootRedirect, FileUploadResource +from synapse.http.server import JsonResource, RootRedirect, ContentRepoResource from synapse.http.client import TwistedHttpClient from synapse.api.urls import ( CLIENT_PREFIX, FEDERATION_PREFIX, WEB_CLIENT_PREFIX, CONTENT_REPO_PREFIX @@ -56,7 +56,7 @@ class SynapseHomeServer(HomeServer): return File("webclient") # TODO configurable? def build_resource_for_content_repo(self): - return FileUploadResource("uploads", self.auth) + return ContentRepoResource("uploads", self.auth) def build_db_pool(self): """ Set up all the dbs. Since all the *.sql have IF NOT EXISTS, so we diff --git a/synapse/http/server.py b/synapse/http/server.py index 8502416fc..9b6ae993a 100644 --- a/synapse/http/server.py +++ b/synapse/http/server.py @@ -17,10 +17,13 @@ from syutil.jsonutil import ( encode_canonical_json, encode_pretty_printed_json ) -from synapse.api.errors import cs_exception, SynapseError, CodeMessageException +from synapse.api.errors import ( + cs_exception, SynapseError, CodeMessageException, Codes, cs_error +) from synapse.util.stringutils import random_string from twisted.internet import defer, reactor +from twisted.protocols.basic import FileSender from twisted.web import server, resource from twisted.web.server import NOT_DONE_YET from twisted.web.util import redirectTo @@ -30,7 +33,7 @@ import collections import json import logging import os - +import re logger = logging.getLogger(__name__) @@ -180,16 +183,25 @@ class RootRedirect(resource.Resource): return resource.Resource.getChild(self, name, request) -class FileUploadResource(resource.Resource): +class ContentRepoResource(resource.Resource): + """Provides file uploading and downloading. + + Uploads are POSTed to wherever this Resource is linked to. This resource + returns a "content token" which can be used to GET this content again. The + token is typically a path, but it may not be. + + In this case, the token contains 3 sections: + - User ID base64d (for namespacing content to each user) + - random string + - Content type base64d (so we can return it when clients GET it) + + """ isLeaf = True - def __init__(self, directory, auth, file_map_func=None): + def __init__(self, directory, auth): resource.Resource.__init__(self) self.directory = directory self.auth = auth - if not file_map_func: - file_map_func = self.map_request_to_name - self.get_name_for_request = file_map_func if not os.path.isdir(self.directory): os.mkdir(self.directory) @@ -210,14 +222,19 @@ class FileUploadResource(resource.Resource): main_part = random_string(24) # suffix with a file extension if we can make one. This is nice to - # provide a hint to clients on the file information. + # provide a hint to clients on the file information. We will also reuse + # this info to spit back the content type to the client. suffix = "" if request.requestHeaders.hasHeader("Content-Type"): content_type = request.requestHeaders.getRawHeaders( "Content-Type")[0] + suffix = "." + base64.urlsafe_b64encode(content_type) if (content_type.split("/")[0].lower() in ["image", "video", "audio"]): - suffix = "." + content_type.split("/")[-1] + file_ext = content_type.split("/")[-1] + # be a little paranoid and only allow a-z + file_ext = re.sub("[^a-z]", "", file_ext) + suffix += "." + file_ext file_path = os.path.join(self.directory, prefix + main_part + suffix) logger.info("User %s is uploading a file to path %s", @@ -236,6 +253,37 @@ class FileUploadResource(resource.Resource): defer.returnValue(file_path) + def render_GET(self, request): + # no auth here on purpose, to allow anyone to view, even across home + # servers. + + # TODO: A little crude here, we could do this better. + filename = request.path.split(self.directory + "/")[1] + # be paranoid + filename = re.sub("[^0-9A-z.-_]", "", filename) + + file_path = self.directory + "/" + filename + if os.path.isfile(file_path): + # filename has the content type + base64_contentype = filename.split(".")[1] + content_type = base64.urlsafe_b64decode(base64_contentype) + logger.info("Sending file %s", file_path) + f = open(file_path, 'rb') + request.setHeader('Content-Type', content_type) + d = FileSender().beginFileTransfer(f, request) + def cbFinished(ignored): + f.close() + request.finish() + d.addCallback(cbFinished) + else: + respond_with_json_bytes( + request, + 404, + json.dumps(cs_error("Not found", code=Codes.NOT_FOUND)), + send_cors=True) + + return server.NOT_DONE_YET + def render_POST(self, request): self._async_render(request) return server.NOT_DONE_YET @@ -243,13 +291,14 @@ class FileUploadResource(resource.Resource): @defer.inlineCallbacks def _async_render(self, request): try: - fname = yield self.get_name_for_request(request) + fname = yield self.map_request_to_name(request) + # TODO I have a suspcious feeling this is just going to block with open(fname, "wb") as f: f.write(request.content.read()) respond_with_json_bytes(request, 200, - json.dumps({"path": fname}), + json.dumps({"content_token": fname}), send_cors=True) except CodeMessageException as e: diff --git a/webclient/components/fileUpload/file-upload-service.js b/webclient/components/fileUpload/file-upload-service.js index 0826666fe..d620e6a4d 100644 --- a/webclient/components/fileUpload/file-upload-service.js +++ b/webclient/components/fileUpload/file-upload-service.js @@ -32,8 +32,9 @@ angular.module('mFileUpload', []) console.log("Uploading " + file.name + "... to /matrix/content"); matrixService.uploadContent(file).then( function(response) { - console.log(" -> Successfully uploaded! Available at " + location.origin + response.data.url); - deferred.resolve(location.origin + response.data.url); + var content_url = location.origin + "/matrix/content/" + response.data.content_token; + console.log(" -> Successfully uploaded! Available at " + content_url); + deferred.resolve(content_url); }, function(error) { console.log(" -> Failed to upload " + file.name); From e37b040bc3a392f2705fbabf4123b61ad6ac05ee Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Mon, 18 Aug 2014 17:22:31 +0100 Subject: [PATCH 5/6] Small amounts of cleanup and bonus round comments. --- synapse/http/server.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/synapse/http/server.py b/synapse/http/server.py index 9b6ae993a..42fb9f5e9 100644 --- a/synapse/http/server.py +++ b/synapse/http/server.py @@ -188,11 +188,13 @@ class ContentRepoResource(resource.Resource): Uploads are POSTed to wherever this Resource is linked to. This resource returns a "content token" which can be used to GET this content again. The - token is typically a path, but it may not be. + token is typically a path, but it may not be. Tokens can expire, be one-time + uses, etc. - In this case, the token contains 3 sections: + In this case, the token is a path to the file and contains 3 interesting + sections: - User ID base64d (for namespacing content to each user) - - random string + - random 24 char string - Content type base64d (so we can return it when clients GET it) """ @@ -205,7 +207,7 @@ class ContentRepoResource(resource.Resource): if not os.path.isdir(self.directory): os.mkdir(self.directory) - logger.info("FileUploadResource : Created %s directory.", + logger.info("ContentRepoResource : Created %s directory.", self.directory) @defer.inlineCallbacks @@ -271,6 +273,8 @@ class ContentRepoResource(resource.Resource): f = open(file_path, 'rb') request.setHeader('Content-Type', content_type) d = FileSender().beginFileTransfer(f, request) + + # after the file has been sent, clean up and finish the request def cbFinished(ignored): f.close() request.finish() From cdc5ffe2a2457e50790ab73cf4ceffa0c552a14d Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Mon, 18 Aug 2014 17:14:43 +0100 Subject: [PATCH 6/6] show private room_ids rather than nulls in notifs if there is no room_alias --- webclient/room/room-controller.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/webclient/room/room-controller.js b/webclient/room/room-controller.js index d130a28fd..1414fbbe6 100644 --- a/webclient/room/room-controller.js +++ b/webclient/room/room-controller.js @@ -147,7 +147,7 @@ angular.module('RoomController', ['ngSanitize']) if (document.hidden) { var notification = new window.Notification( ($scope.members[event.user_id].displayname || event.user_id) + - " (" + $scope.room_alias + ")", + " (" + ($scope.room_alias || $scope.room_id) + ")", // FIXME: don't leak room_ids here { "body": event.content.body, "icon": $scope.members[event.user_id].avatar_url,