summary refs log tree commit diff
path: root/synapse/rest/media/v1/filepath.py
blob: c5d43209f912b059a305052002a4b89b15a85c5c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# -*- coding: utf-8 -*-
# Copyright 2014-2016 OpenMarket Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os


class MediaFilePaths(object):

    def __init__(self, base_path):
        self.base_path = base_path

    def default_thumbnail(self, default_top_level, default_sub_type, width,
                          height, content_type, method):
        top_level_type, sub_type = content_type.split("/")
        file_name = "%i-%i-%s-%s-%s" % (
            width, height, top_level_type, sub_type, method
        )
        return os.path.join(
            self.base_path, "default_thumbnails", default_top_level,
            default_sub_type, file_name
        )

    def local_media_filepath(self, media_id):
        return os.path.join(
            self.base_path, "local_content",
            media_id[0:2], media_id[2:4], media_id[4:]
        )

    def local_media_thumbnail(self, media_id, width, height, content_type,
                              method):
        top_level_type, sub_type = content_type.split("/")
        file_name = "%i-%i-%s-%s-%s" % (
            width, height, top_level_type, sub_type, method
        )
        return os.path.join(
            self.base_path, "local_thumbnails",
            media_id[0:2], media_id[2:4], media_id[4:],
            file_name
        )

    def remote_media_filepath(self, server_name, file_id):
        return os.path.join(
            self.base_path, "remote_content", server_name,
            file_id[0:2], file_id[2:4], file_id[4:]
        )

    def remote_media_thumbnail(self, server_name, file_id, width, height,
                               content_type, method):
        top_level_type, sub_type = content_type.split("/")
        file_name = "%i-%i-%s-%s" % (width, height, top_level_type, sub_type)
        return os.path.join(
            self.base_path, "remote_thumbnail", server_name,
            file_id[0:2], file_id[2:4], file_id[4:],
            file_name
        )

    def remote_media_thumbnail_dir(self, server_name, file_id):
        return os.path.join(
            self.base_path, "remote_thumbnail", server_name,
            file_id[0:2], file_id[2:4], file_id[4:],
        )

    def url_cache_filepath(self, media_id):
        # Media id is of the form <DATE><RANDOM_STRING>
        # E.g.: 2017-09-28-fsdRDt24DS234dsf
        return os.path.join(
            self.base_path, "url_cache",
            media_id[:10], media_id[11:]
        )

    def url_cache_filepath_dirs_to_delete(self, media_id):
        "The dirs to try and remove if we delete the media_id file"
        return [
            os.path.join(
                self.base_path, "url_cache",
                media_id[:10],
            ),
        ]

    def url_cache_thumbnail(self, media_id, width, height, content_type,
                            method):
        # Media id is of the form <DATE><RANDOM_STRING>
        # E.g.: 2017-09-28-fsdRDt24DS234dsf

        top_level_type, sub_type = content_type.split("/")
        file_name = "%i-%i-%s-%s-%s" % (
            width, height, top_level_type, sub_type, method
        )

        return os.path.join(
            self.base_path, "url_cache_thumbnails",
            media_id[:10], media_id[11:],
            file_name
        )

    def url_cache_thumbnail_directory(self, media_id):
        # Media id is of the form <DATE><RANDOM_STRING>
        # E.g.: 2017-09-28-fsdRDt24DS234dsf

        return os.path.join(
            self.base_path, "url_cache_thumbnails",
            media_id[:10], media_id[11:],
        )

    def url_cache_thumbnail_dirs_to_delete(self, media_id):
        "The dirs to try and remove if we delete the media_id thumbnails"
        # Media id is of the form <DATE><RANDOM_STRING>
        # E.g.: 2017-09-28-fsdRDt24DS234dsf
        return [
            os.path.join(
                self.base_path, "url_cache_thumbnails",
                media_id[:10], media_id[11:],
            ),
            os.path.join(
                self.base_path, "url_cache_thumbnails",
                media_id[:10],
            ),
        ]