ValueObjectsADM.scala

package org.knora.webapi.messages.admin.responder.valueObjects

import org.knora.webapi.LanguageCodes
import org.knora.webapi.exceptions.{AssertionException, BadRequestException}
import org.knora.webapi.messages.StringFormatter
import org.knora.webapi.messages.store.triplestoremessages.StringLiteralV2
import zio.prelude.Validation

import scala.util.matching.Regex

// TODO: this is so far shared value object file, consider to slice it

/** User value objects */

/**
 * User Username value object.
 */
sealed abstract case class Username private (value: String)
object Username {

  /**
   * A regex that matches a valid username
   * - 4 - 50 characters long
   * - Only contains alphanumeric characters, underscore and dot.
   * - Underscore and dot can't be at the end or start of a username
   * - Underscore or dot can't be used multiple times in a row
   */
  private val UsernameRegex: Regex =
    """^(?=.{4,50}$)(?![_.])(?!.*[_.]{2})[a-zA-Z0-9._]+(?<![_.])$""".r

  def create(value: String): Either[Throwable, Username] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing username"))
    } else {
      UsernameRegex.findFirstIn(value) match {
        case Some(value) =>
          Right(new Username(value) {})
        case None => Left(BadRequestException("Invalid username"))
      }
    }
}

/**
 * User Email value object.
 */
sealed abstract case class Email private (value: String)
object Email {
  private val EmailRegex: Regex = """^.+@.+$""".r // TODO use proper validation

  def create(value: String): Either[Throwable, Email] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing email"))
    } else {
      EmailRegex.findFirstIn(value) match {
        case Some(value) => Right(new Email(value) {})
        case None        => Left(BadRequestException("Invalid email"))
      }
    }
}

/**
 * User Password value object.
 */
sealed abstract case class Password private (value: String)
object Password {
  private val PasswordRegex: Regex = """^[\s\S]*$""".r //TODO: add password validation

  def create(value: String): Either[Throwable, Password] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing password"))
    } else {
      PasswordRegex.findFirstIn(value) match {
        case Some(value) => Right(new Password(value) {})
        case None        => Left(BadRequestException("Invalid password"))
      }
    }
}

/**
 * User GivenName value object.
 */
sealed abstract case class GivenName private (value: String)
object GivenName {
  // TODO use proper validation for value
  def create(value: String): Either[Throwable, GivenName] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing given name"))
    } else {
      Right(new GivenName(value) {})
    }
}

/**
 * User FamilyName value object.
 */
sealed abstract case class FamilyName private (value: String)
object FamilyName {
  // TODO use proper validation for value
  def create(value: String): Either[Throwable, FamilyName] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing family name"))
    } else {
      Right(new FamilyName(value) {})
    }
}

/**
 * User LanguageCode value object.
 */
sealed abstract case class LanguageCode private (value: String)
object LanguageCode {
  def create(value: String): Either[Throwable, LanguageCode] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing language code"))
    } else if (!LanguageCodes.SupportedLanguageCodes.contains(value)) {
      Left(BadRequestException("Invalid language code"))
    } else {
      Right(new LanguageCode(value) {})
    }
}

/**
 * User SystemAdmin value object.
 */
sealed abstract case class SystemAdmin private (value: Boolean)
object SystemAdmin {
  def create(value: Boolean): Either[Throwable, SystemAdmin] =
    Right(new SystemAdmin(value) {})
}

/** Project value objects */

/**
 * Project Shortcode value object.
 */
sealed abstract case class Shortcode private (value: String)
object Shortcode {
  val stringFormatter = StringFormatter.getGeneralInstance

  def make(value: String): Validation[Throwable, Shortcode] =
    if (value.isEmpty) {
      Validation.fail(BadRequestException("Missing shortcode"))
    } else {
      val validatedValue: Validation[Throwable, String] = Validation(
        stringFormatter.validateProjectShortcode(value, throw AssertionException("not valid"))
      )
      validatedValue.map(new Shortcode(_) {})
    }
}

/**
 * Project Shortname value object.
 */
sealed abstract case class Shortname private (value: String)
object Shortname {
  val stringFormatter = StringFormatter.getGeneralInstance

  def make(value: String): Validation[Throwable, Shortname] =
    if (value.isEmpty) {
      Validation.fail(BadRequestException("Missing shortname"))
    } else {
      val validatedValue = Validation(
        stringFormatter.validateAndEscapeProjectShortname(value, throw AssertionException("not valid"))
      )
      validatedValue.map(new Shortname(_) {})
    }
}

/**
 * Project Longname value object.
 */
sealed abstract case class Longname private (value: String)
object Longname { self =>
  def make(value: String): Validation[Throwable, Longname] =
    if (value.isEmpty) {
      Validation.fail(BadRequestException("Missing long name"))
    } else {
      Validation.succeed(new Longname(value) {})
    }
  def make(value: Option[String]): Validation[Throwable, Option[Longname]] =
    value match {
      case None    => Validation.succeed(None)
      case Some(v) => self.make(v).map(Some(_))
    }
}

/**
 * Project Keywords value object.
 */
sealed abstract case class Keywords private (value: Seq[String])
object Keywords {
  def make(value: Seq[String]): Validation[Throwable, Keywords] =
    if (value.isEmpty) {
      Validation.fail(BadRequestException("Missing keywords"))
    } else {
      Validation.succeed(new Keywords(value) {})
    }
}

/**
 * Project Logo value object.
 */
sealed abstract case class Logo private (value: String)
object Logo { self =>
  def make(value: String): Validation[Throwable, Logo] =
    if (value.isEmpty) {
      Validation.fail(BadRequestException("Missing logo"))
    } else {
      Validation.succeed(new Logo(value) {})
    }
  def make(value: Option[String]): Validation[Throwable, Option[Logo]] =
    value match {
      case None    => Validation.succeed(None)
      case Some(v) => self.make(v).map(Some(_))
    }
}

/** Groups value objects */

/**
 * Group Name value object.
 */
sealed abstract case class Name private (value: String)
object Name {
  def create(value: String): Either[Throwable, Name] =
    if (value.isEmpty) {
      Left(BadRequestException("Missing Name"))
    } else {
      Right(new Name(value) {})
    }
}

/** Shared value objects */

/**
 * Selfjoin value object.
 */
sealed abstract case class Selfjoin private (value: Boolean)
object Selfjoin {
  def make(value: Boolean): Validation[Throwable, Selfjoin] =
    Validation.succeed(new Selfjoin(value) {})
}

/**
 * Status value object.
 */
sealed abstract case class Status private (value: Boolean)
object Status {
  def make(value: Boolean): Validation[Throwable, Status] =
    Validation.succeed(new Status(value) {})
}

/**
 * Description value object.
 */
sealed abstract case class Description private (value: Seq[StringLiteralV2])
object Description {
  def make(value: Seq[StringLiteralV2]): Validation[Throwable, Description] =
    if (value.isEmpty) {
      Validation.fail(BadRequestException("Missing description"))
    } else {
      Validation.succeed(new Description(value) {})
    }
}