commonwealth-vlr-engine 0.0.1

data/app/views/folders/edit.html.erb

@@ -0,0 +1,25 @@
+<% @page_title = t('blacklight.folders.edit_folder') + " - " + application_name %>
+<div class="col-sm-9">
+  <div id="breadcrumb">
+    <ul class="breadcrumb">
+      <li>
+        <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <li>
+        <%= link_to(t('blacklight.folders.list_title'), folders_path) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <li class="active">
+        <%= t('blacklight.folders.edit_folder') + ': ' + @folder.title %>
+      </li>
+    </ul>
+  </div>
+  <div id="edit_folder" class="folder_container">
+
+    <h2><%= t('blacklight.folders.edit_folder') + ': ' + @folder.title %></h2>
+
+    <%= render 'new_edit_form_fields', :form_object => @folder, :submit_button_text => 'Update folder' %>
+
+  </div>
+</div>

data/app/views/folders/index.html.erb

@@ -0,0 +1,73 @@
+<% @page_title = t('blacklight.folders.list_title') + " - " + application_name %>
+<div class="col-sm-9">
+
+  <div id="breadcrumb">
+    <ul class="breadcrumb">
+      <% if current_user %>
+          <li>
+            <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+            <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+          </li>
+      <% end %>
+      <li class="active">
+        <%= t('blacklight.folders.list_title') %>
+      </li>
+    </ul>
+  </div>
+
+<h2>
+  <%= t('blacklight.folders.list_title') %>
+  <small id="add_folder">
+    <%= link_to(
+                content_tag(:span, '', :class=>'glyphicon glyphicon-plus') + ' add folder',
+                new_folder_path,
+                :id => 'create_folder_link',
+                :class => 'btn btn-primary btn-sm'
+        ) %>
+  </small>
+</h2>
+
+<% if current_or_guest_user.blank? %>
+
+    <% redirect to login %>
+
+<% else %>
+
+    <div id="user_folders" class="folder_container">
+      <p><%= t('blacklight.folders.intro') %></p>
+      <ul id="user_folder_list">
+        <li>
+          <h4>
+            <%= link_to t('blacklight.bookmarks.title'), bookmarks_path, :class => "folder_title" %>
+            <small class="folder_visibility">
+              <% if current_user %>
+                  <%= content_tag(:span, '', :class => 'glyphicon glyphicon-lock') %>
+                  <span class="visibility_private">private</span>
+              <% end %>
+            </small>
+          </h4>
+          <div class="folder_status">
+            <span class="folder_item_count">
+              <%= pluralize(current_or_guest_user.bookmarks.length.to_s,
+                    'item') %>
+            </span>
+          </div>
+          <%= t('blacklight.bookmarks.description') %>
+        </li>
+        <% unless @folders.blank? %>
+            <%= render @folders %>
+        <% end %>
+      </ul>
+    </div>
+
+
+<% end %>
+
+</div>
+<div class="col-sm-3">
+  <div id="public_folders_sidebar" class="well well-sm">
+    <ul>
+      <li><%= link_to 'View all shared folders', public_folders_path %></li>
+    </ul>
+  </div>
+</div>

data/app/views/folders/new.html.erb

@@ -0,0 +1,27 @@
+<% @page_title = t('blacklight.folders.add_folder') + " - " + application_name %>
+<div class="col-sm-9">
+
+  <div id="breadcrumb">
+    <ul class="breadcrumb">
+      <li>
+        <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <li>
+        <%= link_to(t('blacklight.folders.list_title'), folders_path) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <li class="active">
+        <%= t('blacklight.folders.add_folder') %>
+      </li>
+    </ul>
+  </div>
+
+  <div id="new_folder" class="folder_container">
+
+    <h2><%= t('blacklight.folders.add_folder') %></h2>
+
+    <%= render 'new_edit_form_fields', :form_object => @folder, :submit_button_text => 'Create Folder' %>
+
+  </div>
+</div>

data/app/views/folders/public_list.html.erb

@@ -0,0 +1,44 @@
+<% @page_title = t('blacklight.folders.public_list.title') + " - " + application_name %>
+<div class="col-sm-9">
+
+  <div id="breadcrumb">
+    <ul class="breadcrumb">
+      <% if current_user %>
+          <li>
+            <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+            <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+          </li>
+      <% end %>
+      <li>
+        <%= link_to(t('blacklight.folders.list_title'), folders_path) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <li class="active">
+        <%= t('blacklight.folders.public_list.title') %>
+      </li>
+    </ul>
+  </div>
+
+  <h2>
+    <%= t('blacklight.folders.public_list.title') %>
+    <small id="add_folder">
+      <%= link_to(
+                  content_tag(:span, '', :class => 'glyphicon glyphicon-plus') + ' add folder',
+                  new_folder_path,
+                  :id => 'create_folder_link',
+                  :class => 'btn btn-primary btn-sm'
+          ) %>
+    </small>
+  </h2>
+
+  <div id="user_folders" class="folder_container">
+    <p><%= t('blacklight.folders.public_list.intro') %></p>
+    <ul id="user_folder_list" class="public_folders">
+      <% unless @folders.blank? %>
+          <%= render @folders %>
+      <% end %>
+    </ul>
+  </div>
+
+</div>
+

data/app/views/folders/show.html.erb

@@ -0,0 +1,98 @@
+<% @page_title = @folder.title + " - " + application_name %>
+
+<%= javascript_include_tag 'commonwealth-vlr-engine/folder_tools' %>
+
+<div id="content" class="folder_show_container col-sm-9">
+
+  <div id="breadcrumb">
+    <ul class="breadcrumb">
+      <% if current_user %>
+          <li>
+            <%= link_to(t('blacklight.users.account_heading'), current_user) %>
+            <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+          </li>
+      <% end %>
+      <li>
+        <%= link_to(t('blacklight.folders.list_title'), folders_path) %>
+        <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+      </li>
+      <% unless current_user and current_user.folders.include?(@folder) %>
+          <li>
+            <%= link_to(t('blacklight.folders.public_list.title'), public_folders_path) %>
+            <span class="divider"><%= t('blacklight.breadcrumb.separator') %></span>
+          </li>
+      <% end %>
+      <li class="active">
+        <%= @folder.title %>
+      </li>
+    </ul>
+  </div>
+
+  <h2>
+    <%= @folder.title %>
+    <% if current_user && folder_belongs_to_user %>
+        <small id="folder_tools">
+          <div class="folder_visibility">
+            <% if @folder.visibility == 'public' %>
+                <%= content_tag(:span, '', :class => 'glyphicon glyphicon-eye-open') %>
+                <span class="visibility_public"><%= @folder.visibility %></span>
+            <% else %>
+                <%= content_tag(:span, '', :class => 'glyphicon glyphicon-lock') %>
+                <span class="visibility_private"><%= @folder.visibility %></span>
+            <% end %>
+          </div>
+          <%= link_to(content_tag(:span,'',:class=>'glyphicon glyphicon-pencil') + ' ' + t('blacklight.folders.edit'),
+                      edit_folder_path(@folder),
+                      :class => 'btn btn-default btn-sm',
+                      :title => 'edit this folder') %>
+          <%= link_to(content_tag(:span,'',:class=>'glyphicon glyphicon-trash') + ' ' + t('blacklight.folders.delete.delete'),
+                      @folder,
+                      :class => 'btn btn-default btn-sm',
+                      :method => :delete,
+                      :data => { :confirm => t('blacklight.folders.delete.confirm') },
+                      :title => t('blacklight.folders.delete.delete')) %>
+          <%# if @folder_items.length > 0 %>
+              <%# link_to(content_tag(:span,'',:class=>'glyphicon glyphicon-remove') + ' ' + t('blacklight.folder_items.clear.action'),
+                          clear_folder_items_path,
+                          :class => 'btn btn-default btn-sm',
+                          :method => :delete,
+                          :data => { :confirm => t('blacklight.folder_items.clear.confirm') }) %>
+          <%# end %>
+        </small>
+    <% end %>
+  </h2>
+
+  <%# render 'shared/tools' %>
+  <% if @folder.description %>
+      <div id="folder_description">
+        <%= @folder.description %>
+      </div>
+  <% end %>
+
+  <% unless @folder_items.empty? %>
+
+      <%= render 'catalog/sort_and_per_page' %>
+
+      <%= form_tag selected_folder_items_actions_path, :method => :put, :id => "item_actions_form" do %>
+
+        <%= render :partial => 'shared/folder_item_actions' %>
+
+        <%= render_document_index %>
+
+      <% end %>
+
+      <%= render 'catalog/results_pagination' %>
+
+  <% else %>
+    <div id="empty_folder" class="well">
+      <h5><%= t('blacklight.folders.empty') %></h5>
+      <p><%= t('blacklight.folders.help.add_items') %></p>
+    </div>
+
+  <% end %>
+
+</div>
+
+<div id="sidebar" class="col-sm-3 folder_facets">
+  <%# render 'catalog/search_sidebar' %>
+</div><!--/well -->

data/app/views/image_viewer/_book_viewer_help.html.erb

@@ -0,0 +1,125 @@
+<div id="help" class="">
+  <div>
+    <div>
+      <div>
+        <h2>
+          How to use this reader
+        </h2>
+        <p>
+          <i class="fa fa-search"></i> <strong>Search</strong>: search the text of this item<br/>
+          <i class="fa fa-plus"></i> <strong>Zoom</strong>: view a page in greater detail<br/>
+          <i class="fa fa-th-large"></i> <strong>Page List</strong>: view a list of pages for easy navigation<br/>
+          <i class="fa fa-book"></i> <strong>Read</strong>: flip through the pages of the item
+        </p>
+        <section class="keyboard-controls">
+          <h3>
+            Keyboard Navigation
+          </h3>
+          <table>
+            <tr>
+              <th>
+                Go to next page
+              </th>
+              <td>
+                <kbd>Page Down</kbd>, <kbd>spacebar</kbd>, <kbd>j</kbd>
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Go to previous page
+              </th>
+              <td>
+                <kbd>Page Up</kbd>, <kbd>shift+spacebar</kbd>, <kbd>k</kbd>
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Display the 'search inside' form
+              </th>
+              <td>
+                <kbd>q</kbd>
+              </td>
+            </tr>
+            <tr class="requires-rotation">
+              <th>Rotate Left</th>
+              <td>
+                <kbd>alt+left arrow</kbd>
+              </td>
+            </tr>
+            <tr class="requires-rotation">
+              <th>Rotate Right</th>
+              <td>
+                <kbd>alt+right arrow</kbd>
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Switch to page list view
+              </th>
+              <td>
+                <kbd>p</kbd>
+              </td>
+            </tr>
+            <tr class="requires-fullscreen">
+              <th>
+                Enter fullscreen mode
+              </th>
+              <td>
+                <kbd>f</kbd>
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Display help
+              </th>
+              <td>
+                <kbd>?</kbd>
+              </td>
+            </tr>
+          </table>
+        </section>
+        <section class="touch-controls">
+          <h3>
+            Touch Controls
+          </h3>
+          <table>
+            <tr>
+              <th>
+                Go to next page
+              </th>
+              <td>
+                Swipe across screen to the right, or<br>
+                Tap on right edge of screen
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Go to previous page
+              </th>
+              <td>
+                Swipe across screen to the left, or<br>
+                Tap on left edge of screen
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Switch to grid view
+              </th>
+              <td>
+                Tap "Page List" <i class="fa fa-th-large"></i>
+              </td>
+            </tr>
+            <tr>
+              <th>
+                Zoom in on a page
+              </th>
+              <td>
+                Tap "Zoom" <i class="fa fa-plus"></i>
+              </td>
+            </tr>
+          </table>
+        </section>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/image_viewer/_render_book_viewer.html.erb

@@ -0,0 +1,185 @@
+<%# wdl-viewer JS to render book viewer %>
+<%# adapted from https://github.com/LibraryOfCongress/wdl-viewer/examples %>
+    <script type="text/javascript">
+Modernizr.load([
+    {
+        test: Modernizr.inputtypes.range && Modernizr.history,
+        nope: [
+            /* https://github.com/freqdec/fd-slider */
+            '<%= stylesheet_path('wdl-viewer/fd-slider.min') %>',
+            '<%= javascript_path('wdl-viewer/fd-slider') %>'
+        ],
+        callback: function(id, testResult) {
+            if ("fdSlider" in window && typeof(fdSlider.onDomReady) != "undefined") {
+                fdSlider.onDomReady();
+            };
+        }
+    },
+    {
+        test: Modernizr.history,
+        complete: function() {
+            // Slightly wonky double check but callback: won't fire if you don't load anything
+            // and this keeps polyfills in one place:
+            if (!Modernizr.history) {
+                window.history.replaceState = function (state, title, url) {
+                    if (document.location.href == url || document.location.pathname == url) {
+                        return;
+                    } else {
+                        document.location.href = url;
+                    }
+                }
+                // Force page navigation rather than simply updating the current anchor:
+                $('.next.page, .previous.page').on('click', function (evt) {
+                    document.location.href = this.href;
+                    document.location.reload();
+                })
+            } else {
+                $(".next.page").on("click", function () {
+                    $viewer.trigger("goto-next-page"); return false;
+                })
+                $(".previous.page").on("click", function () {
+                    $viewer.trigger("goto-previous-page"); return false;
+                })
+            }
+        }
+    },
+    {
+        test: Modernizr.touch,
+        yep: ['<%= javascript_path('wdl-viewer/jquery.hammer.min') %>'],
+        complete: function(id, testResult) {
+            if (Modernizr.touch && typeof(jQuery.fn.hammer) !== "undefined") {
+                $(window).hammer()
+                        .on("swipeleft", function () { $viewer.trigger("goto-next-page"); })
+                        .on("swiperight", function () { $viewer.trigger("goto-previous-page"); });
+
+                var lastTimeoutId;
+
+                var viewer = document.getElementById("viewer");
+                // By default, touchmove events as fired when attempting rotation can cause Mobile
+                // Safari to "bounce" the viewport, displaying the standard gray background, which is
+                // quite unpleasant in the middle of a rotation:
+                document.ontouchmove = function(evt) {
+                    if (viewer.dataset.activeView != "grid") {
+                        evt.preventDefault();
+                    }
+                }
+
+                $("#pages").hammer()
+                        .on("tap", function (evt) {
+                            if (evt.gesture.center.pageX < 50) {
+                                $viewer.trigger("goto-previous-page");
+                            } else if ($(window).width() - evt.gesture.center.pageX < 50) {
+                                $viewer.trigger("goto-next-page");
+                            } else {
+                                $viewer.trigger("toggle-chrome");
+                            }
+
+                            if (lastTimeoutId) {
+                                window.clearTimeout(lastTimeoutId);
+                            }
+
+                            lastTimeoutId = window.setTimeout(function () {
+                                $viewer.trigger("hide-chrome");
+                            }, 6000);
+                        })
+                        .on("pinchout", function (evt) {
+                            if (Math.abs(evt.gesture.rotation) < 20 && evt.gesture.scale > 3.0) {
+                                $viewer.trigger("open-seadragon");
+                                evt.preventDefault();
+                            }
+                        })
+                        .on("rotate", function (evt) {
+                            $viewer.trigger("set-rotation", evt.gesture.rotation);
+                            evt.preventDefault();
+                        });
+
+                $viewer.on("page-changed", function () {
+                    $viewer.trigger("hide-chrome");
+                });
+            }
+        }
+    }
+]);
+
+function generateImageUrl(group, index, maxEdge) {
+    // return the pid for the given index
+    var pid = image_files[index-1];
+    return image_server + pid + "/full/pct:30/0/default.jpg"
+}
+
+// hijacking this function to return IIIF info.json as tileSource
+function generateDziUrl(group, index) {
+    var pid = image_files[index-1];
+    return image_server + pid + '/info.json';
+}
+
+// use thumbnail300 datastream for thumbnails
+function generateThumbUrl(group, index) {
+    var pid = image_files[index-1];
+    return '<%= datastream_disseminator_url('xyz', 'thumbnail300') %>'.replace("xyz", pid)
+}
+
+// return JSON coords datastream URL
+function generateWordCoordsUrl(group, index) {
+    var pid = image_files[index-1];
+    return '<%= datastream_disseminator_url('xyz', 'djvuCoords') %>'.replace("xyz", pid)
+}
+
+var bookmark = document.location.hash.match(/^#(\d+)\/(\d+)$/);
+
+var image_server = "<%= IIIF_SERVER['url'] %>";
+
+var image_files = <%= image_files.to_json.html_safe %>;
+
+var $window = $(window),
+        $viewer = $("#viewer").wdlViewer({
+            pageGroups: {"1": <%= image_files.count %>}, // List of groups and the last index value in each
+            pageUrlTemplate: "#1/{index}",
+            imageUrlTemplate: generateImageUrl,
+            dziUrlTemplate: generateDziUrl,
+            placeholderSrc: "<%= image_path('commonwealth-vlr-engine/loading-wdl-grid.gif') %>",
+            initialView: "page",
+            seadragonPrefixUrl: '', // "/assets/commonwealth-vlr-engine/openseadragon/"
+            seadragonNavImages: $.parseJSON('<%= osd_nav_images('commonwealth-vlr-engine/openseadragon').html_safe %>'),
+            thumbUrlTemplate: generateThumbUrl,
+            fts: <%= @document[:identifier_ia_id_ssi] ? 'true' : 'false' %>,
+            wordCoordinatesUrlTemplate: generateWordCoordsUrl,
+            ocrSearchPath: "<%= ocr_search_path %>"
+        });
+/* this makes the text on the controls disappear!
+ if (Modernizr.fontface) {
+ $viewer.find(".controls button, .toolbar a.page").each(function () {
+ var $this = $(this);
+ $this
+ .attr("title", $.trim($this.text()))
+ .empty(); // Clearing the button avoids a Chrome bug which mispositions the icon text
+ });
+ }
+ */
+$("input,select").removeAttr("disabled");
+
+// Help browsers which don't support <link rel="prefetch">:
+$viewer.trigger("prefetch-adjacent-pages");
+
+$viewer.on("page-changed", function () {
+    // If you use Google Analytics:
+    // _gaq.push(['_trackPageview', document.location.pathname]);
+});
+
+$window.on("resize", function () {
+    /*
+     This works around IE<9's lack of any support for viewport units and WebKit not correctly
+     recalculating them after a window resize (see https://bugs.webkit.org/show_bug.cgi?id=114690)
+     */
+    $("#pages img").css({
+        "max-height": $window.height(),
+        "max-width": $window.width()
+    });
+
+    $viewer.find("h1").css("max-width", $window.width() - 20);
+}).trigger("resize");
+
+if (bookmark) {
+    $viewer.trigger("goto-page", [bookmark[1], bookmark[2]]);
+}
+</script>