Patron Stat Cat Enhancements: Add 'allow free text' and 'required' flags

Add database entities, controller mappings, and HTML/Javascript
widgets to allow administrators to set and persist 'required'
and 'allow free text' boolean flags for patron statistical categories
in the Statistical Categories Editor.

Signed-off-by: Scott Prater <sprater@gmail.com>
Signed-off-by: Ben Shum <bshum@biblio.org>
Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>

diff --git a/Open-ILS/examples/fm_IDL.xml b/Open-ILS/examples/fm_IDL.xml
index fe0af0d..05119ae 100644 (file)
--- a/Open-ILS/examples/fm_IDL.xml
+++ b/Open-ILS/examples/fm_IDL.xml
@@ -5066,6 +5066,8 @@ SELECT  usr,
                        <field reporter:label="SIP Field" name="sip_field" reporter:datatype="link"/>
                        <field reporter:label="SIP Format" name="sip_format" reporter:datatype="text"/>
                        <field reporter:label="Checkout Archive" name="checkout_archive" reporter:datatype="bool"/>
+                       <field reporter:label="Required" name="required" reporter:datatype="bool"/>
+                       <field reporter:label="Free Text" name="allow_freetext" reporter:datatype="bool"/>
                </fields>
                <links>
                        <link field="owner" reltype="has_a" key="id" map="" class="aou"/>

diff --git a/Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/CDBI/actor.pm b/Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/CDBI/actor.pm
index d95baa1..4c2cbe9 100644 (file)
--- a/Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/CDBI/actor.pm
+++ b/Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/CDBI/actor.pm
@@ -118,7 +118,7 @@ use base qw/actor/;
 
 __PACKAGE__->table( 'actor_stat_cat' );
 __PACKAGE__->columns( Primary => qw/id/ );
-__PACKAGE__->columns( Essential => qw/owner name opac_visible usr_summary sip_field sip_format checkout_archive/ );
+__PACKAGE__->columns( Essential => qw/owner name opac_visible usr_summary sip_field sip_format checkout_archive required allow_freetext/ );
 
 #-------------------------------------------------------------------------------
 package actor::stat_cat_entry;

diff --git a/Open-ILS/web/opac/locale/en-US/lang.dtd b/Open-ILS/web/opac/locale/en-US/lang.dtd
index 29e809c..ea810c0 100644 (file)
--- a/Open-ILS/web/opac/locale/en-US/lang.dtd
+++ b/Open-ILS/web/opac/locale/en-US/lang.dtd
@@ -2183,6 +2183,7 @@
 <!ENTITY staff.server.admin.stat_cat.owning_library "Owning Library: ">
 <!ENTITY staff.server.admin.stat_cat.opac_visibility "OPAC Visibility: ">
 <!ENTITY staff.server.admin.stat_cat.required "Required: ">
+<!ENTITY staff.server.admin.stat_cat.allow_freetext "Allow Free Text: ">
 <!ENTITY staff.server.admin.stat_cat.usr_summary "Show in Summary: ">
 <!ENTITY staff.server.admin.stat_cat.on "On">
 <!ENTITY staff.server.admin.stat_cat.off "Off">
@@ -2200,6 +2201,7 @@
 <!ENTITY staff.server.admin.stat_cat.owning_library.label "Owning Library">
 <!ENTITY staff.server.admin.stat_cat.opac_visibility.label "OPAC Visibility">
 <!ENTITY staff.server.admin.stat_cat.required.label "Required">
+<!ENTITY staff.server.admin.stat_cat.allow_freetext.label "Allow Free Text">
 <!ENTITY staff.server.admin.stat_cat.usr_summary.label "Show in Summary">
 <!ENTITY staff.server.admin.stat_cat.entries.label "Entries">
 <!ENTITY staff.server.admin.stat_cat.add_entry "Add Entry">

diff --git a/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.js b/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.js
index 8edabfd..eee8022 100644 (file)
--- a/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.js
+++ b/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.js
@@ -164,10 +164,10 @@ function scDraw( type, cats ) {
 
     if(type == ACTOR) {
         unHideMe($('sc_usr_summary_label'));
-        hideMe($('sc_required_label'));
+        unHideMe($('sc_usr_freetext_label'));
     } else {
-        unHideMe($('sc_required_label'));
         hideMe($('sc_usr_summary_label'));
+        hideMe($('sc_usr_freetext_label'));
     }
 
     scCounter = 0;
@@ -180,6 +180,7 @@ function scInsertCat( tbody, cat, type ) {
 
     var row = scRow.cloneNode(true);
     row.id = 'sc_tr_' + cat.id();
+    var required = cat.required();
     var name_td = $n(row, 'sc_name');
     name_td.appendChild( text(cat.name()) );
     if(scCounter++ % 2) addCSSClass(row, 'has_color');
@@ -207,20 +208,24 @@ function scInsertCat( tbody, cat, type ) {
     else
         unHideMe($n(row, 'sc_checkout_archive'));
 
+    if(isTrue(required))
+        unHideMe($n(row, 'sc_required_on'));
+    else 
+        unHideMe($n(row, 'sc_required'));
+
     if(type == ACTOR) {
         if(isTrue(cat.usr_summary()))
             unHideMe($n(row, 'sc_usr_summary_on'));
         else 
             unHideMe($n(row, 'sc_usr_summary'));
 
-        hideMe($n(row, 'sc_required_td'));
-    } else {
-        if(isTrue(cat.required()))
-            unHideMe($n(row, 'sc_required_on'));
+        if(isTrue(cat.allow_freetext()))
+            unHideMe($n(row, 'sc_usr_freetext_on'));
         else 
-            unHideMe($n(row, 'sc_required'));
-
+            unHideMe($n(row, 'sc_usr_freetext'));
+    } else {
         hideMe($n(row, 'sc_usr_summary_td'));
+        hideMe($n(row, 'sc_usr_freetext_td'));
     }
 
     tbody.appendChild(row);
@@ -317,18 +322,18 @@ function scBuildNew() {
     var type = getSelectorVal(typeSel);
     switch(type) {
         case ACTOR:
-            hideMe($('required_td1'));
-            hideMe($('required_td2'));
             unHideMe($('usr_summary_td1'));
             unHideMe($('usr_summary_td2'));
             unHideMe($('sip_tr'));
+            unHideMe($('usr_freetext_td1'));
+            unHideMe($('usr_freetext_td2'));
         break;
         case ASSET:
             hideMe($('usr_summary_td1'));
             hideMe($('usr_summary_td2'));
             hideMe($('sip_tr'));
-            unHideMe($('required_td1'));
-            unHideMe($('required_td2'));
+            hideMe($('usr_freetext_td1'));
+            hideMe($('usr_freetext_td2'));
         break;
     }
     var org_list = PERMS[type].create_stat_cat;
@@ -355,19 +360,21 @@ function scNew() {
     var required = 0;
     var usr_summary = 0;
     var checkout_archive = 0;
+    var usr_freetext = 0;
     if( $('sc_make_opac_visible').checked) visible = 1;
     if( $('sc_make_required').checked) required = 1;
     if( $('sc_make_usr_summary').checked) usr_summary = 1;
     if( $('sc_make_checkout_archive').checked) checkout_archive = 1;
+    if( $('sc_make_usr_freetext').checked) usr_freetext = 1;
 
     var cat;
     if( type == ACTOR ) {
         cat = new actsc();
         cat.usr_summary( usr_summary );
+        cat.allow_freetext( usr_freetext );
     }
     if( type == ASSET ) {
         cat = new asc();
-        cat.required( required );
     }
     var field = getSelectorVal($('sc_sip_field'));
     if(field.length == 2) cat.sip_field(field);
@@ -375,6 +382,7 @@ function scNew() {
     cat.sip_format($('sc_sip_format').value);
 
     cat.opac_visible(visible);
+    cat.required( required );
     cat.name(name);
     cat.checkout_archive(checkout_archive);
     cat.owner(getSelectorVal($('sc_owning_lib_selector')));
@@ -400,21 +408,25 @@ function scEdit( tbody, type, cat ) {
     if(r.nextSibling) { tbody.insertBefore( row, r.nextSibling ); }
     else{ tbody.appendChild(row); }
 
+    var required = cat.required();
+    var reqcb = $n(row, 'sc_edit_required');
+    reqcb.checked = isTrue(required); 
+
     scPopSipFields($n(row, 'sc_edit_sip_field'), type);
     $n(row, 'sc_edit_name').value = cat.name();
     setSelector($n(row, 'sc_edit_sip_field'), cat.sip_field());
     $n(row, 'sc_edit_sip_format').value = cat.sip_format();
 
     if(type == ACTOR) {
-        var cb = $n(row, 'sc_edit_usr_summary');
-        cb.checked = isTrue(cat.usr_summary()); 
-        hideMe($n(row, 'sc_edit_required_td'));
+        var cb1 = $n(row, 'sc_edit_usr_summary');
+        var cb2 = $n(row, 'sc_edit_usr_freetext');
+        cb1.checked = isTrue(cat.usr_summary()); 
+        cb2.checked = isTrue(cat.allow_freetext()); 
         unHideMe($n(row, 'sc_edit_usr_summary_td'));
+        unHideMe($n(row, 'sc_edit_usr_freetext_td'));
     } else {
-        var cb = $n(row, 'sc_edit_required');
-        cb.checked = isTrue(cat.required()); 
         hideMe($n(row, 'sc_edit_usr_summary_td'));
-        unHideMe($n(row, 'sc_edit_required_td'));
+        hideMe($n(row, 'sc_edit_usr_freetext_td'));
     }
 
     var name = $n(row, 'sc_edit_cancel');
@@ -439,12 +451,9 @@ function scEdit( tbody, type, cat ) {
     name.select();
 
     if( cat.opac_visible() != 0 && cat.opac_visible() != '0' ) {
-        $n( $n(row, 'sc_edit_opac_vis'), 
-            'sc_edit_opac_visibility').checked = true;
-    } else {
-        $n( $n(row, 'sc_edit_opac_invis'), 
+        $n( $n(row, 'sc_edit_opac_visibility'), 
             'sc_edit_opac_visibility').checked = true;
-    }
+    } 
 
     $n( row, 'sc_edit_checkout_archive' ).checked = isTrue(cat.checkout_archive());
 
@@ -467,33 +476,31 @@ function scEdit( tbody, type, cat ) {
 function scEditGo( type, cat, row, selector ) {
     var name = $n(row, 'sc_edit_name').value;
     var visible = 
-        $n( $n(row, 'sc_edit_opac_vis'), 'sc_edit_opac_visibility').checked;
+        $n( $n(row, 'sc_edit_opac_visibility'), 'sc_edit_opac_visibility').checked;
 
     var newlib = cat.owner();
     if(selector) newlib = getSelectorVal( selector );
 
     if(!name) return false;
 
-    var usr_summary = $n(row, 'sc_edit_usr_summary').checked;
     var required = $n(row, 'sc_edit_required').checked;
+    var usr_summary = $n(row, 'sc_edit_usr_summary').checked;
     var sip_field = getSelectorVal( $n(row, 'sc_edit_sip_field') );
+    var usr_freetext = $n(row, 'sc_edit_usr_freetext').checked;
 
     cat.name( name );
     cat.owner( newlib );
     cat.entries(null);
     cat.opac_visible(0);
     cat.checkout_archive($n(row, 'sc_edit_checkout_archive').checked ? 1 : 0);
+    cat.required( (required) ? 1 : 0 );
     if(sip_field.length == 2) cat.sip_field( sip_field );
     else cat.sip_field(null);
     cat.sip_format($n(row, 'sc_edit_sip_format').value);
     if( visible ) cat.opac_visible(1);
-    switch(type) {
-        case ACTOR:
-            cat.usr_summary( (usr_summary) ? 1 : 0 );
-        break;
-        case ASSET:
-            cat.required( (required) ? 1 : 0 );
-        break;
+    if(type == ACTOR) {
+        cat.usr_summary( (usr_summary) ? 1 : 0 );
+        cat.allow_freetext( (usr_freetext) ? 1 : 0 );
     }
 
     var req = new Request( SC_UPDATE.replace(/TYPE/,type), session, cat );

diff --git a/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.xhtml b/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.xhtml
index 0e98cba..f644cae 100644 (file)
--- a/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.xhtml
+++ b/Open-ILS/xul/staff_client/server/admin/stat_cat_editor.xhtml
@@ -104,6 +104,15 @@
                         </td>
                     </tr>
                     <tr>
+                        <td id='usr_freetext_td1'>&staff.server.admin.stat_cat.allow_freetext;</td>
+                        <td id='usr_freetext_td2'>    
+                            <span>&staff.server.admin.stat_cat.on;</span>
+                            <input type='radio' name='usr_freetext' id='sc_make_usr_freetext' checked='checked'> </input>
+                            <span>&staff.server.admin.stat_cat.off;</span>
+                            <input type='radio' name='usr_freetext'> </input>
+                        </td>
+                    </tr>
+                    <tr>
                         <td>&staff.server.admin.stat_cat.sip_field;</td>
                         <td>
                             <select name='sip_field' id='sc_sip_field'>
@@ -163,6 +172,7 @@
                             <td>&staff.server.admin.stat_cat.opac_visibility.label;</td>
                             <td id='sc_required_label'>&staff.server.admin.stat_cat.required.label;</td>
                             <td id='sc_usr_summary_label'>&staff.server.admin.stat_cat.usr_summary.label;</td>
+                            <td id='sc_usr_freetext_label'>&staff.server.admin.stat_cat.allow_freetext.label;</td>
                             <td>&staff.server.admin.stat_cat.sip_field.label;</td>
                             <td>&staff.server.admin.stat_cat.sip_format.label;</td>
                             <td>&staff.server.admin.stat_cat.checkout_archive.label;</td>
@@ -176,7 +186,6 @@
                         <tr id='sc_tr'>
                             <td><b name='sc_name'> </b></td>
                             <td name='sc_owning_lib'> </td>
-    
                             <td>
                                 <span class='hide_me' name='sc_opac_visible'>&staff.server.admin.stat_cat.on;</span> 
                                 <span class='hide_me' name='sc_opac_invisible'>&staff.server.admin.stat_cat.off;</span> 
@@ -189,6 +198,10 @@
                                 <span class='hide_me' name='sc_usr_summary_on'>&staff.server.admin.stat_cat.on;</span> 
                                 <span class='hide_me' name='sc_usr_summary'>&staff.server.admin.stat_cat.off;</span> 
                             </td>
+                            <td name='sc_usr_freetext_td'>
+                                <span class='hide_me' name='sc_usr_freetext_on'>&staff.server.admin.stat_cat.on;</span> 
+                                <span class='hide_me' name='sc_usr_freetext'>&staff.server.admin.stat_cat.off;</span> 
+                            </td>
                             <td>
                                 <span class='hide_me' name='sc_sip_field_none'>&staff.server.admin.stat_cat.sip_field.none.label;</span>
                                 <span class='hide_me' name='sc_sip_field_value' ></span>
@@ -236,16 +249,8 @@
                     <span class='hide_me' name='sc_edit_show_owning_lib'> </span>
                     <select class='hide_me' name='sc_edit_owning_lib'> </select>
                 </td>
-
-                <td>
-                    <span>&staff.server.admin.stat_cat.on;</span>
-                    <span name='sc_edit_opac_vis'>
-                        <input type='radio' name='sc_edit_opac_visibility'> </input>
-                    </span>
-                    <span>&staff.server.admin.stat_cat.off;</span>
-                    <span name='sc_edit_opac_invis'>
-                        <input type='radio' name='sc_edit_opac_visibility'> </input>
-                    </span>
+                <td name='sc_edit_opac_visibility_td'>
+                    <input type='checkbox' name='sc_edit_opac_visibility'/>
                 </td>
                 <td name='sc_edit_required_td'>
                     <input type='checkbox' name='sc_edit_required'/>
@@ -253,6 +258,9 @@
                 <td name='sc_edit_usr_summary_td'>
                     <input type='checkbox' name='sc_edit_usr_summary'/>
                 </td>
+                <td name='sc_edit_usr_freetext_td'>
+                    <input type='checkbox' name='sc_edit_usr_freetext'/>
+                </td>
                 <td>
                     <select name='sc_edit_sip_field'>
                         <option value=''>&staff.server.admin.stat_cat.sip_field.none;</option>