Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
157 lines (129 sloc) 5.76 KB
# Cheroke Admin
# Authors:
# Alvaro Lopez Ortega <>
# 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
# 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 CTK
from Rule import RulePlugin
from util import *
URL_APPLY = '/plugin/header/apply'
NOTE_HEADER = N_("Header against which the regular expression will be evaluated.")
NOTE_MATCH = N_("Regular expression.")
NOTE_TYPES = N_("It defines how this match has to be evaluated.")
NOTE_COMPLETE = N_("Match against the complete header block, rather than against a concrete header entry.")
('Accept-Encoding', 'Accept-Encoding'),
('Accept-Charset', 'Accept-Charset'),
('Accept-Language', 'Accept-Language'),
('Accept', 'Accept'),
('Authorization', 'Authorization'),
('Connection', 'Connection'),
('Content-Encoding', 'Content-Encoding'),
('Content-Length', 'Content-Length'),
('Content-Type', 'Content-Type'),
('Cookie', 'Cookie'),
('Expect', 'Expect'),
('Host', 'Host'),
('If-Modified-Since', 'If-Modified-Since'),
('If-None-Match', 'If-None-Match'),
('If-Range', 'If-Range'),
('Keep-Alive', 'Keep-Alive'),
('Location', 'Location'),
('Range', 'Range'),
('Referer', 'Referer'),
('Set-Cookie', 'Set-Cookie'),
('Transfer-Encoding', 'Transfer-Encoding'),
('Upgrade', 'Upgrade'),
('User-Agent', 'User-Agent'),
('X-Forwarded-For', 'X-Forwarded-For'),
('X-Forwarded-Host', 'X-Forwarded-Host'),
('X-Real-IP', 'X-Real-IP')
('regex', _('Matches a Regular Expression')),
('provided', _('Is Provided'))
def commit():
# POST info
key = ('key', None)
vsrv_num = ('vsrv_num', None)
new_hdr = ('tmp!header', None)
new_match = ('tmp!match', None)
new_type = ('tmp!type', None)
new_complete = ('tmp!complete', None)
# New entry
if new_hdr:
next_rule, next_pre = cfg_vsrv_rule_get_next ('vserver!%s'%(vsrv_num))
CTK.cfg['%s!match'%(next_pre)] = 'header'
CTK.cfg['%s!match!header'%(next_pre)] = new_hdr
CTK.cfg['%s!match!match'%(next_pre)] = new_match
CTK.cfg['%s!match!type'%(next_pre)] = new_type
CTK.cfg['%s!match!complete'%(next_pre)] = new_complete
return {'ret': 'ok', 'redirect': '/vserver/%s/rule/%s' %(vsrv_num, next_rule)}
# Modifications
return CTK.cfg_apply_post()
class Plugin_header (RulePlugin):
def __init__ (self, key, **kwargs):
RulePlugin.__init__ (self, key)
is_new = key.startswith('tmp')
props = ({},{'class': 'noauto'})[is_new]
type_widget = CTK.ComboCfg ('%s!type'%(key), TYPES, props)
type_val = CTK.cfg.get_val ('%s!type'%(key), 'regex')
complete_val = int (CTK.cfg.get_val ('%s!complete'%(key), '0'))
complete = CTK.CheckCfgText ('%s!complete'%(key), False, _('Full header'), props)
table = CTK.PropsTable()
table.Add (_("Complete Header"), complete, _(NOTE_COMPLETE))
if is_new or not complete_val:
table.Add (_('Header'), CTK.ComboCfg('%s!header'%(key), HEADERS, props), _(NOTE_HEADER))
if is_new or not complete_val:
table.Add (_('Type'), type_widget, _(NOTE_TYPES))
if is_new or type_val == 'regex' or complete_val:
table.Add (_('Regular Expression'), CTK.TextCfg('%s!match'%(key), False, props), _(NOTE_MATCH))
if is_new:
type_widget.bind ('change',
"""if ($('#%(type_widget)s').val() == 'regex') {
} else {
}""" %({'type_widget':, 'regex': table[2].id}))
complete.bind ('change',
"""if (! $('#%(complete)s :checkbox')[0].checked) {
} else {
}""" %({'complete':, 'row1': table[1].id, 'row2': table[2].id}))
submit = CTK.Submitter (URL_APPLY)
submit += CTK.Hidden ('key', key)
submit += CTK.Hidden ('vsrv_num', kwargs.pop('vsrv_num', ''))
submit += table
self += submit
# Validation, and Public URLs
CTK.publish ("^%s"%(URL_APPLY), commit, method="POST")
def GetName (self):
header = CTK.cfg.get_val ('%s!header' %(self.key), '')
match = CTK.cfg.get_val ('%s!match' %(self.key), '')
type_ = CTK.cfg.get_val ('%s!type' %(self.key), '')
complete = int (CTK.cfg.get_val ('%s!complete' %(self.key), '0'))
if complete:
return "%s ~ %s" %(_('Header'), match)
if type_ == 'provided':
return _("Header %(header)s is provided") %(locals())
return "%s %s ~ %s" % (_('Header'), header, match)
Jump to Line
Something went wrong with that request. Please try again.