summaryrefslogtreecommitdiffstats
path: root/deluge/ui/web/common.py
blob: 39c885abf800829f1b995a8ccda195ee2645b4f3 (plain)
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
#
# deluge/ui/web/common.py
#
# Copyright (C) 2009 Damien Churchill <damoxc@gmail.com>
#
# Deluge is free software.
#
# You may redistribute it and/or modify it under the terms of the
# GNU General Public License, as published by the Free Software
# Foundation; either version 3 of the License, or (at your option)
# any later version.
#
# deluge is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with deluge.    If not, write to:
#   The Free Software Foundation, Inc.,
#   51 Franklin Street, Fifth Floor
#   Boston, MA  02110-1301, USA.
#
#    In addition, as a special exception, the copyright holders give
#    permission to link the code of portions of this program with the OpenSSL
#    library.
#    You must obey the GNU General Public License in all respects for all of
#    the code used other than OpenSSL. If you modify file(s) with this
#    exception, you may extend this exception to your version of the file(s),
#    but you are not obligated to do so. If you do not wish to do so, delete
#    this exception statement from your version. If you delete this exception
#    statement from all source files in the program, then also delete it here.
#
#

import zlib
import gettext
from deluge import common

from twisted.web.resource import Resource as _Resource

_ = lambda x: gettext.gettext(x).decode("utf-8")

def escape(text):
    """
    Used by the gettext.js template to escape translated strings
    so they don't break the script.
    """
    text = text.replace("'", "\\'")
    text = text.replace('\r\n', '\\n')
    text = text.replace('\r', '\\n')
    text = text.replace('\n', '\\n')
    return text

def compress(contents, request):
    request.setHeader("content-encoding", "gzip")
    compress = zlib.compressobj(6, zlib.DEFLATED, zlib.MAX_WBITS + 16,
        zlib.DEF_MEM_LEVEL,0)
    contents = compress.compress(contents)
    contents += compress.flush()
    return contents

try:
    # This is beeing done like this in order to allow tests to use the above
    # `compress` without requiring Mako to be instaled
    from mako.template import Template as MakoTemplate
    class Template(MakoTemplate):
        """
        A template that adds some built-ins to the rendering
        """

        builtins = {
            "_": _,
            "escape": escape,
            "version": common.get_version()
        }

        def render(self, *args, **data):
            data.update(self.builtins)
            rendered = MakoTemplate.render_unicode(self, *args, **data)
            return rendered.encode('utf-8', 'replace')
except ImportError:
    import warnings
    warnings.warn("The Mako library is required to run deluge.ui.web",
                  RuntimeWarning)
    class Template(object):
        def __new__(cls, *args, **kwargs):
            raise RuntimeError(
                "The Mako library is required to run deluge.ui.web"
            )

class Resource(_Resource):

    def render(self, request):
        request.setHeader("x-powered-by", "Rum")
        request.setHeader("x-accept-rum",
                          "Morgans Spiced, Sailor Jerry, Bundaberg")