From 4c14c4998dc7eeb79a02911d8ed37db5393f3de8 Mon Sep 17 00:00:00 2001 From: Owen Leonard Date: Fri, 13 Apr 2018 11:43:21 +0000 Subject: [PATCH] Bug 18007: Interface updates to notices and notice previews This patch makes changes to the form for adding and editing notices, and to the template for viewing a rendered preview of notices. - Preview now shows side-by-side comparisons - JavaScript has been movied out of template into separate file - Validation of the add/edit form improved through use of validation plugin To test, apply the patch on top of those for Bug 17981 - Add a new notice. - Confirm that the form can't be submitted without data in the "code" and "name" fields. - Confirm that the form can't be submitted without filling in at least one message template (subject and body). - Confirm that you cannot submit the form while using an existing notice code. - Follow Bug 17981's test plan for testing the preview function. Confirm that the preview loads correctly and looks correct. - Test both with old syntax messages which require conversion and messages in template-toolkit syntax. Signed-off-by: Katrin Fischer Fixed conflicts caused by bug 20538. Signed-off-by: Josef Moravec Signed-off-by: Jonathan Druart --- .../prog/en/modules/tools/letter.tt | 224 ++---------------- .../prog/en/modules/tools/preview_letter.tt | 56 +++-- koha-tmpl/intranet-tmpl/prog/js/letter.js | 183 ++++++++++++++ 3 files changed, 238 insertions(+), 225 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/prog/js/letter.js diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt index 079bb682c7..27e454404d 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt @@ -6,6 +6,7 @@ Koha › Tools › Notices[% IF ( add_form or copy_form ) %][% IF ( modify ) %] › Modify notice[% ELSE %] › Add notice[% END %][% END %][% IF ( add_validate or copy_validate) %] › Notice added[% END %][% IF ( delete_confirm ) %] › Confirm deletion[% END %] [% INCLUDE 'doc-head-close.inc' %] [% Asset.css("css/datatables.css") %] + @@ -446,213 +447,22 @@ [% INCLUDE 'datatables.inc' %] [% Asset.js("lib/jquery/plugins/jquery.fixFloat.js") %] [% Asset.js("lib/jquery/plugins/jquery.insertatcaret.js") %] - + + [% Asset.js("js/letter.js") %] [% END %] [% INCLUDE 'intranet-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/preview_letter.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/preview_letter.tt index b7aadd9ed1..199a958a8e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/preview_letter.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/preview_letter.tt @@ -29,27 +29,47 @@ [% END %] [% IF rendered_message %] -
- Original version - 
[% original_content | html %]
-
- -
- Rendered message: - 
[% rendered_message.content | html %]
-
+
+
+

Original version

+ + [% FILTER html_line_break %] + [% original_content | html %] + [% END %] + +
+
+

Original message, rendered:

+ + [% FILTER html_line_break %] + [% rendered_message.content | html %] + [% END %] + +
+
[% END %] - [% IF rendered_tt_message %] -
- Converted version - 
[% tt_content | html %]
-
-
- Rendered message: - 
[% rendered_tt_message.content | html %]
-
+ [% IF rendered_tt_message %] +
+
+
+

Converted version

+ + [% FILTER html_line_break %] + [% tt_content | html %] + [% END %] + +
+
+

Converted message, rendered:

+ + [% FILTER html_line_break %] + [% rendered_tt_message.content | html %] + [% END %] + +
+
[% END %] diff --git a/koha-tmpl/intranet-tmpl/prog/js/letter.js b/koha-tmpl/intranet-tmpl/prog/js/letter.js new file mode 100644 index 0000000000..4415d1966d --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/js/letter.js @@ -0,0 +1,183 @@ +/* Variables defined in letter.tt: */ +/* global _ module add_form copy_form dataTablesDefaults no_op_set MSG_EMPTY_TITLE_AND_CONTENT MSG_EMPTY_TEMPLATES code MSG_CODE_EXISTS MSG_CODE_EXISTS_FOR_LIBRARY MSG_DT_LOADING_RECORDS interface theme */ + +var modal_loading = "
\"\" "+ MSG_DT_LOADING_RECORDS +"
"; + +var editing = 0; +if( add_form == 1 && code !== '' ){ + editing = 1; +} + +function checkCodes( new_lettercode, new_branchcode ){ + $(".spinner").show(); + return $.ajax({ + data: { code: new_lettercode, branchcode: new_branchcode }, + type: 'GET', + url: '/cgi-bin/koha/svc/letters/get/', + async: !1, + success: function (data) { + if ( data.letters.length > 0 ) { + if( new_branchcode === '' ) { + alert( MSG_CODE_EXISTS.format(new_lettercode)); + } else { + alert( MSG_CODE_EXISTS_FOR_LIBRARY.format(new_lettercode, new_branchcode) ); + } + $(".spinner").hide(); + } else { + $(".spinner").hide(); + } + } + }); +} + +$(document).ready(function() { + if( add_form || copy_form ){ + $('#toolbar').fixFloat(); + } + + $("#lettert:has(tbody tr)").dataTable($.extend(true, {}, dataTablesDefaults, { + "sDom": 't', + "aoColumnDefs": [ + { "bSortable": false, "bSearchable": false, 'aTargets': [ 'nosort' ] } + ], + "bPaginate": false + })); + + if( no_op_set ){ + $('#branch').change(function() { + $('#op').val(""); + $('#selectlibrary').submit(); + }); + $('#newnotice').click(function() { + $('#op').val("add_form"); + return true; + }); + } + + $("#newmodule").on("change",function(){ + var branchcode; + if( $("#branch").val() === ""){ + branchcode = "*"; + } else { + branchcode = $("#branch").val(); + } + window.location.href = "/cgi-bin/koha/tools/letter.pl?op=add_form&module=" + $(this).val() + "&branchcode=" + branchcode; + }); + + $("#submit_form").on("click",function(){ + $("#add_notice").submit(); + }); + + $("#add_notice").validate({ + submitHandler: function(form){ + var at_least_one_exists = 0; + var are_valid = 1; + $("fieldset.mtt").each( function(){ + var title = $(this).find('input[name="title"]').val(); + var content = $(this).find('textarea[name="content"]').val(); + if ( + ( title.length === 0 && content.length > 0 ) || ( title.length > 0 && content.length === 0 ) + ) { + var mtt = $(this).find('input[name="message_transport_type"]').val(); + at_least_one_exists = 1; // Only one template has to be filled in for form to be valid + alert( MSG_EMPTY_TITLE_AND_CONTENT.format( mtt ) ); + are_valid = 0; + } else if ( title.length > 0 && content.length > 0 ) { + at_least_one_exists = 1; + } + }); + + if ( ! at_least_one_exists ) { + // No templates were filled out + alert( MSG_EMPTY_TEMPLATES ); + return false; + } + + if ( ! are_valid ){ + return false; + } + + // Test if code already exists in DB + if( editing == 1 ){ // This is an edit operation + // We don't need to check for an existing Code + } else { + var new_lettercode = $("#code").val(); + var new_branchcode = $("#branch").val(); + var code_check = checkCodes( new_lettercode, new_branchcode ); + if( code_check.responseJSON.letters.length > 0 ){ + return false; + } + } + form.submit(); + } + }); + + var sms_limit = 160; + $(".content_sms").on("keyup", function(){ + var length = $(this).val().length; + var sms_counter = ("#sms_counter_" + $(this).data('lang')); + $(sms_counter).html(length + "/" + sms_limit + _(" characters")); + if ( length > sms_limit ) { + $(sms_counter).css("color", "red"); + } else { + $(sms_counter).css("color", "black"); + } + }); + + $( ".transport-types" ).accordion({ collapsible: true, active:false, animate: 200 }); + + $(".insert").on("click",function(){ + var containerid = $(this).data("containerid"); + insertValueQuery( containerid ); + }); + + $("#saveandcontinue").on("click",function(e){ + e.preventDefault(); + $("#redirect").val("just_save"); + $("#submit_form").click(); + }); + + $("#tabs").tabs(); + + $("body").on("click", ".preview_template", function(e){ + e.preventDefault(); + var mtt = $(this).data("mtt"); + var lang = $(this).data("lang"); + + var code = $("#code").val(); + var content = $("#content_"+mtt+"_"+lang).val(); + var title = $("#title_"+mtt+"_"+lang).val(); + + var is_html = $("#is_html_"+mtt+"_"+lang).val(); + var page = $(this).attr("href"); + var data_preview = $("#data_preview").val(); + page += '?code='+encodeURIComponent(code); + page += '&title='+encodeURIComponent(title); + page += '&content='+encodeURIComponent(content); + page += '&data_preview='+encodeURIComponent(data_preview); + page += '&is_html='+encodeURIComponent(is_html); + $("#preview_template .modal-body").load(page + " #main"); + $('#preview_template').modal('show'); + $("#preview_template_button").attr("href", "/cgi-bin/koha/svc/letters/convert?module="+module+"&code="+code+"&mtt="+mtt+"&lang="+lang); + }); + + $("#preview_template").on("hidden.bs.modal", function(){ + $("#preview_template_label").html(""); + $("#preview_template .modal-body").html( modal_loading ); + }); + + function insertValueQuery(containerid) { + var fieldset = $("#" + containerid); + var myQuery = $(fieldset).find('textarea[name="content"]'); + var myListBox = $(fieldset).find('select[name="SQLfieldname"]'); + + if($(myListBox).find('option').length > 0) { + $(myListBox).find('option').each( function (){ + if ( $(this).attr('selected') && $(this).val().length > 0 ) { + $(myQuery).insertAtCaret("<<" + $(this).val() + ">>"); + } + }); + } + } + +}); -- 2.39.5