Skip to content

Support alternative data licenses #398

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.

Sign up for GitHub

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

Open
jonathanlindahl wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Support alternative data licenses #398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1b16a00
added ccbync4 license and adjusted license pdf and table of contents
jonathanlindahl Oct 24, 2025
9a5b294
fixed error that caused the new license to not get filtered out
jonathanlindahl Oct 28, 2025
c2ad4d6
simplified some validation as per pr suggestion
jonathanlindahl Oct 28, 2025
a7d85e7
licencesToAccept explicitly checks for ccby4
jonathanlindahl Oct 29, 2025
77753e3
cleaned up string comparison
jonathanlindahl Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/main/scala/se/lu/nateko/cp/data/api/MetaVocab.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,5 @@ object SitesMetaVocab extends MetaVocab(new URI("https://meta.fieldsites.se/onto

object CcMetaVocab extends MetaVocab(new URI("https://creativecommons.org/")){
val cc0 = getRelative("publicdomain/zero/1.0/")
val ccbync4 = getRelative("licenses/by-nc/4.0/")
}
49 changes: 31 additions & 18 deletions src/main/scala/se/lu/nateko/cp/data/services/upload/DownloadService.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,19 @@ class DownloadService(coreConf: MetaCoreConfig, val upload: UploadService, val r
}
}

def licencesToAccept(hashes: Seq[Sha256Sum], uidOpt: Option[UserId])(using Envri): Future[Seq[URI]] = {
upload.meta.listLicences(hashes).flatMap{allLic =>
val toAccept: Seq[URI] = allLic.distinct.filterNot(publicDomainLicences.contains)
Future.sequence(
toAccept.map{lic =>
checkLicenceAcceptance(lic, uidOpt).map(lic -> _)
def licencesToAccept(hashes: Seq[Sha256Sum], uidOpt: Option[UserId])(using envri: Envri): Future[Seq[URI]] = {
mainLicences.get(envri)
.map { mainLicence =>
upload.meta.listLicences(hashes).flatMap { allLicences =>
if (allLicences.contains(mainLicence)) {
checkLicenceAcceptance(mainLicence, uidOpt).map { accepted =>
if (accepted) Seq.empty else Seq(mainLicence)
}
} else {
Future.successful(Seq.empty)
}
}
).map{
_.collect{case (lic, false) => lic}
}
}
}.getOrElse(Future.successful(Seq.empty))
}

def inaccessibilityReason(dobj: StaticObject)(using Envri): Option[String] =
Expand All @@ -128,11 +130,21 @@ class DownloadService(coreConf: MetaCoreConfig, val upload: UploadService, val r

private def destinyToAuxSourcesFlow(implicit envri: Envri): Flow[FileDestiny, FileEntry, NotUsed] = Flow.apply[FileDestiny]
.fold(Vector.empty[FileDestiny])(_ :+ _)
.map{dests =>
ZipEntry("!TOC.csv") -> destiniesToTocFileSource(dests)
}.concat(Source.single(
ZipEntry("!LICENCE.pdf") -> licenceSource
))
.flatMapConcat{dests =>
val baseSource = Source.single(ZipEntry("!TOC.csv") -> destiniesToTocFileSource(dests))

val shouldIncludeLincensePdf = mainLicences.get(envri).exists { expectedUri =>
dests.exists { d =>
d.obj.references.licence.exists(_.url == expectedUri)
}
}

if (shouldIncludeLincensePdf) {
baseSource.concat(Source.single(ZipEntry("!LICENCE.pdf") -> licenceSource))
} else {
baseSource
}
}

private def singleObjectSource(obj: StaticObject, downloadLogger: DataObject => Unit): Source[ByteString, NotUsed] = {
val file = upload.getFile(obj, true)
Expand All @@ -150,7 +162,7 @@ class DownloadService(coreConf: MetaCoreConfig, val upload: UploadService, val r
}

private def destiniesToTocFileSource(dests: immutable.Seq[FileDestiny])(using Envri): Source[ByteString, NotUsed] = {
val lines = "Included,File name,PID,Landing page,Omission reason (if any)\n" +: dests.map{dest =>
val lines = "Included,File name,PID,Landing page,License,Omission reason (if any)\n" +: dests.map{dest =>

val presense = if(dest.omissionReason.isEmpty) "Yes" else "No"
val omissionReason = dest.omissionReason.getOrElse("")
Expand All @@ -163,7 +175,8 @@ class DownloadService(coreConf: MetaCoreConfig, val upload: UploadService, val r
val hdlProxy = if(dest.obj.doi.isDefined) prox.doi else prox.basic
s"$hdlProxy$pid"
}
s"$presense,${dest.fileName},${pidOpt.getOrElse("")},$landingPage,$omissionReason\n"
val license = dest.obj.references.licence.fold("")(_.name)
s"$presense,${dest.fileName},${pidOpt.getOrElse("")},$landingPage,$license,$omissionReason\n"
}
Source(lines.map(ByteString.apply))
}
Expand Down Expand Up @@ -227,7 +240,7 @@ private object ZeroDestiny extends Destiny{

object DownloadService:

val publicDomainLicences = Set(CcMetaVocab.cc0)
val publicDomainLicences = Set(CcMetaVocab.cc0, CcMetaVocab.ccbync4)
Copy link
Copy Markdown
Contributor

@jonathanthiry jonathanthiry Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better to only show the license acceptance screen for the CC BY 4.0 license right now. It can be that we need to a check for the NC license, but that would require us to change the acceptance page.


val mainLicences: Map[Envri, URI] = Map(
Envri.ICOS -> CpMetaVocab.ccby4,
Expand Down