-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add representation of search results as Atom feeds #1275
Open
niklasl
wants to merge
3
commits into
develop
Choose a base branch
from
feature/change-feeds
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| package whelk.rest.api | ||
|
|
||
| import groovy.transform.CompileStatic | ||
| import static groovy.transform.TypeCheckingMode.SKIP | ||
|
|
||
| import groovy.xml.MarkupBuilder | ||
| import groovy.xml.StreamingMarkupBuilder | ||
|
|
||
| import whelk.JsonLd | ||
| import static whelk.JsonLd.ID_KEY | ||
| import static whelk.JsonLd.TYPE_KEY | ||
| import static whelk.JsonLd.REVERSE_KEY | ||
| import static whelk.JsonLd.asList | ||
|
|
||
| @CompileStatic | ||
| class SearchFeed { | ||
|
|
||
| static final String BULLET_SEP = " • " | ||
|
|
||
| JsonLd jsonld | ||
| List<String> locales | ||
|
|
||
| Set<String> skipKeys = [ID_KEY, REVERSE_KEY, 'meta', 'reverseLinks'] as Set | ||
| Set<String> skipDetails = skipKeys + ([TYPE_KEY, 'commentByLang'] as Set) | ||
|
|
||
| SearchFeed(JsonLd jsonld, List<String> locales) { | ||
| this.jsonld = jsonld | ||
| this.locales = locales | ||
| } | ||
|
|
||
| @CompileStatic(SKIP) | ||
| String represent(String feedId, Object searchResults) { | ||
| var lastMod = searchResults.items?[0]?.meta?.modified | ||
| var feedTitle = buildTitle(searchResults) | ||
| return new StreamingMarkupBuilder().bind { mb -> | ||
| feed(xmlns: 'http://www.w3.org/2005/Atom') { | ||
| title(feedTitle) | ||
| id(feedId) | ||
| link(rel: 'self', href: searchResults[ID_KEY]) | ||
| for (rel in ['next', 'prev', 'first', 'last']) { | ||
| def ref = searchResults[rel] | ||
| if (ref) { | ||
| link(rel: rel, href: ref[ID_KEY]) | ||
| } | ||
| } | ||
| if (lastMod) updated(lastMod) | ||
| for (item in searchResults.items) { | ||
| entry { | ||
| id(item[ID_KEY]) | ||
| link(rel: 'alternate', type: 'text/html', href: item[ID_KEY]) | ||
| updated(item.meta.modified) | ||
| title(toChipString(item)) | ||
| summary(type: 'xhtml') { | ||
| toEntryCard(mb, item) | ||
| } | ||
| content(href: item[ID_KEY]) | ||
| } | ||
| } | ||
| } | ||
| }.toString() | ||
| } | ||
|
|
||
| @CompileStatic(SKIP) | ||
| String buildTitle(Map searchResults) { | ||
| var title = getByLang((Map) searchResults['titleByLang']) | ||
| def params = searchResults.search?.mapping?.findResults { | ||
| if (it.value !instanceof Boolean) { | ||
| return toValueString(it.value ?: it.object, skipDetails) | ||
| } | ||
| } | ||
| if (params) { | ||
| return title + ': ' + params.join(' & ') | ||
| } else { | ||
| return title | ||
| } | ||
| } | ||
|
|
||
| @CompileStatic(SKIP) | ||
| void toEntryCard(mb, Map item) { | ||
| mb.div(xmlns: 'http://www.w3.org/1999/xhtml') { | ||
| asList(item.meta?.hasChangeNote).each { note -> | ||
| p { b(toChipString(note)) } | ||
| } | ||
| for (kv in item) { | ||
| div { | ||
| if (kv.key !in skipKeys) { | ||
| var label = getLabelFor(kv.key) | ||
| var values = getValues(kv.value, kv.key) | ||
| if (label && values) { | ||
| span(label + ": ") | ||
| span { | ||
| values.eachWithIndex { v, i -> | ||
| if (i > 0) { | ||
| span(", " + v) | ||
| } else { | ||
| span(v) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| String toChipString(Object item) { | ||
| if (item instanceof Map) { | ||
| def chip = jsonld.toChip(item) | ||
| return toValueString(chip) | ||
| } else if (item == null) { | ||
| return "" | ||
| } else { | ||
| return item.toString() | ||
| } | ||
| } | ||
|
|
||
| String toValueString( Object o, Set skipKeys=skipKeys) { | ||
| var sb = new StringBuilder() | ||
| buildValueString(sb, o, skipKeys) | ||
| return sb.toString() | ||
| } | ||
|
|
||
| void buildValueString(StringBuilder sb, Object o, Set skipKeys=skipKeys) { | ||
| if (o instanceof List) { | ||
| for (v in o) buildValueString(sb, v, skipKeys) | ||
| } else if (o instanceof Map) { | ||
| for (kv in o) { | ||
| if (kv.key !in skipKeys) { | ||
| buildValueString(sb, getValues(kv.value, (String) kv.key), skipKeys) | ||
| } | ||
| } | ||
| } else { | ||
| if (sb.size() > 0) sb.append(BULLET_SEP) | ||
| sb.append(o.toString()) | ||
| } | ||
| } | ||
|
|
||
| List<String> getValues(Object o, String viaKey) { | ||
| if (viaKey == TYPE_KEY || jsonld.isVocabTerm(viaKey)) { | ||
| return asList(o).collect { getLabelFor((String) it) } | ||
| } else if (jsonld.isLangContainer(jsonld.context[viaKey])) { | ||
| return (List<String>) asList(o).findResults { getByLang((Map) it) } | ||
| } else { | ||
| return (List<String>) asList(o).findResults { toChipString(it) ?: null } | ||
| } | ||
| } | ||
|
|
||
| String getLabelFor(String key) { | ||
| String lookup = key == TYPE_KEY ? 'rdf:type' : key | ||
| def term = jsonld.vocabIndex[lookup] | ||
| if (term instanceof Map) { | ||
| def byLang = term.get('labelByLang') | ||
| if (byLang instanceof Map) { | ||
| String s = getByLang(byLang) | ||
| if (s) { | ||
| return s[0].toUpperCase() + s.substring(1) | ||
| } | ||
| } | ||
| } | ||
| return key | ||
| } | ||
|
|
||
| String getByLang(Map byLang) { | ||
| for (lang in locales) { | ||
| if (lang in byLang) { | ||
| def o = byLang[lang] | ||
| if (o instanceof String) { | ||
| return o | ||
| } else if (o instanceof List && o.size() > 0) { | ||
| return o.get(0).toString() | ||
| } | ||
| } | ||
| } | ||
| for (value in byLang.values()) { | ||
| return value | ||
| } | ||
| return null | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.