290341d8db
This patch makes it possible to sync patron data between Koha and the
Norwegian national patron database, in both directions.
In order to use this, the following information is necessary:
- a username/password from the Norwegian national database of libraries
("Base Bibliotek"), available to all Norwegian libraries
- a special key in order to decrypt and encrypt PIN-codes/passwords,
which is only available to Norwegian library system vendors
- a norwegian library vendor username/password
See http://www.lanekortet.no/ for more information (in Norwegian).
While this is of course an implementation of a specific synchronization scheme
for borrower data, attempts have been made to prepare the ground for other sync
schemes that might be implemented later. Especially the structure of the new
borrower_sync table might be reviewed with an eye to how it might fit other
schemes.
To test:
Since the password and cryptographic key needed to use this functionality
is only available to Norwegian library system vendors, only regression testing
can be done on the submitted code. Suggested things to check:
- Apply the patch and make sure the database update is done. This should add
the new "borrower_sync" table and five new systmpreferences under the
"Patrons" > "Norwegian patron database" category:
- NorwegianPatronDBEnable
- NorwegianPatronDBEndpoint
- NorwegianPatronDBUsername
- NorwegianPatronDBPassword
- NorwegianPatronDBSearchNLAfterLocalHit
- Check that patrons can be created, edited and deleted as usual, when
NorwegianPatronDBEnable is set to "Disable"
- Check that the new tests in t/NorwegianPatronDB.pm run ok, e.g. on a
gitified setup:
$ sudo koha-shell -c "PERL5LIB=/path/to/kohaclone prove -v t/NorwegianPatronDB.t" instancename
- Check that all the other tests still run ok
- Check that the POD in the new files itroduced by this patch looks ok:
- Koha/NorwegianPatronDB.pm
- members/nl-search.pl
- misc/cronjobs/nl-sync-from-koha.pl
- misc/cronjobs/nl-sync-to-koha.pl
- t/NorwegianPatronDB.t
Sponsored-by: Oslo Public Library
Update 2014-09-18:
- Rebase on master
- Split out changes to Koha::Schema
- Incorporate new way of authenticating with NL
Update 2014-10-21:
- Rebase on master
- Use Module::Load to load Koha::NorwegianPatronDB in non-NL-specific
scripts and modules
- Fix the version number of Digest::SHA
- Fix a missing semicolon in kohastructure.sql
Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
493 lines
19 KiB
Text
493 lines
19 KiB
Text
[% USE Koha %]
|
|
[% INCLUDE 'doc-head-open.inc' %]
|
|
<title>Koha › Patrons [% IF ( searching ) %]› Search results[% END %]</title>
|
|
[% INCLUDE 'doc-head-close.inc' %]
|
|
<link rel="stylesheet" type="text/css" href="[% themelang %]/css/datatables.css" />
|
|
[% INCLUDE 'datatables.inc' %]
|
|
<script type="text/javascript">
|
|
//<![CDATA[
|
|
$(document).ready(function() {
|
|
$('#add_to_patron_list_submit').attr('disabled', 'disabled');
|
|
$('#new_patron_list').hide();
|
|
|
|
$('#add_to_patron_list').change(function() {
|
|
var value = $('#add_to_patron_list').val();
|
|
if ( value == 'new' ) {
|
|
$('#new_patron_list').val('')
|
|
$('#new_patron_list').show();
|
|
$('#new_patron_list').focus();
|
|
} else if ( value ) {
|
|
$('#new_patron_list').hide();
|
|
$('#add_to_patron_list_submit').removeAttr('disabled');
|
|
} else {
|
|
$('#new_patron_list').hide();
|
|
$('#add_to_patron_list_submit').attr('disabled', 'disabled');
|
|
}
|
|
});
|
|
|
|
$('#new_patron_list').on('input', function() {
|
|
if ( $('#new_patron_list').val() ) {
|
|
$('#add_to_patron_list_submit').removeAttr('disabled');
|
|
} else {
|
|
$('#add_to_patron_list_submit').attr('disabled', 'disabled');
|
|
}
|
|
});
|
|
|
|
$("#patron_list_dialog").hide();
|
|
$("#add_to_patron_list_submit").on('click', function(e){
|
|
if ( $('#add_to_patron_list').val() == 'new' ) {
|
|
if ( $('#new_patron_list').val() ) {
|
|
$("#add_to_patron_list option").each(function() {
|
|
if ( $(this).text() == $('#new_patron_list').val() ) {
|
|
alert( _("You already have a list with that name!") );
|
|
return false;
|
|
}
|
|
});
|
|
} else {
|
|
alert( _("You must give your new patron list a name!") );
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if ( $("#memberresultst input:checkbox:checked").length == 0 ) {
|
|
alert( _("You have not selected any patrons to add to a list!") );
|
|
return false;
|
|
}
|
|
|
|
var borrowernumbers = [];
|
|
$("#memberresultst").find("input:checkbox:checked").each(function(){
|
|
borrowernumbers.push($(this).val());
|
|
});
|
|
var data = {
|
|
add_to_patron_list: encodeURIComponent($("#add_to_patron_list").val()),
|
|
new_patron_list: encodeURIComponent($("#new_patron_list").val()),
|
|
borrowernumbers: borrowernumbers
|
|
};
|
|
$.ajax({
|
|
data: data,
|
|
type: 'POST',
|
|
url: '/cgi-bin/koha/svc/members/add_to_list',
|
|
success: function(data) {
|
|
$("#patron_list_dialog").show();
|
|
$("#patron_list_dialog > span.patrons-length").html(data.patrons_added_to_list);
|
|
$("#patron_list_dialog > a").attr("href", "/cgi-bin/koha/patron_lists/list.pl?patron_list_id=" + data.patron_list.patron_list_id);
|
|
$("#patron_list_dialog > a").html(data.patron_list.name);
|
|
},
|
|
error: function() {
|
|
alert("an error occurred");
|
|
}
|
|
});
|
|
return true;
|
|
});
|
|
});
|
|
|
|
var dtMemberResults;
|
|
var search = 1;
|
|
$(document).ready(function() {
|
|
[% IF searchmember %]
|
|
$("#searchmember_filter").val("[% searchmember %]");
|
|
[% END %]
|
|
[% IF searchfieldstype %]
|
|
$("searchfieldstype_filter").val("[% searchfieldstype %]");
|
|
[% END %]
|
|
[% IF searchtype %]
|
|
$("#searchtype_filter").val("[% searchtype %]");
|
|
[% END %]
|
|
[% IF categorycode %]
|
|
$("#categorycode_filter").val("[% categorycode %]");
|
|
[% END %]
|
|
[% IF branchcode %]
|
|
$("#branchcode_filter").val("[% branchcode %]");
|
|
[% END %]
|
|
|
|
[% IF view != "show_results" %]
|
|
$("#searchresults").hide();
|
|
search = 0;
|
|
[% END %]
|
|
|
|
// Build the aLengthMenu
|
|
var aLengthMenu = [
|
|
[%PatronsPerPage %], 10, 20, 50, 100, -1
|
|
];
|
|
jQuery.unique(aLengthMenu);
|
|
aLengthMenu.sort(function( a, b ){
|
|
// Put "All" at the end
|
|
if ( a == -1 ) {
|
|
return 1;
|
|
} else if ( b == -1 ) {
|
|
return -1;
|
|
}
|
|
return parseInt(a) < parseInt(b) ? -1 : 1;}
|
|
);
|
|
var aLengthMenuLabel = [];
|
|
$(aLengthMenu).each(function(){
|
|
if ( this == -1 ) {
|
|
// Label for -1 is "All"
|
|
aLengthMenuLabel.push("All");
|
|
} else {
|
|
aLengthMenuLabel.push(this);
|
|
}
|
|
});
|
|
|
|
// Apply DataTables on the results table
|
|
dtMemberResults = $("#memberresultst").dataTable($.extend(true, {}, dataTablesDefaults, {
|
|
'bServerSide': true,
|
|
'sAjaxSource': "/cgi-bin/koha/svc/members/search",
|
|
'fnServerData': function(sSource, aoData, fnCallback) {
|
|
if ( ! search ) {
|
|
return;
|
|
}
|
|
aoData.push({
|
|
'name': 'searchmember',
|
|
'value': $("#searchmember_filter").val()
|
|
},{
|
|
'name': 'firstletter',
|
|
'value': $("#firstletter_filter").val()
|
|
},{
|
|
'name': 'searchfieldstype',
|
|
'value': $("#searchfieldstype_filter").val()
|
|
},{
|
|
'name': 'searchtype',
|
|
'value': $("#searchtype_filter").val()
|
|
},{
|
|
'name': 'categorycode',
|
|
'value': $("#categorycode_filter").val()
|
|
},{
|
|
'name': 'branchcode',
|
|
'value': $("#branchcode_filter").val()
|
|
},{
|
|
'name': 'name_sorton',
|
|
'value': 'borrowers.surname borrowers.firstname'
|
|
},{
|
|
'name': 'category_sorton',
|
|
'value': 'categories.description',
|
|
},{
|
|
'name': 'branch_sorton',
|
|
'value': 'branches.branchname'
|
|
},{
|
|
'name': 'template_path',
|
|
'value': 'members/tables/members_results.tt',
|
|
});
|
|
$.ajax({
|
|
'dataType': 'json',
|
|
'type': 'POST',
|
|
'url': sSource,
|
|
'data': aoData,
|
|
'success': function(json){
|
|
// redirect if there is only 1 result.
|
|
if ( json.aaData.length == 1 ) {
|
|
var borrowernumber = json.aaData[0].borrowernumber;
|
|
document.location.href="/cgi-bin/koha/members/moremember.pl?borrowernumber="+borrowernumber;
|
|
return false;
|
|
}
|
|
fnCallback(json);
|
|
}
|
|
});
|
|
},
|
|
'aoColumns':[
|
|
[% IF CAN_user_tools_manage_patron_lists %]
|
|
{ 'mDataProp': 'dt_borrowernumber', 'bSortable': false },
|
|
[% END %]
|
|
{ 'mDataProp': 'dt_cardnumber' },
|
|
{ 'mDataProp': 'dt_name' },
|
|
{ 'mDataProp': 'dt_category' },
|
|
{ 'mDataProp': 'dt_branch' },
|
|
{ 'mDataProp': 'dt_dateexpiry' },
|
|
{ 'mDataProp': 'dt_od_checkouts', 'bSortable': false },
|
|
{ 'mDataProp': 'dt_fines', 'bSortable': false },
|
|
{ 'mDataProp': 'dt_borrowernotes' },
|
|
{ 'mDataProp': 'dt_action', 'bSortable': false }
|
|
],
|
|
'fnRowCallback': function(nRow, aData, iDisplayIndex, iDisplayIndexFull) {
|
|
/* Center text for 6th column */
|
|
$("td:eq(5)", nRow).css("text-align", "center");
|
|
|
|
return nRow;
|
|
},
|
|
'bFilter': false,
|
|
'bAutoWidth': false,
|
|
[% IF CAN_user_tools_manage_patron_lists %]
|
|
'aaSorting': [[1, 'asc']],
|
|
[% ELSE %]
|
|
'aaSorting': [[0, 'asc']],
|
|
[% END %]
|
|
"aLengthMenu": [aLengthMenu, aLengthMenuLabel],
|
|
'sPaginationType': 'full_numbers',
|
|
"iDisplayLength": [% PatronsPerPage %],
|
|
"bProcessing": true,
|
|
}));
|
|
update_searched();
|
|
});
|
|
|
|
// Update the string "Results found ..."
|
|
function update_searched(){
|
|
var searched = "";
|
|
searched += "on " + $("#searchfieldstype_filter").find("option:selected").text().toLowerCase() + " fields";
|
|
if ( $("#searchmember_filter").val() ) {
|
|
if ( $("#searchtype_filter").val() == 'start_with' ) {
|
|
searched += _(" starting with ");
|
|
} else {
|
|
searched += _(" containing ");
|
|
}
|
|
searched += $("#searchmember_filter").val();
|
|
}
|
|
if ( $("#firstletter_filter").val() ) {
|
|
searched += _(" begin with ") + $("#firstletter_filter").val();
|
|
}
|
|
if ( $("#categorycode_filter").val() ) {
|
|
searched += _(" with category ") + $("#categorycode_filter").find("option:selected").text();
|
|
}
|
|
if ( $("#branchcode_filter").val() ) {
|
|
searched += _(" in library ") + $("#branchcode_filter").find("option:selected").text();
|
|
}
|
|
$("#searchpattern").text("for patron " + searched);
|
|
}
|
|
|
|
// Redraw the table
|
|
function filter() {
|
|
$("#firstletter_filter").val('');
|
|
update_searched();
|
|
search = 1;
|
|
$("#searchresults").show();
|
|
dtMemberResults.fnDraw();
|
|
return false;
|
|
}
|
|
|
|
// User has clicked on the Clear button
|
|
function clearFilters(redraw) {
|
|
$("#searchform select").val('');
|
|
$("#firstletter_filter").val('');
|
|
$("#searchmember_filter").val('');
|
|
if(redraw) {
|
|
search = 1;
|
|
$("#searchresults").show();
|
|
dtMemberResults.fnDraw();
|
|
}
|
|
}
|
|
|
|
// User has clicked on a letter
|
|
function filterByFirstLetterSurname(letter) {
|
|
clearFilters(false);
|
|
$("#firstletter_filter").val(letter);
|
|
update_searched();
|
|
search = 1;
|
|
$("#searchresults").show();
|
|
dtMemberResults.fnDraw();
|
|
}
|
|
//]]>
|
|
</script>
|
|
</head>
|
|
<body id="pat_member" class="pat">
|
|
[% INCLUDE 'header.inc' %]
|
|
[% INCLUDE 'patron-search.inc' %]
|
|
|
|
<div id="breadcrumbs"><a href="/cgi-bin/koha/mainpage.pl">Home</a> › [% IF ( searching ) %]<a href="/cgi-bin/koha/members/members-home.pl">Patrons</a> › Search results[% ELSE %]Patrons[% END %]</div>
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<div class="yui-g">
|
|
[% IF CAN_user_tools_manage_patron_lists %]
|
|
<div id="patron_list_dialog" class="dialog alert">
|
|
Added <span class="patrons-length"></span> patrons to <a></a>.
|
|
</div>
|
|
[% END %]
|
|
|
|
[% IF Koha.Preference( 'NorwegianPatronDBEnable' ) == 1 %]
|
|
[% SET nl_search_form_title='Search the Norwegian national patron database' %]
|
|
[% INCLUDE 'nl-search-form.tt' %]
|
|
[% END %]
|
|
|
|
[% INCLUDE 'patron-toolbar.inc' %]
|
|
[% IF ( no_add ) %]
|
|
<div class="dialog alert">
|
|
<h3>Cannot add patron</h3>
|
|
[% IF ( no_branches ) %]
|
|
<p>There are <strong>no libraries defined</strong>. [% IF ( CAN_user_parameters ) %]Please <a href="/cgi-bin/koha/admin/branches.pl">add a library</a>.[% ELSE %]An administrator must define at least one library.[% END %]</p>
|
|
[% END %]
|
|
[% IF ( no_categories ) %]
|
|
<p>There are <strong>no patron categories defined</strong>. [% IF ( CAN_user_parameters ) %]Please <a href="/cgi-bin/koha/admin/categorie.pl">add a patron category</a>.[% ELSE %]An administrator must define at least one patron category.[% END %]</p>
|
|
[% END %]
|
|
</div>
|
|
[% END %]
|
|
<div class="browse">
|
|
Browse by last name:
|
|
[% FOREACH letter IN alphabet.split(' ') %]
|
|
<a style="cursor:pointer" onclick="filterByFirstLetterSurname('[% letter %]');">[% letter %]</a>
|
|
[% END %]
|
|
</div>
|
|
|
|
[% IF ( CAN_user_borrowers && pending_borrower_modifications ) %]
|
|
<div class="pending-info" id="patron_updates_pending">
|
|
<a href="/cgi-bin/koha/members/members-update.pl">Patrons requesting modifications</a>:
|
|
<span class="holdcount"><a href="/cgi-bin/koha/members/members-update.pl">[% pending_borrower_modifications %]</a></span>
|
|
</div>
|
|
[% END %]
|
|
|
|
<div id="searchresults">
|
|
<div id="searchheader">
|
|
<h3>Results found <span id="searchpattern">[% IF searchmember %] for '[% searchmember %]'[% END %]</span></h3>
|
|
</div>
|
|
[% IF CAN_user_tools_manage_patron_lists %]
|
|
<div id="searchheader">
|
|
<div>
|
|
<a href="javascript:void(0)" onclick="$('.selection').prop('checked', true)">Select all</a>
|
|
|
|
|
<a href="javascript:void(0)" onclick="$('.selection').prop('checked', false)">Clear all</a>
|
|
|
|
|
<span>
|
|
Add selected patrons
|
|
<label for="add_to_patron_list">to:</label>
|
|
<select id="add_to_patron_list" name="add_to_patron_list">
|
|
<option value=""></option>
|
|
[% IF patron_lists %]
|
|
<optgroup label="Patron lists:">
|
|
[% FOREACH pl IN patron_lists %]
|
|
<option value="[% pl.patron_list_id %]">[% pl.name %]</option>
|
|
[% END %]
|
|
</optgroup>
|
|
[% END %]
|
|
|
|
<option value="new">[ New list ]</option>
|
|
</select>
|
|
|
|
<input type="text" id="new_patron_list" name="new_patron_list" id="new_patron_list" />
|
|
|
|
<input id="add_to_patron_list_submit" type="submit" class="submit" value="Save">
|
|
</span>
|
|
</div>
|
|
</div>
|
|
[% END %]
|
|
|
|
<table id="memberresultst">
|
|
<thead>
|
|
<tr>
|
|
[% IF CAN_user_tools_manage_patron_lists %]
|
|
<th> </th>
|
|
[% END %]
|
|
<th>Card</th>
|
|
<th>Name</th>
|
|
<th>Category</th>
|
|
<th>Library</th>
|
|
<th>Expires on</th>
|
|
<th>OD/Checkouts</th>
|
|
<th>Fines</th>
|
|
<th>Circ note</th>
|
|
<th> </th>
|
|
</tr>
|
|
</thead>
|
|
<tbody></tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<form onsubmit="return filter();" id="searchform">
|
|
<input type="hidden" id="firstletter_filter" value="" />
|
|
<fieldset class="brief">
|
|
<h3>Filters</h3>
|
|
<ol>
|
|
<li>
|
|
<label for="searchmember_filter">Search:</label>
|
|
<input type="text" id="searchmember_filter" value="[% searchmember %]"/>
|
|
</li>
|
|
<li>
|
|
<label for="searchfieldstype_filter">Search fields:</label>
|
|
<select name="searchfieldstype" id="searchfieldstype_filter">
|
|
[% IF searchfieldstype == "standard" %]
|
|
<option selected="selected" value='standard'>Standard</option>
|
|
[% ELSE %]
|
|
<option value='standard'>Standard</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "email" %]
|
|
<option selected="selected" value='email'>Email</option>
|
|
[% ELSE %]
|
|
<option value='email'>Email</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "borrowernumber" %]
|
|
<option selected="selected" value='borrowernumber'>Borrower number</option>
|
|
[% ELSE %]
|
|
<option value='borrowernumber'>Borrower number</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "phone" %]
|
|
<option selected="selected" value='phone'>Phone number</option>
|
|
[% ELSE %]
|
|
<option value='phone'>Phone number</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "address" %]
|
|
<option selected="selected" value='address'>Street address</option>
|
|
[% ELSE %]
|
|
<option value='address'>Street address</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "dateofbirth" %]
|
|
<option selected="selected" value='dateofbirth'>Date of birth</option>
|
|
[% ELSE %]
|
|
<option value='dateofbirth'>Date of birth</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "sort1" %]
|
|
<option selected="selected" value='sort1'>Sort field 1</option>
|
|
[% ELSE %]
|
|
<option value='sort1'>Sort field 1</option>
|
|
[% END %]
|
|
[% IF searchfieldstype == "sort2" %]
|
|
<option selected="selected" value='sort2'>Sort field 2</option>
|
|
[% ELSE %]
|
|
<option value='sort2'>Sort field 2</option>
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
<li>
|
|
<label for="searchtype_filter">Search type:</label>
|
|
<select name="searchtype" id="searchtype_filter">
|
|
<option value='start_with'>Starts with</option>
|
|
[% IF searchtype == "contain" %]
|
|
<option value="contain" selected="selected">Contains</option>
|
|
[% ELSE %]
|
|
<option value="contain" selected="selected">Contains</option>
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
<li>
|
|
<label for="categorycode_filter">Category:</label>
|
|
<select id="categorycode_filter">
|
|
<option value="">Any</option>
|
|
[% FOREACH cat IN categories %]
|
|
[% IF cat.selected %]
|
|
<option selected="selected" value="[% cat.categorycode %]">[% cat.description | html_entity %]</option>
|
|
[% ELSE %]
|
|
<option value="[% cat.categorycode %]">[% cat.description | html_entity %]</option>
|
|
[% END %]
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
<li>
|
|
<label for="branchcode_filter">Library:</label>
|
|
<select id="branchcode_filter">
|
|
[% IF branchloop.size != 1 %]
|
|
<option value="">Any</option>
|
|
[% END %]
|
|
[% FOREACH b IN branchloop %]
|
|
[% IF b.selected %]
|
|
<option selected="selected" value="[% b.branchcode %]">[% b.branchname %]</option>
|
|
[% ELSE %]
|
|
<option value="[% b.branchcode %]">[% b.branchname %]</option>
|
|
[% END %]
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
</ol>
|
|
<fieldset class="action">
|
|
<input type="submit" value="Search" />
|
|
<input type="button" value="Clear" onclick="clearFilters(true);" />
|
|
</fieldset>
|
|
</fieldset>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<div class="yui-g">
|
|
[% INCLUDE 'members-menu.inc' %]
|
|
</div>
|
|
</div>
|
|
[% INCLUDE 'intranet-bottom.inc' %]
|