From eb7fcbc83bd05adfcde9d3e6863da603578b3581 Mon Sep 17 00:00:00 2001
From: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
Date: Tue, 28 Aug 2012 14:38:25 -0400
Subject: [PATCH] Refactor create_session as dojo module.

Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
---
 .../src/templates/url_verify/create_session.tt2    |  14 +--
 .../openils/URLVerify/CreateSession.js}            | 119 +++++++++++++--------
 .../url_verify.js => URLVerify/nls/URLVerify.js}   |   3 +-
 3 files changed, 82 insertions(+), 54 deletions(-)
 rename Open-ILS/web/js/{ui/default/url_verify/create_session.js => dojo/openils/URLVerify/CreateSession.js} (73%)
 rename Open-ILS/web/js/dojo/openils/{url_verify/nls/url_verify.js => URLVerify/nls/URLVerify.js} (72%)

diff --git a/Open-ILS/src/templates/url_verify/create_session.tt2 b/Open-ILS/src/templates/url_verify/create_session.tt2
index 0df3b4a08c..d29ccd9765 100644
--- a/Open-ILS/src/templates/url_verify/create_session.tt2
+++ b/Open-ILS/src/templates/url_verify/create_session.tt2
@@ -6,17 +6,17 @@
     dojo.require("dijit.form.TextBox");
     dojo.require("openils.Util");
     dojo.require("openils.widget.ProgressDialog");
+    dojo.require("openils.URLVerify.CreateSession");
+
+    var module;
 
     openils.Util.addOnLoad(
         function() {
-            progress_dialog.show(true);
-            create_session.populate_saved_searches(dojo.byId("saved-searches"));
-            create_session.prepare_org_selector(dojo.byId("org-selector"));
-            progress_dialog.hide();
+            module = openils.URLVerify.CreateSession;
+            module.setup("saved-searches", "org-selector", progress_dialog);
         }
     );
 </script>
-<script type="text/javascript" src="[% ctx.media_prefix %]/js/ui/default/url_verify/create_session.js"></script>
 <style type="text/css">
     #uv-search { width: 20em; }
     .note { font-style: italic; background-color: #eee; }
@@ -111,7 +111,7 @@
                         <input type="text" size="4" maxlength="3" />
                         [% l("Subfield(s)") %]
                         <input type="text" size="15" />
-                        <a href="javascript:create_session.tag_and_subfields.add();">[% l('Add') %]</a>
+                        <a href="javascript:module.tag_and_subfields.add();">[% l('Add') %]</a>
                     </div>
                 </td>
                 <td class="note">
@@ -121,7 +121,7 @@
 
         <div>
             <button dojoType="dijit.form.Button"
-                onClick="create_session.begin();">[% l('Begin') %]</button>
+                onClick="module.begin();">[% l("Begin") %]</button>
 
         </div>
     </div>
diff --git a/Open-ILS/web/js/ui/default/url_verify/create_session.js b/Open-ILS/web/js/dojo/openils/URLVerify/CreateSession.js
similarity index 73%
rename from Open-ILS/web/js/ui/default/url_verify/create_session.js
rename to Open-ILS/web/js/dojo/openils/URLVerify/CreateSession.js
index 867d2aa376..cb79e82b79 100644
--- a/Open-ILS/web/js/ui/default/url_verify/create_session.js
+++ b/Open-ILS/web/js/dojo/openils/URLVerify/CreateSession.js
@@ -1,22 +1,29 @@
-dojo.require("dojo.data.ItemFileWriteStore");
-dojo.require("dojox.jsonPath");
+if (!dojo._hasResource["openils.URLVerify.CreateSession"]) {
+    dojo.require("dojo.data.ItemFileWriteStore");
+    dojo.require("dojox.jsonPath");
+    dojo.require("fieldmapper.OrgUtils");
+    dojo.require("openils.Util");
+    dojo.require("openils.PermaCrud");
+    dojo.require("openils.widget.FilteringTreeSelect");
 
-dojo.require("fieldmapper.OrgUtils");
-dojo.require("openils.PermaCrud");
-dojo.require("openils.widget.FilteringTreeSelect");
-dojo.requireLocalization("openils.url_verify", "url_verify");
+    dojo.requireLocalization("openils.URLVerify", "URLVerify");
 
-/* From here on, we add nothing to the global namespace but create_session */
-var create_session = {};
+    dojo._hasResource["openils.URLVerify.CreateSession"] = true;
+    dojo.provide("openils.URLVerify.CreateSession");
+
+    dojo.declare("openils.URLVerify.CreateSession", null, {});
+
+    /* Take care that we add nothing to the global namespace. */
 
 (function() {
+    var module = openils.URLVerify.CreateSession;
     var localeStrings =
-        dojo.i18n.getLocalization("openils.url_verify", "url_verify");
+        dojo.i18n.getLocalization("openils.URLVerify", "URLVerify");
     var uvus_progress = 0;
 
     /* Take search text box input, selected saved search ids, and selected
      * scope shortname to produce one search string. */
-    create_session._prepare_search = function(basic, saved, scope) {
+    module._prepare_search = function(basic, saved, scope) {
         if (saved.length) {
             basic += " " + dojo.map(
                 saved, function(s) { return "saved_query(" + s + ")"; }
@@ -33,13 +40,13 @@ var create_session = {};
      * first of three server-side processes necessary to create a session:
      *
      * 1) create the session itself (API call), */
-    create_session.begin = function() {
+    module.begin = function() {
         var name = uv_session_name.attr("value");
 
         var scope;
         try {
-            scope = create_session.org_selector.store.getValue(
-                create_session.org_selector.item,
+            scope = module.org_selector.store.getValue(
+                module.org_selector.item,
                 "shortname"
             );
         } catch (E) {
@@ -47,7 +54,7 @@ var create_session = {};
             void(0);
         }
 
-        var search = create_session._prepare_search(
+        var search = module._prepare_search(
             uv_search.attr("value"),
             dojo.filter(
                 dojo.byId("saved-searches").options,
@@ -58,13 +65,13 @@ var create_session = {};
             scope
         );
 
-        if (!create_session.tag_and_subfields.any()) {
+        if (!module.tag_and_subfields.any()) {
             alert(localeStrings.NEED_UVUS);
             return;
         }
 
-        progress_dialog.attr("title", localeStrings.CREATING);
-        progress_dialog.show(true);
+        module.progress_dialog.attr("title", localeStrings.CREATING);
+        module.progress_dialog.show(true);
         fieldmapper.standardRequest(
             ["open-ils.url_verify", "open-ils.url_verify.session.create"], {
                 "params": [openils.User.authtoken, name, search],
@@ -72,8 +79,8 @@ var create_session = {};
                 "onresponse": function(r) {
                     if (r = openils.Util.readResponse(r)) {
                         /* I think we're modal enough to get away with this. */
-                        create_session.session_id = r;
-                        create_session.save_tags();
+                        module.session_id = r;
+                        module.save_tags();
                     }
                 }
             }
@@ -81,9 +88,9 @@ var create_session = {};
     };
 
     /* 2) save the tag/subfield sets for URL extraction, */
-    create_session.save_tags = function() {
-        progress_dialog.attr("title", localeStrings.SAVING_TAGS);
-        progress_dialog.show(); /* sic */
+    module.save_tags = function() {
+        module.progress_dialog.attr("title", localeStrings.SAVING_TAGS);
+        module.progress_dialog.show(); /* sic */
 
         uvus_progress = 0;
 
@@ -97,10 +104,10 @@ var create_session = {};
             "method": "open-ils.pcrud.transaction.begin",
             "params": [openils.User.authtoken],
             "oncomplete": function(r) {
-                create_session._create_uvus_one_at_a_time(
+                module._create_uvus_one_at_a_time(
                     pcrud_raw,
-                    create_session.tag_and_subfields.generate_uvus(
-                        create_session.session_id
+                    module.tag_and_subfields.generate_uvus(
+                        module.session_id
                     )
                 );
             }
@@ -108,13 +115,13 @@ var create_session = {};
     };
 
     /* 2b */
-    create_session._create_uvus_one_at_a_time = function(pcrud_raw, uvus_list) {
+    module._create_uvus_one_at_a_time = function(pcrud_raw, uvus_list) {
         pcrud_raw.request({
             "method": "open-ils.pcrud.create.uvus",
             "params": [openils.User.authtoken, uvus_list[0]],
             "oncomplete": function(r) {
                 var new_uvus = openils.Util.readResponse(r);
-                progress_dialog.update(
+                module.progress_dialog.update(
                     {"maximum": uvus_list.length, "progress": ++uvus_progress}
                 );
 
@@ -126,12 +133,12 @@ var create_session = {};
                         "params": [openils.User.authtoken],
                         "oncomplete": function(r) {
                             pcrud_raw.disconnect();
-                            create_session.perform_search();
+                            module.perform_search();
                         }
                     }).send();
 
                 } else {
-                    create_session._create_uvus_one_at_a_time(
+                    module._create_uvus_one_at_a_time(
                         pcrud_raw, uvus_list
                     );
                 }
@@ -141,44 +148,46 @@ var create_session = {};
 
     /* 3) search and populate the container (API call). */
     var search_result_count = 0;
-    create_session.perform_search = function() {
-        progress_dialog.attr("title", localeStrings.PERFORMING_SEARCH);
-        progress_dialog.show(true);
+    module.perform_search = function() {
+        module.progress_dialog.attr("title", localeStrings.PERFORMING_SEARCH);
+        module.progress_dialog.show(true);
 
         fieldmapper.standardRequest(
             ["open-ils.url_verify",
                 "open-ils.url_verify.session.search_and_extract"], {
-                "params": [openils.User.authtoken, create_session.session_id],
+                "params": [openils.User.authtoken, module.session_id],
                 "async": true,
                 "onresponse": function(r) {
                     r = openils.Util.readResponse(r);
                     if (!search_result_count) {
                         search_result_count = Number(r);
 
-                        progress_dialog.show(); /* sic */
-                        progress_dialog.attr(
+                        module.progress_dialog.show(); /* sic */
+                        module.progress_dialog.attr(
                             "title", localeStrings.EXTRACTING_URLS
                         );
-                        progress_dialog.update(
+                        module.progress_dialog.update(
                             {"maximum": search_result_count, "progress": 0}
                         );
                     } else {
-                        progress_dialog.update({"progress": r.length})
+                        module.progress_dialog.update({"progress": r.length})
                     }
                 },
                 "oncomplete": function() {
-                    progress_dialog.attr("title", localeStrings.REDIRECTING);
-                    progress_dialog.show(true);
+                    module.progress_dialog.attr(
+                        "title", localeStrings.REDIRECTING
+                    );
+                    module.progress_dialog.show(true);
 
                     if (no_url_selection.checked) {
                         location.href = oilsBasePath +
                             "/url_verify/validation_review?" +
-                            "session_id=" + create_session.session_id +
+                            "session_id=" + module.session_id +
                             "&validate=1";
                     } else {
                         location.href = oilsBasePath +
                             "/url_verify/select_urls?session_id=" +
-                            create_session.session_id;
+                            module.session_id;
                     }
                 }
             }
@@ -190,8 +199,9 @@ var create_session = {};
      * data store.  So we'll use a native <select> control, which will have
      * fewer moving parts that can go haywire anyway.
      */
-    create_session.populate_saved_searches = function(node) {
-        var list = (new openils.PermaCrud()).retrieveAll(
+    module._populate_saved_searches = function(node) {
+        var pcrud = new openils.PermaCrud();
+        var list = pcrud.retrieveAll(
             "asq", {"order_by": {"asq": "label"}}
         );
 
@@ -207,10 +217,12 @@ var create_session = {};
                 );
             }
         );
+
+        pcrud.disconnect();
     };
 
     /* set up an all-org-units-in-the-tree selector */
-    create_session.prepare_org_selector = function(node) {
+    module._prepare_org_selector = function(node) {
         var widget = new openils.widget.FilteringTreeSelect(null, node);
         widget.searchAttr = "name";
         widget.labelAttr = "name";
@@ -219,7 +231,19 @@ var create_session = {};
         widget.startup();
         widget.attr("value", openils.User.user.ws_ou());
 
-        create_session.org_selector = widget;
+        module.org_selector = widget;
+    };
+
+    module.setup = function(saved_search_id, org_selector_id, progress_dialog) {
+        module.progress_dialog = progress_dialog;
+
+        module.progress_dialog.attr("title", localeStrings.INTERFACE_SETUP);
+        module.progress_dialog.show(true);
+
+        module._populate_saved_searches(dojo.byId(saved_search_id));
+        module._prepare_org_selector(dojo.byId(org_selector_id));
+
+        module.progress_dialog.hide();
     };
 
     /* This is the thing that lets you add/remove rows of tab/subfield pairs */
@@ -317,9 +341,12 @@ var create_session = {};
 
             return uvus_list;
         };
+
     }
 
-    create_session.tag_and_subfields =
+    module.tag_and_subfields =
         new TagAndSubfieldsMgr("uv-tags-and-subfields");
 
 }());
+
+}
diff --git a/Open-ILS/web/js/dojo/openils/url_verify/nls/url_verify.js b/Open-ILS/web/js/dojo/openils/URLVerify/nls/URLVerify.js
similarity index 72%
rename from Open-ILS/web/js/dojo/openils/url_verify/nls/url_verify.js
rename to Open-ILS/web/js/dojo/openils/URLVerify/nls/URLVerify.js
index 91244ffdad..5b00a3e6e4 100644
--- a/Open-ILS/web/js/dojo/openils/url_verify/nls/url_verify.js
+++ b/Open-ILS/web/js/dojo/openils/URLVerify/nls/URLVerify.js
@@ -4,5 +4,6 @@
     "PERFORMING_SEARCH": "Performing search ...",
     "EXTRACTING_URLS": "Extracting URLs ...",
     "NEED_UVUS": "You must add some tag and subfield combinations",
-    "REDIRECTING": "Loading next interface ..."
+    "REDIRECTING": "Loading next interface ...",
+    "INTERFACE_SETUP": "Setting up interface ..."
 }
-- 
2.11.0