openaire-library/searchPages/searchUtils/searchPage.component.ts

681 lines
25 KiB
TypeScript

import {Component, Input} from '@angular/core';
import {ViewChild, Output} from '@angular/core';
import { Location} from '@angular/common';
import {Router, ActivatedRoute} from '@angular/router';
import {Title, Meta} from '@angular/platform-browser';
import {Filter, Value} from './searchHelperClasses.class';
import {SearchFields} from '../../utils/properties/searchFields';
import {SearchCustomFilter, SearchUtilsClass} from './searchUtils.class';
import {DOI, StringUtils} from '../../utils/string-utils.class';
import {RouterHelper} from '../../utils/routerHelper.class';
import {ModalLoading} from '../../utils/modal/loading.component';
import {ErrorCodes} from '../../utils/properties/errorCodes';
import {PiwikService} from '../../utils/piwik/piwik.service';
import {EnvProperties} from '../../utils/properties/env-properties';
import { SEOService } from '../../sharedComponents/SEO/SEO.service';
import {HelperFunctions} from "../../utils/HelperFunctions.class";
import {ZenodoInformationClass} from "../../deposit/utils/zenodoInformation.class";
import {HelperService} from "../../utils/helper/helper.service";
@Component({
selector: 'search-page',
templateUrl: 'searchPage.component.html'
})
export class SearchPageComponent {
@Input() piwikSiteId = null;
@Input() pageTitle = "";
@Input() formPlaceholderText = "Type Keywords...";
@Input() results = [];
@Input() filters = [];
@Input() type:string = "";
@Input() entityType: string = "";
@Input() usedBy: string = "search";
@Input() showMoreFilterValuesInline: boolean = false;
@Input() filterValuesNum: number = 5;
@Input() public zenodoInformation: ZenodoInformationClass = new ZenodoInformationClass();
@Input() searchUtils:SearchUtilsClass = new SearchUtilsClass();
@Input() baseUrl:string = '';
@Input() showResultCount:boolean = true;
@Input() showRefine:boolean = true;
@Input() refineFields = [];
@Input() csvParams: string;
@Input() csvPath: string;
@Input() advancedSearchLink: string = "";
@Input() advancedSearchParameters;
@Input() tableViewLink: string;
@Input() disableForms: boolean = false;
@Input() loadPaging: boolean = true;
@Input() oldTotalResults: number = 0;
@Input() tableView: boolean = false;
@Input() searchFormClass: string = "searchForm";
@Input() openaireLink: string;
@Input() customFilter:SearchCustomFilter= null;
@Input() sort: boolean = false;
@Input() mapUrl: string = "";
@Input() mapTooltipType: string ="content providers";
@Input() newQueryButton: boolean = true;
@Input() lastIndex: boolean = true;
@Input() hasPrefix: boolean = true;
@Input() showType = false;
//@Input() sortBy: string = "";
@ViewChild (ModalLoading) loading : ModalLoading ;
public fieldIdsMap;//: { [key:string]:{ name:string, operator:string, type:string, indexField:string, equalityOperator:string }};
@Input() keywordFields = [];
private searchFieldsHelper:SearchFields = new SearchFields();
private queryParameters: Map<string, string> = new Map<string,string>();
private baseURLWithParameters:string = '';
private sub: any; piwiksub: any;
// public countFilters= 0;
public parameterNames:string[] =[];
public parameterValues:string[] =[];
public showUnknownFilters:boolean = false; // when a filter exists in query but has no results, so no filters returned from the query
//@ViewChild (SearchFilterModalComponent) searchFilterModal : SearchFilterModalComponent ;
// public currentFilter: Filter;
public csvLimit: number = 0;
public pagingLimit: number = 0;
public resultsPerPage: number = 10;
public isPiwikEnabled;
public pageContents = null;
public divContents = null;
properties:EnvProperties;
public routerHelper:RouterHelper = new RouterHelper();
public errorCodes:ErrorCodes = new ErrorCodes();
constructor (private route: ActivatedRoute,
private location: Location,
private _meta: Meta,
private _title: Title,
private _piwikService:PiwikService,
private router: Router,
private seoService: SEOService,
private helper: HelperService) {
}
ngOnInit() {
this.route.data
.subscribe((data: { envSpecific: EnvProperties }) => {
this.properties = data.envSpecific;
//this.getDivContents();
this.getPageContents();
this.pagingLimit = data.envSpecific.pagingLimit;
HelperFunctions.scroll();
this.csvLimit = data.envSpecific.csvLimit;
this.isPiwikEnabled = data.envSpecific.enablePiwikTrack;
if(typeof window !== 'undefined') {
this.updateUrl(data.envSpecific.baseLink+location.pathname);
}
if(typeof document !== 'undefined' && this.isPiwikEnabled){
this.piwiksub = this._piwikService.trackView(this.properties, this.pageTitle, this.piwikSiteId).subscribe();
}
});
// this.updateBaseUrlWithParameters(this.filters);
this.updateTitle(this.pageTitle);
var description = "Openaire, search, repositories, open access, type, content provider, funder, project, " + this.type + "," +this.pageTitle;
this.updateDescription(description);
this.seoService.createLinkForCanonicalURL(this.properties.baseLink+this.router.url,false);
}
private getPageContents() {
this.helper.getPageHelpContents(this.properties, (this.customFilter)?this.customFilter.valueId:null, this.router.url).subscribe(contents => {
this.pageContents = contents;
})
}
private getDivContents() {
this.helper.getDivHelpContents(this.properties, (this.customFilter)?this.customFilter.valueId:null, this.router.url).subscribe(contents => {
this.divContents = contents;
})
}
ngOnDestroy() {
if(this.piwiksub){
this.piwiksub.unsubscribe();
}
}
updateDescription(description:string) {
this._meta.updateTag({content:description},"name='description'");
this._meta.updateTag({content:description},"property='og:description'");
}
updateTitle(title:string) {
let _title: string;
if(this.hasPrefix && !this.customFilter) {
let _prefix ="OpenAIRE | ";
_title = _prefix + ((title.length > 50) ? title.substring(0, 50) : title);
} else {
_title = ((title.length > 50) ? title.substring(0, 50) : title);
}
this._title.setTitle(_title);
this._meta.updateTag({content:_title},"property='og:title'");
}
updateUrl(url:string) {
this._meta.updateTag({content:url},"property='og:url'");
}
public getQueryParamsFromUrl(params) {
this.queryParameters = new Map<string,string>();
for(let i=0; i< this.refineFields.length ; i++) {
let filterId = this.refineFields[i];
if (params[filterId] != undefined) {
this.queryParameters.set(filterId, StringUtils.URIDecode(params[filterId]));
}
}
return this.queryParameters;
}
/**
* Create Search API query based on the page URL parameters
* @param params page URL parameters
*/
public getQueryParametersFromUrl(params){ // called by ngOnInit function of search find pages
// var parameters = "";
var allFqs = "";
this.queryParameters = new Map<string,string>();
for(var i=0; i< this.refineFields.length ; i++){
var filterId = this.refineFields[i];
if(params[filterId] != undefined) {
this.queryParameters.set(filterId, StringUtils.URIDecode(params[filterId]));
let values = (StringUtils.URIDecode(this.queryParameters.get(filterId))).split(/,(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)/,-1);
var countvalues = 0;
var fq = "";
let filterOp: string = this.searchFieldsHelper.getFieldOperator(filterId);
console.info(filterId, filterOp);
for(let value of values) {
countvalues++;
var paramId = this.fieldIdsMap[filterId].param;
// parameters+='&' + paramId+ '='+ value;//+"&" + this.fieldIdsMap[paramId].operator + "="+((countvalues == 1)?"and":"or");
fq+=(fq.length > 0 ? " " + filterOp + " ":"" ) + filterId +" exact " +(value);
}
if(countvalues > 0){
fq="&fq="+StringUtils.URIEncode(fq);
}
allFqs += fq;
}
}
if(this.customFilter){
allFqs+= "&fq="+StringUtils.URIEncode(this.customFilter.queryFieldName + " exact " + StringUtils.quote((this.customFilter.valueId )));
}
var keyword = params['keyword'];
var doiQuery = "";
var keywordQuery = "";
if((keyword && keyword.length > 0)){
if((this.type == 'publications' ||this.type == 'research data' || this.type == 'software' || this.type == 'other research products')){
var DOIs:string[] = DOI.getDOIsFromString(keyword);
var doisParams = "";
for(var i =0 ;i < DOIs.length; i++){
doisParams+=(doisParams.length > 0?"&":"")+'doi="'+ DOIs[i]+'"';
}
if(doisParams.length > 0){
doiQuery += "&"+doisParams;
}else {
keywordQuery += "&q="+StringUtils.URIEncode(keyword);
}
}else{
if(this.usedBy == "deposit") {
if(this.keywordFields.length > 0) {
keywordQuery = "&fq=";
}
for(let i=0; i< this.keywordFields.length ; i++) {
if(i > 0) {
keywordQuery += " or ";
}
let field = this.keywordFields[i];
//keywordQuery += field.name+field.equalityOperator+StringUtils.URIEncode(keyword);
keywordQuery += field.name+field.equalityOperator+StringUtils.quote(StringUtils.URIEncode(keyword));
}
} else {
keywordQuery += "&q=" + StringUtils.URIEncode(keyword);
}
}
}
return (doiQuery.length > 0 ? doiQuery:keywordQuery) + allFqs;
}
public getIndexQueryParametersFromUrl(params){ // called by ngOnInit function of search pages that request 'resources'
// var parameters = "";
var allFqs = "";
for(var i=0; i< this.refineFields.length ; i++){
var filterId = this.refineFields[i];
var fq = "";
if(params[filterId] != undefined) {
this.queryParameters.set(filterId,decodeURIComponent(params[filterId]));
let values = (decodeURIComponent(this.queryParameters.get(filterId))).split(/,(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)/,-1);
var countvalues = 0;
let filterOp: string = this.searchFieldsHelper.getFieldOperator(filterId);
console.info(filterId, filterOp);
for(let value of values) {
countvalues++;
// parameters+= ((countvalues == 1)?" and (":" or ")+ filterId+ '='+ value;
fq+=(fq.length > 0 ? " " + filterOp + " ":"" ) + filterId + " exact " + value;//StringUtils.quote(value);
}
// parameters+= " ) ";
if(countvalues > 0){
fq="&fq="+StringUtils.URIEncode(fq);
}
allFqs += fq;
}
}
var keyword = params['keyword'];
var doiQuery = "";
var keywordQuery = "";
if((keyword && keyword.length > 0)){
if((this.type == 'publications' ||this.type == 'research data' || this.type == 'software' || this.type == 'other research products')){
var DOIs:string[] = DOI.getDOIsFromString(keyword);
var doisParams = "";
for(var i =0 ;i < DOIs.length; i++){
doisParams+=(doisParams.length > 0?"&":"")+'doi="'+ DOIs[i]+'"';
}
if(doisParams.length > 0){
doiQuery += "&"+doisParams;
}
}else{
keywordQuery += "and ("+StringUtils.quote(StringUtils.URIEncode(keyword)) +")";
}
}
return (doiQuery.length > 0 ? doiQuery:keywordQuery) + allFqs;
}
/*
* Mark as check the new filters that are selected, when you get them from search
*/
public checkSelectedFilters(filters:Filter[]){
this.filters = filters;
for(var i=0; i< filters.length ; i++){
var filter:Filter = filters[i];
filter.countSelectedValues = 0;
if(this.queryParameters.get(filter.filterId) != undefined) {
let values = (decodeURIComponent(this.queryParameters.get(filter.filterId))).split(/,(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)/,-1);
for(let filterValue of filter.values) {
if(values.indexOf(StringUtils.quote(filterValue.id)) > -1) {
filterValue.selected = true;
filter.countSelectedValues++;
}else{
filterValue.selected = false;
}
}
}else{
for(let filterValue of filter.values) {
filterValue.selected = false;
}
}
}
this.filterFilterValues(this.filters);
return filters;
}
/*
* For Funder filters - if funder selected
*/
public filterFilterValues(filters:Filter[]){
var funders = [];
var funder_prefix = [];
for(var i=0; i< filters.length ; i++){
var filter:Filter = filters[i];
// console.log(filter.filterId);
if(filter.filterId.indexOf("funder")!=-1 && this.queryParameters.get(filter.filterId) != undefined) {
let funders = (decodeURIComponent(this.queryParameters.get(filter.filterId))).split(/,(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)/,-1);
for(let funder of funders) {
funder_prefix.push(StringUtils.unquote(funder).split("____")[0]);
}
// console.log(funder_prefix );
}else if(filter.filterId.indexOf("funding")!=-1){
// console.log(" funding: "+filter.filterId );
var filteredValues = []
for(let filterValue of filter.values) {
var value_prefix = filterValue.id.split("____")[0];
// console.log("Value prefix: "+value_prefix );
if(funder_prefix.indexOf(value_prefix)!=-1){
// console.log("here" + value_prefix);
filteredValues.push(filterValue);
}
}
if(filteredValues.length > 0){
filter.values = filteredValues;
}
}
}
return filters;
}
/*
* Update the url with proper parameters. This is used as base url in Paging Component
*/
public updateBaseUrlWithParameters(filters:Filter[]){
this.baseURLWithParameters = this.baseUrl + this.createUrlParameters(filters,false);
}
/**
* Get The filters and create page URL parameters
* @param filters
* @param includePage
*/
private createUrlParameters(filters:Filter[], includePage:boolean){
var allLimits="";//location.search.slice(1);
this.queryParameters = new Map<string,string>();
this.parameterNames.splice(0,this.parameterNames.length);
this.parameterValues.splice(0,this.parameterValues.length);
for (let filter of filters){
var filterLimits="";
if(filter.countSelectedValues > 0 ){
for (let value of filter.values){
if(value.selected == true){
filterLimits+=((filterLimits.length == 0)?'':',') +'"'+ (value.id)+'"';
}
}
this.queryParameters.set(filter.filterId,filterLimits);
if(filterLimits.length > 0){
this.parameterNames.push(filter.filterId);
this.parameterValues.push(filterLimits);
}
allLimits+=(allLimits.length==0?"?":"&")+((filterLimits.length == 0 )?'':filter.filterId + '='+ filterLimits) ;
}
}
if(this.searchUtils.keyword.length > 0 ){
allLimits+=(allLimits.length==0?"?":"&")+'keyword=' + this.searchUtils.keyword;
this.parameterNames.push("keyword");
this.parameterValues.push(this.searchUtils.keyword);
//this.parameterValues.push(StringUtils.quote(this.searchUtils.keyword));
}
if(this.searchUtils.page != 1 && includePage){
allLimits+=((allLimits.length == 0)?'?':'&') + 'page=' + this.searchUtils.page;
}
if(this.searchUtils.size != this.resultsPerPage) {
allLimits+=((allLimits.length == 0)?'?':'&') + 'size=' + this.searchUtils.size;
this.parameterNames.push("size");
this.parameterValues.push(""+this.searchUtils.size);
}
if(this.sort && this.searchUtils.sortBy) {
allLimits+=((allLimits.length == 0)?'?':'&') + 'sortBy=' + this.searchUtils.sortBy;
this.parameterNames.push("sortBy");
this.parameterValues.push(this.searchUtils.sortBy);
} /*else {
let index: number = this.parameterNames.findIndex(function(element) {
return element == "sortBy";
});
console.info("index of sortby: "+index);
if(index >= 0) {
console.info("------remove sortBy------");
this.parameterNames.splice(index, 1);
this.parameterValues.splice(index, 1);
}
}*/
return allLimits;
}
/*
*
*/
private createSearchQueryParameters(filters:Filter[]){ // called by goTo, result emited to and used by search find pages
var allFqs = "";
for (let filter of filters){
if(filter.countSelectedValues > 0 ){
var fq = "";
var count_selected=0;
for (let value of filter.values){
if(value.selected == true){
count_selected++;
fq+=(fq.length > 0 ? " " + filter.filterOperator + " ":"" ) + filter.filterId + " exact " + StringUtils.quote((value.id));
}
}
fq="&fq="+StringUtils.URIEncode(fq);
allFqs += fq;
}
}
var doiQuery = "";
var keywordQuery = "";
if((this.searchUtils.keyword && this.searchUtils.keyword.length > 0)){
if((this.type == 'publications' ||this.type == 'research data' || this.type == 'software' || this.type == 'other research products')){
var DOIs:string[] = DOI.getDOIsFromString(this.searchUtils.keyword);
var doisParams = "";
for(var i =0 ;i < DOIs.length; i++){
doisParams+=(doisParams.length > 0?"&":"")+'doi="'+ DOIs[i]+'"';
}
if(doisParams.length > 0){
doiQuery += "&"+doisParams;
}else{
keywordQuery += "&q="+StringUtils.URIEncode(this.searchUtils.keyword);
}
}else{
if(this.usedBy == "deposit") {
if(this.keywordFields.length > 0) {
keywordQuery = "&fq=";
}
for(let i=0; i< this.keywordFields.length ; i++) {
if(i > 0) {
keywordQuery += " or ";
}
let field = this.keywordFields[i];
//keywordQuery += field.name+field.equalityOperator+StringUtils.URIEncode(this.searchUtils.keyword);
keywordQuery += field.name+field.equalityOperator+StringUtils.quote(StringUtils.URIEncode(this.searchUtils.keyword));
}
} else {
keywordQuery += "&q=" + StringUtils.URIEncode(this.searchUtils.keyword);
}
}
}
return (doiQuery.length > 0 ? doiQuery:keywordQuery) + allFqs;
}
private createIndexQueryParameters(filters:Filter[]){ // called by goTo, result emited to and used by search pages that request 'resources'
var allFqs = "";
for (let filter of filters){
if(filter.countSelectedValues > 0){
var count_selected=0;
var fq = "";
for (let value of filter.values){
if(value.selected == true){
count_selected++;
fq+=(fq.length > 0 ? " " + filter.filterOperator + " ":"" ) + filter.filterId + " exact " + (StringUtils.quote(value.id));
}
}
if(count_selected > 0){
fq="&fq="+StringUtils.URIEncode(fq);
allFqs += fq;
}
}
}
var doiQuery = "";
var keywordQuery = "";
if((this.searchUtils.keyword && this.searchUtils.keyword.length > 0)){
if((this.type == 'publications' ||this.type == 'research data' || this.type == 'software' || this.type == 'other research products')){
var DOIs:string[] = DOI.getDOIsFromString(this.searchUtils.keyword);
var doisParams = "";
for(var i =0 ;i < DOIs.length; i++){
doisParams+=(doisParams.length > 0?"&":"")+'doi="'+ DOIs[i]+'"';
}
if(doisParams.length > 0){
doiQuery += "&"+doisParams;
}
}else{
keywordQuery += " and ("+StringUtils.quote(StringUtils.URIEncode(this.searchUtils.keyword)) +")"
}
}
return (doiQuery.length > 0 ? doiQuery:keywordQuery) + allFqs;
}
public countFilters():number{
var filters=0;
this.showUnknownFilters = false;
for (let filter of this.filters){
if(filter.countSelectedValues > 0){
filters+=filter.countSelectedValues;
}
}
if(this.searchUtils.keyword.length > 0 ){
filters++;
}
var errorCodes:ErrorCodes = new ErrorCodes();
if(this.queryParameters.keys() && this.searchUtils.totalResults == 0 && this.searchUtils.status !=errorCodes.LOADING ){
if(this.newQueryButton) {
this.showUnknownFilters = true;
}
}
return filters;
}
private clearKeywords(){
if(this.searchUtils.keyword.length > 0 ){
this.searchUtils.keyword ='';
}
this.goTo(1);
}
private clearFilters(){
for (var i =0 ; i < this.filters.length; i++){
for (var j=0; j < this.filters[i].countSelectedValues; j++){
if(this.filters[i].values[j].selected){
this.filters[i].values[j].selected = false;
}
this.filters[i].countSelectedValues = 0;
}
}
this.clearKeywords();
}
private removeFilter(value:Value,filter:Filter){
filter.countSelectedValues--;
if(value.selected == true){
value.selected = false;
}
this.goTo(1);
}
goTo(page:number = 1){
this.searchUtils.page = page;
this.createUrlParameters(this.filters,true);
this.router.navigate( [this.baseUrl], { queryParams: this.routerHelper.createQueryParams(this.parameterNames, this.parameterValues) } );
/* Code For Piwik*/
if (typeof localStorage !== 'undefined') {
localStorage.setItem('previousRoute', this.router.url);
}
if(this.isPiwikEnabled && (typeof document !== 'undefined')){
this.piwiksub = this._piwikService.trackView(this.properties, this.pageTitle, this.piwikSiteId).subscribe();
}
HelperFunctions.scroll();
}
filterChanged($event){
this.goTo(1);
}
keywordChanged($event) {
this.searchUtils.keyword = $event.value;
this.goTo(1);
}
sizeChanged($event) {
this.searchUtils.size = $event.value;
this.goTo(1);
}
sortByChanged($event) {
this.searchUtils.sortBy = $event.value;
this.goTo(1);
}
/*
* Get A sub-array of this.refineFields array, which contains the ids of the selected filters
*/
public getSelectedFilters():string[] {
var selected:string[] = [];
for(var i=0; i < this.filters.length; i++){
var filter:Filter = this.filters[i];
if(filter.countSelectedValues > 0){
selected.push(filter.filterId);
}
}
return selected;
}
/*
* Get A sub-array of this.refineFields array, which contains the ids of the selected parameters
*/
private getSelectedParameters():string[] {
var selected:string[] = [];
var params:string[] = Object.keys(this.queryParameters);
for(var i=0; i < this.refineFields.length; i++){
if(this.queryParameters.get(this.refineFields[i])!= undefined ){
selected.push(this.refineFields[i]);
}
}
return selected;
}
/*
* Get A sub-array of this.refineFields array, which hides hidden fields (e.g Funding level 0,1,2,..), and contains those that depend on another fields (e.g Funding level 0 if Funder is selected )
*/
public getFields():string[] {
var selected_filters:string[] = this.getSelectedFilters();
if(selected_filters.length == 0){
selected_filters = this.getSelectedParameters();
}
var fields:string[] = [];
for(var i =0 ; i < this.refineFields.length;i++){
var dependentTo = this.searchFieldsHelper.DEPENDENT_FIELDS[this.refineFields[i]];
//if filter is not marked as hidden OR it is hidden but it is dependent to a field that it IS selected
if(this.searchFieldsHelper.HIDDEN_FIELDS.indexOf(this.refineFields[i]) == -1 || (selected_filters.indexOf(dependentTo) != -1) || (selected_filters.indexOf(this.refineFields[i]) != -1) ){
fields.push(this.refineFields[i]);
}
}
return fields;
}
/*
* Get a query string of all fields, that want to get from search (e.g. &fields=funderid&fields=projectstartyear&...))
*/
public getRefineFieldsQuery():string{
var fields:string[] = this.getFields();
var fieldsStr = ""
for(var i =0 ; i < fields.length ;i++){
fieldsStr+="&fields="+fields[i];
}
return "&refine=true"+fieldsStr;
}
// for loading
public openLoading(){
if(this.loading){
this.loading.open();
}
}
public closeLoading(){
if(this.loading){
this.loading.close();
}
}
getSelectedValues(filter):any{
var selected = [];
if(filter.countSelectedValues >0){
for (var i=0; i < filter.values.length; i++){
if(filter.values[i].selected){
selected.push(filter.values[i]);
}
}
}
return selected;
}
}