2017-10-06 23:37:22 +00:00
|
|
|
# -*- mode: python; coding: utf-8 -*-
|
2017-10-05 20:51:06 +00:00
|
|
|
# Re2o est un logiciel d'administration développé initiallement au rezometz. Il
|
|
|
|
# se veut agnostique au réseau considéré, de manière à être installable en
|
|
|
|
# quelques clics.
|
|
|
|
#
|
|
|
|
# Copyright © 2017 Maël Kervella
|
|
|
|
#
|
|
|
|
# This program 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 2 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
|
|
|
from django import template
|
|
|
|
from django.utils.safestring import mark_safe
|
2017-10-05 23:47:01 +00:00
|
|
|
from django.forms import TextInput
|
2017-10-05 20:51:06 +00:00
|
|
|
from bootstrap3.templatetags.bootstrap3 import bootstrap_form
|
|
|
|
from bootstrap3.utils import render_tag
|
|
|
|
from bootstrap3.forms import render_field
|
|
|
|
|
|
|
|
register = template.Library()
|
|
|
|
|
|
|
|
@register.simple_tag
|
|
|
|
def bootstrap_form_typeahead(django_form, typeahead_fields, *args, **kwargs):
|
|
|
|
"""
|
|
|
|
Render a form where some specific fields are rendered using Typeahead.
|
|
|
|
Using Typeahead really improves the performance, the speed and UX when
|
|
|
|
dealing with very large datasets (select with 50k+ elts for instance).
|
|
|
|
For convenience, it accepts the same parameters as a standard bootstrap
|
|
|
|
can accept.
|
|
|
|
|
|
|
|
**Tag name**::
|
|
|
|
|
|
|
|
bootstrap_form_typeahead
|
|
|
|
|
|
|
|
**Parameters**:
|
2017-10-06 23:12:46 +00:00
|
|
|
|
2017-10-05 20:51:06 +00:00
|
|
|
form
|
|
|
|
The form that is to be rendered
|
|
|
|
|
|
|
|
typeahead_fields
|
|
|
|
A list of field names (comma separated) that should be rendered
|
|
|
|
with typeahead instead of the default bootstrap renderer.
|
|
|
|
|
2017-10-07 17:04:23 +00:00
|
|
|
bft_param
|
|
|
|
A dict of parameters for the bootstrap_form_typeahead tag. The
|
|
|
|
possible parameters are the following.
|
|
|
|
|
|
|
|
choices
|
|
|
|
A dict of strings representing the choices in JS. The keys of
|
|
|
|
the dict are the names of the concerned fields. The choices
|
|
|
|
must be an array of objects. Each of those objects must at
|
|
|
|
least have the fields 'key' (value to send) and 'value' (value
|
|
|
|
to display). Other fields can be added as desired.
|
|
|
|
For a more complex structure you should also consider
|
|
|
|
reimplementing the engine and the match_func.
|
|
|
|
If not specified, the key is the id of the object and the value
|
|
|
|
is its string representation as in a normal bootstrap form.
|
|
|
|
Example :
|
|
|
|
'choices' : {
|
|
|
|
'field_A':'[{key:0,value:"choice0",extra:"data0"},{...},...]',
|
|
|
|
'field_B':...,
|
|
|
|
...
|
|
|
|
}
|
|
|
|
|
|
|
|
engine
|
|
|
|
A dict of strings representating the engine used for matching
|
|
|
|
queries and possible values with typeahead. The keys of the
|
|
|
|
dict are the names of the concerned fields. The string is valid
|
|
|
|
JS code.
|
|
|
|
If not specified, BloodHound with relevant basic properties is
|
|
|
|
used.
|
|
|
|
Example :
|
|
|
|
'engine' : {'field_A': 'new Bloodhound()', 'field_B': ..., ...}
|
|
|
|
|
|
|
|
match_func
|
|
|
|
A dict of strings representing a valid JS function used in the
|
|
|
|
dataset to overload the matching engine. The keys of the dict
|
|
|
|
are the names of the concerned fields. This function is used
|
|
|
|
the source of the dataset. This function receives 2 parameters,
|
|
|
|
the query and the synchronize function as specified in
|
|
|
|
typeahead.js documentation. If needed, the local variables
|
|
|
|
'choices_<fieldname>' and 'engine_<fieldname>' contains
|
|
|
|
respectively the array of all possible values and the engine
|
|
|
|
to match queries with possible values.
|
|
|
|
If not specified, the function used display up to the 10 first
|
|
|
|
elements if the query is empty and else the matching results.
|
|
|
|
Example :
|
|
|
|
'match_func' : {
|
|
|
|
'field_A': 'function(q, sync) { engine.search(q, sync); }',
|
|
|
|
'field_B': ...,
|
|
|
|
...
|
|
|
|
}
|
|
|
|
|
|
|
|
update_on
|
|
|
|
A dict of list of ids that the values depends on. The engine
|
|
|
|
and the typeahead properties are recalculated and reapplied.
|
|
|
|
Example :
|
|
|
|
'addition' : {
|
|
|
|
'field_A' : [ 'id0', 'id1', ... ] ,
|
|
|
|
'field_B' : ... ,
|
|
|
|
...
|
|
|
|
}
|
2017-10-06 23:12:46 +00:00
|
|
|
|
2017-10-05 20:51:06 +00:00
|
|
|
See boostrap_form_ for other arguments
|
|
|
|
|
|
|
|
**Usage**::
|
|
|
|
|
2017-10-07 17:04:23 +00:00
|
|
|
{% bootstrap_form_typeahead
|
|
|
|
form
|
|
|
|
[ '<field1>[,<field2>[,...]]' ]
|
|
|
|
[ {
|
|
|
|
[ 'choices': {
|
|
|
|
[ '<field1>': '<choices1>'
|
|
|
|
[, '<field2>': '<choices2>'
|
|
|
|
[, ... ] ] ]
|
|
|
|
} ]
|
|
|
|
[, 'engine': {
|
|
|
|
[ '<field1>': '<engine1>'
|
|
|
|
[, '<field2>': '<engine2>'
|
|
|
|
[, ... ] ] ]
|
|
|
|
} ]
|
|
|
|
[, 'match_func': {
|
|
|
|
[ '<field1>': '<match_func1>'
|
|
|
|
[, '<field2>': '<match_func2>'
|
|
|
|
[, ... ] ] ]
|
|
|
|
} ]
|
|
|
|
[, 'update_on': {
|
|
|
|
[ '<field1>': '<update_on1>'
|
|
|
|
[, '<field2>': '<update_on2>'
|
|
|
|
[, ... ] ] ]
|
|
|
|
} ]
|
|
|
|
} ]
|
|
|
|
[ <standard boostrap_form parameters> ]
|
|
|
|
%}
|
2017-10-05 20:51:06 +00:00
|
|
|
|
|
|
|
**Example**:
|
2017-10-06 23:12:46 +00:00
|
|
|
|
|
|
|
{% bootstrap_form_typeahead form 'ipv4' choices='[...]' %}
|
2017-10-05 20:51:06 +00:00
|
|
|
"""
|
|
|
|
|
|
|
|
t_fields = typeahead_fields.split(',')
|
2017-10-07 16:58:09 +00:00
|
|
|
params = kwargs.get('bft_param', {})
|
|
|
|
exclude = params.get('exclude', None)
|
2017-10-05 20:51:06 +00:00
|
|
|
exclude = exclude.split(',') if exclude else []
|
2017-10-07 16:58:09 +00:00
|
|
|
t_choices = params.get('choices', {})
|
|
|
|
t_engine = params.get('engine', {})
|
|
|
|
t_match_func = params.get('match_func', {})
|
|
|
|
t_update_on = params.get('update_on', {})
|
2017-10-05 21:36:27 +00:00
|
|
|
hidden = [h.name for h in django_form.hidden_fields()]
|
2017-10-06 23:12:46 +00:00
|
|
|
|
2017-10-05 20:51:06 +00:00
|
|
|
form = ''
|
|
|
|
for f_name, f_value in django_form.fields.items() :
|
|
|
|
if not f_name in exclude :
|
2017-10-05 23:47:01 +00:00
|
|
|
if f_name in t_fields and not f_name in hidden :
|
|
|
|
f_bound = f_value.get_bound_field( django_form, f_name )
|
|
|
|
f_value.widget = TextInput(
|
|
|
|
attrs={
|
|
|
|
'name': 'typeahead_'+f_name,
|
2017-10-06 00:50:13 +00:00
|
|
|
'placeholder': f_value.empty_label
|
2017-10-05 23:47:01 +00:00
|
|
|
}
|
|
|
|
)
|
|
|
|
form += render_field(
|
|
|
|
f_value.get_bound_field( django_form, f_name ),
|
|
|
|
*args,
|
|
|
|
**kwargs
|
|
|
|
)
|
2017-10-05 21:36:27 +00:00
|
|
|
form += render_tag(
|
|
|
|
'div',
|
2017-10-05 23:47:01 +00:00
|
|
|
content = hidden_tag( f_bound, f_name ) +
|
2017-10-06 23:12:46 +00:00
|
|
|
typeahead_js(
|
|
|
|
f_name,
|
|
|
|
f_value,
|
2017-10-07 18:52:49 +00:00
|
|
|
f_bound,
|
2017-10-06 23:12:46 +00:00
|
|
|
t_choices,
|
2017-10-07 16:58:09 +00:00
|
|
|
t_engine,
|
|
|
|
t_match_func,
|
|
|
|
t_update_on
|
2017-10-06 23:12:46 +00:00
|
|
|
)
|
2017-10-05 21:36:27 +00:00
|
|
|
)
|
2017-10-05 20:51:06 +00:00
|
|
|
else:
|
|
|
|
form += render_field(
|
|
|
|
f_value.get_bound_field(django_form, f_name),
|
|
|
|
*args,
|
|
|
|
**kwargs
|
|
|
|
)
|
|
|
|
|
|
|
|
return mark_safe( form )
|
|
|
|
|
2017-10-05 23:47:01 +00:00
|
|
|
def input_id( f_name ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The id of the HTML input element """
|
2017-10-05 23:47:01 +00:00
|
|
|
return 'id_'+f_name
|
2017-10-05 20:51:06 +00:00
|
|
|
|
2017-10-05 21:36:27 +00:00
|
|
|
def hidden_id( f_name ):
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The id of the HTML hidden input element """
|
2017-10-05 23:47:01 +00:00
|
|
|
return 'typeahead_hidden_'+f_name
|
2017-10-05 20:51:06 +00:00
|
|
|
|
2017-10-05 23:47:33 +00:00
|
|
|
def hidden_tag( f_bound, f_name ):
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The HTML hidden input element """
|
2017-10-05 20:51:06 +00:00
|
|
|
return render_tag(
|
|
|
|
'input',
|
|
|
|
attrs={
|
2017-10-05 21:36:27 +00:00
|
|
|
'id': hidden_id(f_name),
|
2017-10-05 20:51:06 +00:00
|
|
|
'name': f_name,
|
|
|
|
'type': 'hidden',
|
2017-10-05 23:47:33 +00:00
|
|
|
'value': f_bound.value()
|
2017-10-05 20:51:06 +00:00
|
|
|
}
|
|
|
|
)
|
|
|
|
|
2017-10-07 18:52:49 +00:00
|
|
|
def typeahead_js( f_name, f_value, f_bound,
|
2017-10-07 16:58:09 +00:00
|
|
|
t_choices, t_engine, t_match_func, t_update_on ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The whole script to use """
|
2017-10-06 23:12:46 +00:00
|
|
|
|
|
|
|
choices = mark_safe(t_choices[f_name]) if f_name in t_choices.keys() \
|
|
|
|
else default_choices( f_value )
|
|
|
|
|
2017-10-07 16:58:09 +00:00
|
|
|
engine = mark_safe(t_engine[f_name]) if f_name in t_engine.keys() \
|
|
|
|
else default_engine ( f_name )
|
|
|
|
|
2017-10-06 23:12:46 +00:00
|
|
|
match_func = mark_safe(t_match_func[f_name]) \
|
2017-10-07 16:47:13 +00:00
|
|
|
if f_name in t_match_func.keys() \
|
|
|
|
else default_match_func( f_name )
|
2017-10-06 23:12:46 +00:00
|
|
|
|
2017-10-07 16:58:09 +00:00
|
|
|
update_on = t_update_on[f_name] if f_name in t_update_on.keys() else []
|
|
|
|
|
2017-10-05 20:51:06 +00:00
|
|
|
js_content = \
|
2017-10-07 16:47:13 +00:00
|
|
|
'var choices_'+f_name+' = ' + choices + ';\n' + \
|
|
|
|
'var setup_'+f_name+' = function() {\n' + \
|
2017-10-07 16:58:09 +00:00
|
|
|
'var engine_'+f_name+' = ' + engine + ';\n' + \
|
2017-10-07 16:38:02 +00:00
|
|
|
'$("#'+input_id(f_name) + '").typeahead("destroy");\n' + \
|
2017-10-05 20:51:06 +00:00
|
|
|
'$("#'+input_id(f_name) + '").typeahead(\n' + \
|
2017-10-07 16:38:02 +00:00
|
|
|
default_datasets( f_name, match_func ) + '\n' + \
|
|
|
|
');\n' + \
|
2017-10-07 18:52:49 +00:00
|
|
|
reset_input( f_name, f_bound ) + '\n' + \
|
2017-10-07 16:38:02 +00:00
|
|
|
'};\n' + \
|
|
|
|
'$("#'+input_id(f_name) + '").bind(\n' + \
|
|
|
|
'"typeahead:select", ' + \
|
|
|
|
typeahead_updater( f_name ) + '\n' + \
|
|
|
|
').bind(\n' + \
|
|
|
|
'"typeahead:change", ' + \
|
|
|
|
typeahead_change( f_name ) + '\n' + \
|
|
|
|
');\n'
|
2017-10-07 16:58:09 +00:00
|
|
|
for u_id in update_on :
|
|
|
|
js_content += '$("#'+u_id+'").change( setup_'+f_name+' );\n'
|
2017-10-07 16:47:13 +00:00
|
|
|
js_content += '$("#'+input_id(f_name)+'").ready( setup_'+f_name+' );\n'
|
2017-10-05 20:51:06 +00:00
|
|
|
|
|
|
|
return render_tag( 'script', content=mark_safe( js_content ) )
|
|
|
|
|
2017-10-07 18:52:49 +00:00
|
|
|
def reset_input( f_name, f_bound ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script to reset the fields values """
|
2017-10-07 18:52:49 +00:00
|
|
|
return '$("#'+input_id(f_name)+'").typeahead(' \
|
|
|
|
'"val", ' \
|
|
|
|
'engine_'+f_name+'.get('+str(f_bound.value())+')[0].value' \
|
|
|
|
');\n' \
|
|
|
|
'$("#'+hidden_id(f_name)+'").val('+str(f_bound.value())+');'
|
2017-10-05 23:47:33 +00:00
|
|
|
|
2017-10-06 23:12:46 +00:00
|
|
|
def default_choices( f_value ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script creating the variable choices_<fieldname> """
|
2017-10-06 23:12:46 +00:00
|
|
|
return '[' + \
|
2017-10-05 20:51:06 +00:00
|
|
|
', '.join([ \
|
|
|
|
'{key: ' + (str(choice[0]) if choice[0] != '' else '""') + \
|
|
|
|
', value: "' + str(choice[1]) + '"}' \
|
|
|
|
for choice in f_value.choices \
|
|
|
|
]) + \
|
2017-10-07 16:38:02 +00:00
|
|
|
']'
|
2017-10-05 20:51:06 +00:00
|
|
|
|
2017-10-07 16:47:13 +00:00
|
|
|
def default_engine ( f_name ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script creating the variable engine_<field_name> """
|
2017-10-07 16:47:13 +00:00
|
|
|
return 'new Bloodhound({ ' \
|
2017-10-05 20:51:06 +00:00
|
|
|
'datumTokenizer: Bloodhound.tokenizers.obj.whitespace("value"), ' \
|
|
|
|
'queryTokenizer: Bloodhound.tokenizers.whitespace, ' \
|
2017-10-07 16:47:13 +00:00
|
|
|
'local: choices_'+f_name+', ' \
|
|
|
|
'identify: function(obj) { return obj.key; } ' \
|
|
|
|
'})'
|
2017-10-05 20:51:06 +00:00
|
|
|
|
2017-10-06 23:12:46 +00:00
|
|
|
def default_datasets( f_name, match_func ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script creating the datasets to use with typeahead """
|
2017-10-05 20:51:06 +00:00
|
|
|
return '{ ' \
|
|
|
|
'hint: true, ' \
|
|
|
|
'highlight: true, ' \
|
2017-10-06 00:27:34 +00:00
|
|
|
'minLength: 0 ' \
|
2017-10-05 20:51:06 +00:00
|
|
|
'}, ' \
|
|
|
|
'{ ' \
|
|
|
|
'display: "value", ' \
|
|
|
|
'name: "'+f_name+'", ' \
|
2017-10-06 23:12:46 +00:00
|
|
|
'source: '+match_func + \
|
2017-10-05 20:51:06 +00:00
|
|
|
'}'
|
|
|
|
|
2017-10-07 16:47:13 +00:00
|
|
|
def default_match_func ( f_name ) :
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script creating the matching function to use with typeahed """
|
2017-10-06 23:12:46 +00:00
|
|
|
return 'function(q, sync) {' \
|
|
|
|
'if (q === "") {' \
|
|
|
|
'var nb = 10;' \
|
|
|
|
'var first = [] ;' \
|
2017-10-07 16:47:13 +00:00
|
|
|
'for ( var i=0 ; i<nb && i<choices_'+f_name+'.length; i++ ) {' \
|
|
|
|
'first.push(choices_'+f_name+'[i].key);' \
|
2017-10-06 23:12:46 +00:00
|
|
|
'}' \
|
2017-10-07 16:47:13 +00:00
|
|
|
'sync(engine_'+f_name+'.get(first));' \
|
2017-10-06 23:12:46 +00:00
|
|
|
'} else {' \
|
2017-10-07 16:47:13 +00:00
|
|
|
'engine_'+f_name+'.search(q, sync);' \
|
2017-10-06 23:12:46 +00:00
|
|
|
'}' \
|
|
|
|
'}'
|
|
|
|
|
2017-10-05 20:51:06 +00:00
|
|
|
def typeahead_updater( f_name ):
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script creating the function triggered when an item is
|
|
|
|
selected through typeahead """
|
2017-10-05 20:51:06 +00:00
|
|
|
return 'function(evt, item) { ' \
|
2017-10-05 21:36:27 +00:00
|
|
|
'$("#'+hidden_id(f_name)+'").val( item.key ); ' \
|
2017-10-06 11:32:49 +00:00
|
|
|
'$("#'+hidden_id(f_name)+'").change();' \
|
2017-10-05 20:51:06 +00:00
|
|
|
'return item; ' \
|
2017-10-06 00:50:13 +00:00
|
|
|
'}'
|
|
|
|
|
|
|
|
def typeahead_change( f_name ):
|
2017-10-07 17:04:23 +00:00
|
|
|
""" The JS script creating the function triggered when an item is changed
|
|
|
|
(i.e. looses focus and value has changed since the moment it gained focus
|
|
|
|
"""
|
2017-10-06 00:50:13 +00:00
|
|
|
return 'function(evt) { ' \
|
2017-10-07 16:51:21 +00:00
|
|
|
'if ($("#'+input_id(f_name)+'").typeahead("val") === "") {' \
|
2017-10-06 00:50:13 +00:00
|
|
|
'$("#'+hidden_id(f_name)+'").val(""); ' \
|
2017-10-07 16:38:02 +00:00
|
|
|
'$("#'+hidden_id(f_name)+'").change();' \
|
2017-10-06 00:50:13 +00:00
|
|
|
'}' \
|
|
|
|
'}'
|