/*global define */
define([
"jquery",
"underscore",
"backbone",
"models/PackageModel",
"views/CitationView",
"text!templates/resultsItem.html",
], function ($, _, Backbone, Package, CitationView, ResultItemTemplate) {
"use strict";
/**
* @class SearchResultView
* @classdesc A single result item view
* @name SearchResultView
* @classcategory Views
* @extends Backbone.View
* @constructor
* @screenshot views/search/SearchResultView.png
*/
return Backbone.View.extend(
/**
* @lends SearchResultView.prototype
*/ {
/**
* The tag name for the view's element
* @type {string}
*/
tagName: "div",
/**
* The HTML classes to use for this view's element
* @type {string}
*/
className: "row-fluid result-row",
/**
* The HTML template to use for this view's main element
* @type {underscore.template}
*/
template: _.template(ResultItemTemplate),
/**
* The HTML template to use for the metrics statics
* @type {underscore.template}
*/
metricStatTemplate: _.template(
`<span class='catalog badge'>
<i class='catalog-metric-icon <%=metricIcon%>'></i> <%=metricValue%>
</span>`
),
/**
* The HTML template to use when showing that a result item is loading
* @type {string}
*/
loadingTemplate: `
<div class="result-row-loading">
<div class="citation-loading"></div>
<div class="circles-loading">
<div class="circle-loading"></div>
<div class="circle-loading"></div>
<div class="circle-loading"></div>
<div class="circle-loading"></div>
</div>
</div>`,
/**
* The events this view will listen to and the associated function to
* call.
* @type {Object}
*/
events: {
"click .result-selection": "toggleSelected",
"click .download": "download",
"mouseover .open-marker": "toggleShowOnMap",
"mouseout .open-marker": "toggleShowOnMap",
},
/**
* Initialize the view. The SearchResultView listens for changes to its
* model, re-rendering. Since there's a one-to-one correspondence between
* a **SolrResult** and a **SearchResultView** in this app, we set a
* direct reference on the model for convenience.
* @param {*} options
*/
initialize: function (options) {
if (typeof options !== "object") {
var options = {};
}
this.stopListening(this.model, "change", this.render);
this.stopListening(this.model, "reset", this.render);
this.listenTo(this.model, "change", this.render);
this.listenTo(this.model, "reset", this.render);
// this.listenTo(this.model, 'destroy', this.remove);
// this.listenTo(this.model, 'visible', this.toggleVisible);
if (typeof options.metricsModel !== "undefined")
this.metricsModel = options.metricsModel;
if (typeof options.className !== "undefined") {
this.className = options.className;
}
if (typeof options.template !== "undefined") {
this.template = options.template;
}
},
/**
* Render or re-render the result item.
* @returns {SearchResultView} Returns this view
*/
render: function () {
if (!this.model) {
return;
}
// Convert the model to JSON and create the result row from the template
var json = this.model.toJSON();
// Add other attributes to the JSON to send to the template
// Determine if there is a prov trace
json.hasProv = this.model.hasProvTrace();
// Add flag to add in annotation icon in results item view if
// appropriate
json.hasAnnotations =
json.sem_annotation &&
json.sem_annotation.length &&
json.sem_annotation.length > 0;
json.showAnnotationIndicator = MetacatUI.appModel.get(
"showAnnotationIndicator"
);
// Find the member node object
json.memberNode = _.findWhere(MetacatUI.nodeModel.get("members"), {
identifier: this.model.get("datasource"),
});
// Figure out if this object is a collection or portal
var isCollection =
this.model.getType() == "collection" ||
this.model.getType() == "portal";
// Determine if this metadata doc documents any data files
if (Array.isArray(json.documents) && json.documents.length) {
var dataFileIDs = _.without(
json.documents,
this.model.get("id"),
this.model.get("seriesId"),
this.model.get("resourceMap")
);
json.numDataFiles = dataFileIDs.length;
json.dataFilesMessage =
"This dataset contains " + json.numDataFiles + " data file";
if (json.numDataFiles > 1) {
json.dataFilesMessage += "s";
}
} else {
json.numDataFiles = 0;
json.dataFilesMessage = "This dataset doesn't contain any data files";
}
if (MetacatUI.appModel.get("displayRepoLogosInSearchResults")) {
// If this result has a logo and it is not a URL, assume it is an ID
// and create a full URL
if (json.logo && !json.logo.startsWith("http")) {
json.logo = MetacatUI.appModel.get("objectServiceUrl") + json.logo;
}
var datasourceId = json.memberNode
? json.memberNode.identifier
: json.datasource,
currentMemberNode =
MetacatUI.appModel.get("nodeId") || datasourceId;
// Construct a URL to the profile of this repository
json.profileURL =
datasourceId == currentMemberNode
? MetacatUI.root + "/profile"
: MetacatUI.appModel.get("dataoneSearchUrl") +
"/portals/" +
datasourceId.replace("urn:node:", "");
}
//Create a URL that leads to a view of this object
json.viewURL = this.model.createViewURL();
var resultRow = this.template(json);
this.$el.html(resultRow);
//Create the citation
var citation = new CitationView({ metadata: this.model }).render().el;
var placeholder = this.$(".citation");
if (placeholder.length < 1) this.$el.append(citation);
else $(placeholder).replaceWith(citation);
//Create the OpenURL COinS
var span = this.getOpenURLCOinS();
this.$el.append(span);
if (
MetacatUI.appModel.get("displayDatasetMetrics") &&
this.metricsModel
) {
if (this.metricsModel.get("views") !== null) {
// Display metrics if the model has already been fetched
this.displayMetrics();
} else if (this.metricsModel) {
// waiting for the fetch() call to succeed.
this.listenTo(this.metricsModel, "sync", this.displayMetrics);
}
}
if (isCollection) {
this.$el.addClass("collection");
}
//Save the id in the DOM for later use
var id = json.id;
this.$el.attr("data-id", id);
if (this.model.get("abstract")) {
var abridgedAbstract =
this.model.get("abstract").indexOf(" ", 250) < 0
? this.model.get("abstract")
: this.model
.get("abstract")
.substring(0, this.model.get("abstract").indexOf(" ", 250)) +
"...";
var content = $(document.createElement("div")).append(
$(document.createElement("p")).text(abridgedAbstract)
);
this.$(".popover-this.abstract").popover({
trigger: "hover",
html: true,
content: content,
title: "Abstract",
placement: "top",
container: this.el,
});
} else {
this.$(".popover-this.abstract").addClass("inactive");
this.$(".icon.abstract").addClass("inactive");
}
return this;
},
displayMetrics: function () {
try {
// If metrics for this object should be hidden, exit the function
if (this.model.hideMetrics()) {
return;
}
var datasets = this.metricsModel.get("datasets");
var downloads = this.metricsModel.get("downloads");
var views = this.metricsModel.get("views");
var citations = this.metricsModel.get("citations");
// Initializing the metric counts
var viewCount = 0;
var downloadCount = 0;
var citationCount = 0;
// Get the individual dataset metics only if the response from Metrics
// Service API has non-zero array sizes
if (datasets && datasets.length > 0) {
var index = datasets.indexOf(this.model.get("id"));
viewCount = views[index];
downloadCount = downloads[index];
citationCount = citations[index];
}
// Generating tool-tip title Citations
if (citationCount == 1) {
var citationToolTip = citationCount + " citation";
} else {
var citationToolTip =
MetacatUI.appView.numberAbbreviator(citationCount, 1) +
" citations";
}
// Downloads
if (downloadCount == 1) {
var downloadToolTip = downloadCount + " download";
} else {
var downloadToolTip =
MetacatUI.appView.numberAbbreviator(downloadCount, 1) +
" downloads";
}
// Views
if (viewCount == 1) {
var viewToolTip = viewCount + " view";
} else {
var viewToolTip =
MetacatUI.appView.numberAbbreviator(viewCount, 1) + " views";
}
// Replacing the metric total count with the spinning icon.
this.$(".resultItem-CitationCount")
.html(
this.metricStatTemplate({
metricValue: MetacatUI.appView.numberAbbreviator(
citationCount,
1
),
metricIcon: "icon-quote-right",
})
)
.tooltip({
placement: "top",
trigger: "hover",
delay: 800,
container: this.el,
title: citationToolTip,
});
this.$(".resultItem-DownloadCount")
.html(
this.metricStatTemplate({
metricValue: MetacatUI.appView.numberAbbreviator(
downloadCount,
1
),
metricIcon: "icon-cloud-download",
})
)
.tooltip({
placement: "top",
trigger: "hover",
delay: 800,
container: this.el,
title: downloadToolTip,
});
this.$(".resultItem-ViewCount")
.html(
this.metricStatTemplate({
metricValue: MetacatUI.appView.numberAbbreviator(viewCount, 1),
metricIcon: "icon-eye-open",
})
)
.tooltip({
placement: "top",
trigger: "hover",
delay: 800,
container: this.el,
title: viewToolTip,
});
// Removing Citation metric if the citationCount is 0 or undefined
if (!citationCount) {
this.$(".resultItem-CitationCount").css("visibility", "hidden");
}
// Removing Download metric if the downloadCount is 0
if (!downloadCount) {
this.$(".resultItem-DownloadCount").css("visibility", "hidden");
}
// Removing View metric if the viewCount is 0
if (!viewCount) {
this.$(".resultItem-ViewCount").css("visibility", "hidden");
}
} catch (e) {
console.log("Error displaying metrics: " + e);
}
},
/**
* Toggles the selected state of the model
*/
toggleSelected: function () {
this.model.toggle();
},
/**
* Toggles the showOnMap state of the model when the user hovers over
* or leaves the map marker icon
* @param {Event} e - The mouseover or mouseout event
*/
toggleShowOnMap: function (e) {
this.model.set("showOnMap", e.type === "mouseover")
},
/**
* Navigates the app to the metadata page for a result item that was
* clicked on
* @param {*} e - The click event
*/
routeToMetadata: function (e) {
var id = this.model.get("id");
//If the user clicked on a download button or any element with the class
//'stop-route', we don't want to navigate to the metadata
if (
$(e.target).hasClass("stop-route") ||
typeof id === "undefined" ||
!id
)
return;
MetacatUI.uiRouter.navigate("view/" + encodeURIComponent(id), {
trigger: true,
});
},
/**
* Downloads the data package for a result item that was clicked on
* @param {*} e - The click event
*/
download: function (e) {
if (
MetacatUI.appUserModel.get("loggedIn") &&
!this.model.get("isPublic")
) {
if (e) {
e.preventDefault();
var packageId =
$(e.target).attr("data-id") || this.model.get("resourceMap");
} else var packageId = this.model.get("resourceMap");
var fileName = this.model.get("fileName") || this.model.get("title");
// Download the entire package if there is one
if (packageId) {
// If there is more than one resource map, download all of them
if (Array.isArray(packageId)) {
for (var i = 0; i < packageId.length; i++) {
var pkgFileName = fileName || "Dataset_" + (i + 1);
//Take off the file extension part of the file name
if (pkgFileName.lastIndexOf(".") > 0)
pkgFileName = pkgFileName.substring(
0,
pkgFileName.lastIndexOf(".")
);
var packageModel = new Package({
id: packageId[i],
fileName: pkgFileName + ".zip",
});
packageModel.downloadWithCredentials();
}
} else {
// Take off the file extension part of the file name
if (fileName.lastIndexOf(".") > 0)
fileName = fileName.substring(0, fileName.lastIndexOf("."));
// Create a model to represent the package
var packageModel = new Package({
id: packageId,
fileName: fileName + ".zip",
});
packageModel.downloadWithCredentials();
}
}
// Otherwise just download this solo object
else {
this.model.downloadWithCredentials();
}
} else return true;
},
/**
* Create ContextObjects in Spans (COinS) for the item. COinS is a method
* to embed bibliographic metadata in the HTML code of web pages. This
* allows bibliographic software to publish machine-readable bibliographic
* items and client reference management software to retrieve
* bibliographic metadata. (from wikipedia)
* @returns {HTMLSpanElement} - The span element containing the COinS data
*/
getOpenURLCOinS: function () {
try {
// Create the OpenURL COinS
var spanTitle =
"ctx_ver=Z39.88-2004&rft_val_fmt=info:ofi/fmt:kev:mtx:dc&rfr_id=info:sid/ocoins.info:generator&rft.type=Dataset";
if (this.model.get("title"))
spanTitle += "&rft.title=" + this.model.get("title");
if (this.model.get("origin"))
spanTitle += "&rft.creator=" + this.model.get("origin");
if (this.model.get("keywords"))
spanTitle += "&rft.subject=" + this.model.get("keywords");
if (this.model.get("abstract"))
spanTitle += "&rft.description=" + this.model.get("abstract");
if (this.model.get("datasource"))
spanTitle += "&rft.publisher=" + this.model.get("datasource");
if (this.model.get("endDate"))
spanTitle += "&rft.date=" + this.model.get("endDate");
if (this.model.get("formatID"))
spanTitle += "&rft.format=" + this.model.get("formatID");
if (this.model.get("id"))
spanTitle += "&rft.identifier=" + this.model.get("id");
if (this.model.get("url"))
spanTitle += "&rft.source=" + this.model.get("url");
if (this.model.get("northBoundCoord")) {
spanTitle +=
"&rft.coverage=POLYGON((" +
this.model.get("southBoundCoord") +
" " +
this.model.get("westBoundCoord") +
", " +
this.model.get("northBoundCoord") +
" " +
this.model.get("westBoundCoord") +
", " +
this.model.get("northBoundCoord") +
" " +
this.model.get("eastBoundCoord") +
", " +
this.model.get("southBoundCoord") +
" " +
this.model.get("eastBoundCoord") +
"))";
}
spanTitle = encodeURI(spanTitle);
return $(document.createElement("span"))
.attr("title", spanTitle)
.addClass("Z3988");
} catch (e) {
console.log("Error creating COinS: " + e);
return $(document.createElement("span"));
}
},
/**
* Show the loading view
*/
loading: function () {
this.$el.html(this.loadingTemplate);
},
/**
* Remove the item, destroy the model from *localStorage* and delete its
* view.
*/
clear: function () {
this.model.destroy();
},
/**
* Functions to perform when the view is closed
*/
onClose: function () {
this.clear();
},
}
);
});