-
Notifications
You must be signed in to change notification settings - Fork 104
/
flcache.py
212 lines (171 loc) · 7.18 KB
/
flcache.py
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# -*- coding: utf-8 -*-
#
# Cherokee-admin's Common Static wizard
#
# Authors:
# Alvaro Lopez Ortega <alvaro@alobbs.com>
#
# Copyright (C) 2001-2014 Alvaro Lopez Ortega
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of version 2 of the GNU General Public
# License as published by the Free Software Foundation.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
import re
import CTK
import Wizard
from util import *
from configured import *
NOTE_WELCOME_H1 = N_("Welcome to the Cache wizard")
NOTE_WELCOME_P1 = N_("This wizard adds a rule to configure the cache mechanism shipped with Cherokee.")
NOTE_WELCOME_P2 = N_("It will boost the performance of your virtual server by caching content, and thus optimizing subsequent requests of the same Web resource.")
NOTE_POLICY = N_("What do you want the server to cache?")
NOTE_AUTH = N_("Enable HTTP's PURGE method, so cache object can be purged remotely.")
NOTE_ENC_EXTS = N_("Which extensions you want the Cache to store?")
NOTE_ADMIN_USER = N_("Administration user name")
NOTE_ADMIN_PASSWORD = N_("Administration user's password")
PREFIX = 'tmp!wizard!flcache'
URL_APPLY = r'/wizard/vserver/flcache/apply'
POLICIES = [
('dynamic', N_('Cacheable Dynamic Responses')),
('encoded', N_('Encoded responses of static files'))
]
ENCODED_EXTS_DEFAULT = "js,css,html,htm,xml"
ENCODED_EXTS_CONF = """
%(rule_pre)s!match!final = 0
%(rule_pre)s!match = and
%(rule_pre)s!match!left = extensions
%(rule_pre)s!match!left!check_local_file = 0
%(rule_pre)s!match!left!extensions = %(extensions)s
%(rule_pre)s!match!right = header
%(rule_pre)s!match!right!complete = 0
%(rule_pre)s!match!right!header = Accept-Encoding
%(rule_pre)s!match!right!type = provided
%(rule_pre)s!flcache = allow
%(rule_pre)s!flcache!policy = all_but_forbidden
%(rule_pre)s!encoder!gzip = allow
"""
GLOBAL_CACHE_CONF = """
%(rule_pre)s!match!final = 0
%(rule_pre)s!match = directory
%(rule_pre)s!match!directory = /
%(rule_pre)s!flcache = allow
%(rule_pre)s!flcache!policy = explicitly_allowed
"""
PURGE_METHOD_CONF = """
%(rule_pre)s!match!final = 1
%(rule_pre)s!match = method
%(rule_pre)s!match!method = purge
%(rule_pre)s!handler = admin
%(rule_pre)s!auth = authlist
%(rule_pre)s!auth!methods = digest
%(rule_pre)s!auth!realm = Front-Line Cache
%(rule_pre)s!auth!list!1!password = %(password)s
%(rule_pre)s!auth!list!1!user = %(username)s
"""
class Commit:
def Commit_Rule (self):
vsrv_num = CTK.cfg.get_val ('%s!vsrv_num'%(PREFIX))
tipe = CTK.cfg.get_val ('%s!policy' %(PREFIX))
purge = int (CTK.cfg.get_val('%s!purge'%(PREFIX), "0"))
vsrv_pre = 'vserver!%s' %(vsrv_num)
# Next rule
x, rule_pre = cfg_vsrv_rule_get_next (vsrv_pre)
if tipe == 'encoded':
# Encoded content
extensions = CTK.cfg.get_val ('%s!encoded_exts'%(PREFIX))
config = ENCODED_EXTS_CONF % (locals())
else:
# General caching
config = GLOBAL_CACHE_CONF % (locals())
# Apply the config
CTK.cfg.apply_chunk (config)
CTK.cfg.normalize ('%s!rule'%(vsrv_pre))
# Purge
if purge:
x, rule_pre = cfg_vsrv_rule_get_next (vsrv_pre)
username = CTK.cfg.get_val ('%s!admin!username'%(PREFIX))
password = CTK.cfg.get_val ('%s!admin!password'%(PREFIX))
config = PURGE_METHOD_CONF % (locals())
# Apply the config
CTK.cfg.apply_chunk (config)
CTK.cfg.normalize ('%s!rule'%(vsrv_pre))
del (CTK.cfg[PREFIX])
return CTK.cfg_reply_ajax_ok()
def __call__ (self):
if CTK.post.pop('final'):
CTK.cfg_apply_post()
return self.Commit_Rule()
return CTK.cfg_apply_post()
class Create:
def __call__ (self):
cont = CTK.Container()
# Basic Funcionality
combo_type = CTK.ComboCfg ('%s!policy'%(PREFIX), trans_options(POLICIES))
table = CTK.PropsTable()
table.Add (_('Type of Caching'), combo_type, _(NOTE_POLICY))
encoded_table = CTK.PropsTable ()
encoded_table.Add (_('Extensions'), CTK.TextCfg ('%s!encoded_exts'%(PREFIX), False, {'value': ENCODED_EXTS_DEFAULT}), _(NOTE_ENC_EXTS))
encoded_box = CTK.Box ({'style':'display:none;'})
encoded_box += encoded_table
combo_type.bind ('change',
"if ($(this).val() == 'dynamic') {%s} else {%s}"
%(encoded_box.JS_to_hide(), encoded_box.JS_to_show()))
submit = CTK.Submitter (URL_APPLY)
submit += table
submit += encoded_box
cont += CTK.RawHTML ("<h2>%s</h2>" %(_("Basic Functionality")))
cont += submit
# PURGE
check_auth = CTK.CheckCfgText ('%s!purge'%(PREFIX), False, _("Enable"))
table = CTK.PropsTable()
table.Add (_('Enable PURGE requests'), check_auth, _(NOTE_AUTH))
admin_table = CTK.PropsTable()
admin_table.Add (_('Admin Username'), CTK.TextCfg ('%s!admin!username'%(PREFIX), False, {'class':'noauto'}), _(NOTE_ADMIN_USER))
admin_table.Add (_('Admin Password'), CTK.TextCfg ('%s!admin!password'%(PREFIX), False, {'class':'noauto'}), _(NOTE_ADMIN_PASSWORD))
admin_box = CTK.Box ({'style':'display:none;'})
admin_box += admin_table
check_auth.bind ('change',
"if ($(this).find(':checked').size() <= 0) {%s} else {%s}"
%(admin_box.JS_to_hide(), admin_box.JS_to_show()))
submit = CTK.Submitter (URL_APPLY)
submit += table
submit += admin_box
cont += CTK.RawHTML ("<h2>%s</h2>" %(_("Purge of Cache Objects")))
cont += submit
# Global Submit
submit = CTK.Submitter (URL_APPLY)
submit += CTK.Hidden('final', '1')
cont += submit
cont += CTK.DruidButtonsPanel_PrevCreate_Auto()
return cont.Render().toStr()
class Welcome:
def __call__ (self):
cont = CTK.Container()
cont += CTK.RawHTML ('<h2>%s</h2>' %(_(NOTE_WELCOME_H1)))
cont += Wizard.Icon ('flcache', {'class': 'wizard-descr'})
box = CTK.Box ({'class': 'wizard-welcome'})
box += CTK.RawHTML ('<p>%s</p>' %(_(NOTE_WELCOME_P1)))
box += CTK.RawHTML ('<p>%s</p>' %(_(NOTE_WELCOME_P2)))
cont += box
# Send the VServer num
tmp = re.findall (r'^/wizard/vserver/(\d+)/', CTK.request.url)
submit = CTK.Submitter (URL_APPLY)
submit += CTK.Hidden('%s!vsrv_num'%(PREFIX), tmp[0])
cont += submit
cont += CTK.DruidButtonsPanel_Next_Auto()
return cont.Render().toStr()
# Rule
CTK.publish ('^/wizard/vserver/(\d+)/flcache$', Welcome)
CTK.publish ('^/wizard/vserver/(\d+)/flcache/2', Create)
CTK.publish (r'^%s'%(URL_APPLY), Commit, method="POST")