Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
one.irradia.opds1_2.nypl.OPDS12AvailabilityInference.kt Maven / Gradle / Ivy
package one.irradia.opds1_2.nypl
import one.irradia.opds1_2.api.OPDS12Acquisition
import one.irradia.opds1_2.api.OPDS12AcquisitionRelation.ACQUISITION_BORROW
import one.irradia.opds1_2.api.OPDS12AcquisitionRelation.ACQUISITION_BUY
import one.irradia.opds1_2.api.OPDS12AcquisitionRelation.ACQUISITION_GENERIC
import one.irradia.opds1_2.api.OPDS12AcquisitionRelation.ACQUISITION_OPEN_ACCESS
import one.irradia.opds1_2.api.OPDS12AcquisitionRelation.ACQUISITION_SAMPLE
import one.irradia.opds1_2.api.OPDS12AcquisitionRelation.ACQUISITION_SUBSCRIBE
import one.irradia.opds1_2.api.OPDS12FeedParseConfiguration
import one.irradia.opds1_2.api.OPDS12Identifiers.OPDS_URI
import one.irradia.opds1_2.commons.OPDS12XMLProcessor
import org.w3c.dom.Element
/**
* Functions to infer the availability of OPDS elements.
*
* @see "https://github.com/NYPL-Simplified/Simplified/wiki/OPDS-For-Library-Patrons"
*/
object OPDS12AvailabilityInference {
private fun mightBeHoldable(
xmlProcessor: OPDS12XMLProcessor,
configuration: OPDS12FeedParseConfiguration,
copies: Element?,
acquisition: OPDS12Acquisition): OPDS12Availability {
return if (copies != null) {
val copiesAvailable =
xmlProcessor.optionalAttributeInt(
element = copies,
name = "available",
allowInvalid = configuration.allowInvalidIntegers) ?: 0
if (copiesAvailable > 0)
OPDS12Availability.Loanable(acquisition)
else
OPDS12Availability.Holdable(acquisition)
} else
OPDS12Availability.Loanable(acquisition)
}
/**
* Determine the availability of the given element.
*/
fun availabilityOf(
element: Element,
configuration: OPDS12FeedParseConfiguration,
xmlProcessor: OPDS12XMLProcessor,
acquisition: OPDS12Acquisition): OPDS12Availability {
val availability =
xmlProcessor.firstChildElementWithName(element, OPDS_URI, "availability")
val holds =
xmlProcessor.firstChildElementWithName(element, OPDS_URI, "holds")
val copies =
xmlProcessor.firstChildElementWithName(element, OPDS_URI, "copies")
/*
* If there is no availability element, then the availability determination
* has to be made purely upon the acquisition relation.
*/
return if (availability == null) {
withoutAvailability(acquisition, configuration, xmlProcessor, copies)
} else {
withAvailability(holds, configuration, xmlProcessor, availability, acquisition, copies)
}
}
private fun withAvailability(
holds: Element?,
configuration: OPDS12FeedParseConfiguration,
xmlProcessor: OPDS12XMLProcessor,
availability: Element,
acquisition: OPDS12Acquisition,
copies: Element?
): OPDS12Availability {
val position =
holds?.let {
xmlProcessor.optionalAttributeInt(
element = holds,
name = "position",
allowInvalid = configuration.allowInvalidIntegers)
}
val startDate =
xmlProcessor.optionalAttributeInstant(
element = availability,
name = "since",
allowInvalid = configuration.allowInvalidTimestamps)
val endDate =
xmlProcessor.optionalAttributeInstant(
element = availability,
name = "until",
allowInvalid = configuration.allowInvalidTimestamps)
/*
* If there is availability information, the book might be loanable, loaned,
* or holdable.
*/
val status = xmlProcessor.requireAttribute(availability, "status")
return when (status) {
"unavailable" ->
OPDS12Availability.Holdable(acquisition)
"available" ->
when (acquisition.relation) {
ACQUISITION_OPEN_ACCESS ->
OPDS12Availability.OpenAccess(acquisition)
ACQUISITION_SUBSCRIBE,
ACQUISITION_SAMPLE,
ACQUISITION_BUY,
ACQUISITION_BORROW ->
OPDS12Availability.Loanable(acquisition)
ACQUISITION_GENERIC ->
OPDS12Availability.Loaned(
acquisition = acquisition,
startDate = startDate,
endDate = endDate,
revokeURI = null)
}
"reserved" ->
OPDS12Availability.Held(
acquisition = acquisition,
position = position,
startDate = startDate,
endDate = endDate,
revokeURI = null)
"ready" ->
OPDS12Availability.HeldReady(
acquisition = acquisition,
endDate = endDate,
revokeURI = null)
else ->
mightBeHoldable(
xmlProcessor = xmlProcessor,
configuration = configuration,
copies = copies,
acquisition = acquisition)
}
}
private fun withoutAvailability(
acquisition: OPDS12Acquisition,
configuration: OPDS12FeedParseConfiguration,
xmlProcessor: OPDS12XMLProcessor,
copies: Element?): OPDS12Availability {
return when (acquisition.relation) {
ACQUISITION_BORROW ->
mightBeHoldable(xmlProcessor, configuration, copies, acquisition)
ACQUISITION_BUY ->
OPDS12Availability.Loanable(acquisition)
ACQUISITION_GENERIC ->
OPDS12Availability.Loaned(
acquisition = acquisition,
startDate = null,
endDate = null,
revokeURI = null)
ACQUISITION_OPEN_ACCESS ->
OPDS12Availability.OpenAccess(acquisition)
ACQUISITION_SAMPLE ->
OPDS12Availability.Loanable(acquisition)
ACQUISITION_SUBSCRIBE ->
OPDS12Availability.Loanable(acquisition)
}
}
}
