backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-15 00:03:28 +01:00
Code Issues Projects Releases Activity

rewrite/banner: add a seperate 'banner_html' setting which allows

Browse Source 
overriding just the banner (and not the entire head_insert). Setting
banner_html: False will disable the banner, or setting to a custom
template will insert that template. Default template loads
default_banner.js which does the actual initialization.
This commit is contained in:
Ilya Kreymer 2014-10-17 08:28:06 -07:00
parent b7a098a9a7
commit 0efa2dc0ad
8 changed files with 125 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGES.rst
View File

@ -1,6 +1,12 @@
pywb 0.6.1 changelist pywb 0.6.1 changelist
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
* Easier to customize just the banner html, via `banner_html` setting in the config. Default banner uses ui/banner.html and inserts the script default_banner.js, which creates the banner.
Other implementations may create banner via custom JS or directly insert HTML, as needed. Setting `banner_html: False` will disable the banner.
* Small improvements to streaming response, read in fixed chunks to allow better streaming from live.
* New, implified notation for fuzzy match rules on query params (See: `Fuzzy Match Rules <https://github.com/ikreymer/pywb/wiki/Fuzzy-Match-Rules>`_) * New, implified notation for fuzzy match rules on query params (See: `Fuzzy Match Rules <https://github.com/ikreymer/pywb/wiki/Fuzzy-Match-Rules>`_)

5
config.yaml
View File

@ -73,6 +73,11 @@ enable_http_proxy: true
# template for <head> insert into replayed html content # template for <head> insert into replayed html content
#head_insert_html: ui/head_insert.html #head_insert_html: ui/head_insert.html
#
#
# template for just the banner modifications
# set to False to disable completely
#banner_html: banner.html
# template to for 'calendar' query, # template to for 'calendar' query,
# eg, a listing of captures in response to a ../*/<url> # eg, a listing of captures in response to a ../*/<url>

65
pywb/static/default_banner.js Normal file
View File

@ -0,0 +1,65 @@
/*
Copyright(c) 2013-2014 Ilya Kreymer. Released under the GNU General Public License.
This file is part of pywb.
pywb is free software: you can 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.
pywb 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 pywb. If not, see <http://www.gnu.org/licenses/>.
*/
// Creates the default pywb banner.
// Override this function/script to create a different type of banner
_wb_js.create_banner_element = function(banner_id)
{
var banner_labels = {LOADING_MSG: "Loading...",
REPLAY_MSG: "This is an <b>archived</b> page from ",
LIVE_MSG: "This is a <b>live</b> page loaded on "};
var banner = document.createElement("wb_div");
banner.setAttribute("id", banner_id);
banner.setAttribute("lang", "en");
var text;
if (wbinfo.is_frame) {
text = banner_labels.LOADING_MSG;
} else if (wbinfo.is_live) {
text = banner_labels.LIVE_MSG;
} else {
text = banner_labels.REPLAY_MSG;
}
text = "<span id='_wb_label'>" + text + "</span>";
var capture_str = "";
if (wbinfo && wbinfo.timestamp) {
capture_str = _wb_js.ts_to_date(wbinfo.timestamp, true);
}
text += "<b id='_wb_capture_info'>" + capture_str + "</b>";
if (wbinfo.proxy_magic && wbinfo.url) {
var select_url = wbinfo.proxy_magic + "/" + wbinfo.url;
var query_url = wbinfo.proxy_magic + "/*/" + wbinfo.url;
text += '&nbsp;<a href="//query.' + query_url + '">All Capture Times</a>';
text += '<br/>'
text += 'From collection <b>"' + wbinfo.coll + '"</b>&nbsp;<a href="//select.' + select_url + '">All Collections</a>';
}
banner.innerHTML = text;
document.body.insertBefore(banner, document.body.firstChild);
}

80
pywb/static/wb.js
View File

@ -17,12 +17,7 @@ This file is part of pywb.
along with pywb. If not, see <http://www.gnu.org/licenses/>. along with pywb. If not, see <http://www.gnu.org/licenses/>.
*/ */
_wb_js = (function() { function __WbJsInit() {
var labels = {LOADING_MSG: "Loading...",
REPLAY_MSG: "This is an <b>archived</b> page from ",
LIVE_MSG: "This is a <b>live</b> page loaded on "};
function init_banner() { function init_banner() {
@ -40,49 +35,19 @@ function init_banner() {
bid = PLAIN_BANNER_ID; bid = PLAIN_BANNER_ID;
} }
var banner = document.getElementById(bid); if (document.getElementById(bid) != null) {
if (banner) {
return; return;
} }
banner = document.createElement("wb_div");
banner.setAttribute("id", bid);
banner.setAttribute("lang", "en");
var text;
if (wbinfo.is_frame) {
text = labels.LOADING_MSG;
} else if (wbinfo.is_live) {
text = labels.LIVE_MSG;
} else {
text = labels.REPLAY_MSG;
}
text = "<span id='_wb_label'>" + text + "</span>"; _wb_js.create_banner_element(bid);
var capture_str = "";
if (wbinfo && wbinfo.timestamp) {
capture_str = ts_to_date(wbinfo.timestamp, true);
}
text += "<b id='_wb_capture_info'>" + capture_str + "</b>";
if (wbinfo.proxy_magic && wbinfo.url) {
var select_url = wbinfo.proxy_magic + "/" + wbinfo.url;
var query_url = wbinfo.proxy_magic + "/*/" + wbinfo.url;
text += '&nbsp;<a href="//query.' + query_url + '">All Capture Times</a>';
text += '<br/>'
text += 'From collection <b>"' + wbinfo.coll + '"</b>&nbsp;<a href="//select.' + select_url + '">All Collections</a>';
}
banner.innerHTML = text;
document.body.insertBefore(banner, document.body.firstChild);
} }
function ts_to_date(ts, is_gmt) this.create_banner_element = function() {
// No banner by default
return null;
}
this.ts_to_date = function(ts, is_gmt)
{ {
if (ts.length < 14) { if (ts.length < 14) {
return ts; return ts;
@ -147,22 +112,21 @@ function notify_top() {
remove_event("readystatechange", notify_top, document); remove_event("readystatechange", notify_top, document);
} }
if ((window.self == window.top) && wbinfo) { this.load = function() {
if (wbinfo.canon_url && (window.location.href != wbinfo.canon_url) && wbinfo.mod != "bn_") { if ((window.self == window.top) && wbinfo) {
// Auto-redirect to top frame if (wbinfo.canon_url && (window.location.href != wbinfo.canon_url) && wbinfo.mod != "bn_") {
window.location.replace(wbinfo.canon_url); // Auto-redirect to top frame
} else { window.location.replace(wbinfo.canon_url);
// Init Banner (no frame or top frame) } else {
add_event("readystatechange", init_banner, document); // Init Banner (no frame or top frame)
add_event("readystatechange", init_banner, document);
}
} else if (window.self != window.parent && window.parent.update_wb_url) {
add_event("readystatechange", notify_top, document);
} }
} else if (window.self != window.parent && window.parent.update_wb_url) {
add_event("readystatechange", notify_top, document);
} }
};
return {
'labels': labels,
'ts_to_date': ts_to_date
};
})(); _wb_js = new __WbJsInit();

2
pywb/ui/banner.html Normal file
View File

@ -0,0 +1,2 @@
<!-- default banner, create through js -->
<script src='{{ wbrequest.host_prefix }}/{{ static_path }}/default_banner.js'> </script>

7
pywb/ui/head_insert.html
View File

@ -21,8 +21,15 @@
wbinfo.coll = "{{ wbrequest.coll }}"; wbinfo.coll = "{{ wbrequest.coll }}";
wbinfo.proxy_magic = "{{ wbrequest.env.pywb_proxy_magic }}"; wbinfo.proxy_magic = "{{ wbrequest.env.pywb_proxy_magic }}";
</script> </script>
<script src='{{ wbrequest.host_prefix }}/{{ static_path }}/wb.js'> </script> <script src='{{ wbrequest.host_prefix }}/{{ static_path }}/wb.js'> </script>
{% include banner_html ignore missing %}
<link rel='stylesheet' href='{{ wbrequest.host_prefix }}/{{ static_path }}/wb.css'/> <link rel='stylesheet' href='{{ wbrequest.host_prefix }}/{{ static_path }}/wb.css'/>
<!-- load banner -->
<script> if (_wb_js) { _wb_js.load(); }</script>
<!-- End WB Insert --> <!-- End WB Insert -->

2
pywb/webapp/pywb_init.py
View File

@ -29,6 +29,8 @@ DEFAULTS = {
'archive_paths': './sample_archive/warcs/', 'archive_paths': './sample_archive/warcs/',
'head_insert_html': 'ui/head_insert.html', 'head_insert_html': 'ui/head_insert.html',
'banner_html': 'banner.html',
'query_html': 'ui/query.html', 'query_html': 'ui/query.html',
'search_html': 'ui/search.html', 'search_html': 'ui/search.html',
'home_html': 'ui/index.html', 'home_html': 'ui/index.html',

26
pywb/webapp/views.py
View File

@ -72,15 +72,17 @@ class J2TemplateView(object):
def __init__(self, filename): def __init__(self, filename):
template_dir, template_file = path.split(filename) template_dir, template_file = path.split(filename)
self.template_file = template_file self.template_file = template_file
self.jinja_env = self.make_jinja_env(template_dir) self.jinja_env = self.make_jinja_env(template_dir)
def make_jinja_env(self, template_dir): def make_jinja_env(self, template_dir):
filesys_loader = FileSystemLoader(template_dir) loaders = []
pkg_loader = PackageLoader(self.env_globals['package'], template_dir) loaders.append(FileSystemLoader(template_dir))
loader = ChoiceLoader([filesys_loader, pkg_loader]) loaders.append(FileSystemLoader('.'))
loaders.append(PackageLoader(self.env_globals['package'], template_dir))
loader = ChoiceLoader(loaders)
jinja_env = Environment(loader=loader, trim_blocks=True) jinja_env = Environment(loader=loader, trim_blocks=True)
jinja_env.filters.update(FILTERS) jinja_env.filters.update(FILTERS)
@ -133,20 +135,24 @@ class HeadInsertView(J2TemplateView):
canon_url=canon_url, canon_url=canon_url,
include_ts=include_ts, include_ts=include_ts,
include_wombat=include_wombat, include_wombat=include_wombat,
banner_html=self.banner_html,
rule=rule)) rule=rule))
return make_head_insert return make_head_insert
@staticmethod
def create_template(filename, desc=''):
return J2TemplateView.create_template(filename, desc,
HeadInsertView)
@staticmethod @staticmethod
def init_from_config(config): def init_from_config(config):
view = config.get('head_insert_view') view = config.get('head_insert_view')
if not view: if not view:
html = config.get('head_insert_html', 'ui/head_insert.html') html = config.get('head_insert_html', 'ui/head_insert.html')
view = HeadInsertView.create_template(html, 'Head Insert')
if html:
banner_html = config.get('banner_html', 'banner.html')
view = HeadInsertView(html)
logging.debug('Adding HeadInsert: {0}, Banner {1}'.
format(html, banner_html))
view.banner_html = banner_html
return view return view