29395622307

Committed 15 Jul 2026 06:54AM UTC coverage: 30.168% (+0.8%) from 29.361%

Build # 29395622307

Build Type

Pull #559

github

Committed by

web-flow

Commit Message

Merge f07c8a0b6 into 809bff55b

Pull Request Pull Request #559: feat: language-tag picker for literal placeholders

Coverage Stats

2086 of 7605 branches covered (27.43%)

Branch coverage included in aggregate %.

4020 of 12635 relevant lines covered (31.82%)

4.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

45.41

src/main/java/com/knowledgepixels/nanodash/component/ReadonlyItem.java

package com.knowledgepixels.nanodash.component;

import com.knowledgepixels.nanodash.LocalUri;
import com.knowledgepixels.nanodash.NavigationContext;
import com.knowledgepixels.nanodash.RestrictedChoice;
import com.knowledgepixels.nanodash.domain.User;
import com.knowledgepixels.nanodash.Utils;
import com.knowledgepixels.nanodash.component.StatementItem.RepetitionGroup;
import com.knowledgepixels.nanodash.domain.IndividualAgent;
import com.knowledgepixels.nanodash.domain.MaintainedResource;
import com.knowledgepixels.nanodash.domain.Space;
import com.knowledgepixels.nanodash.page.ExplorePage;
import com.knowledgepixels.nanodash.repository.MaintainedResourceRepository;
import com.knowledgepixels.nanodash.repository.SpaceRepository;
import com.knowledgepixels.nanodash.template.ContextType;
import com.knowledgepixels.nanodash.template.Template;
import com.knowledgepixels.nanodash.template.UnificationException;
import net.trustyuri.TrustyUriUtils;
import org.apache.commons.codec.Charsets;
import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.link.ExternalLink;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.validation.IValidatable;
import org.apache.wicket.validation.IValidator;
import org.apache.wicket.validation.Validatable;
import org.apache.wicket.validation.ValidationError;
import org.eclipse.rdf4j.common.net.ParsedIRI;
import org.eclipse.rdf4j.model.IRI;
import org.eclipse.rdf4j.model.Literal;
import org.eclipse.rdf4j.model.Value;
import org.eclipse.rdf4j.model.ValueFactory;
import org.eclipse.rdf4j.model.impl.SimpleValueFactory;
import org.eclipse.rdf4j.model.util.Literals;
import org.eclipse.rdf4j.model.vocabulary.XSD;
import org.nanopub.Nanopub;
import org.nanopub.NanopubUtils;
import org.nanopub.SimpleCreatorPattern;
import org.nanopub.vocabulary.NTEMPLATE;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.net.URISyntaxException;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * ReadonlyItem is a component that displays a read-only item in the form.
 */
public class ReadonlyItem extends AbstractContextComponent {

    private static final int LONG_LITERAL_LENGTH = 100;
    private static final Logger logger = LoggerFactory.getLogger(ReadonlyItem.class);
    private static final ValueFactory vf = SimpleValueFactory.getInstance();

    private IModel<String> model;
    private String prefix;
    private ExternalLink linkComp;
    private Label extraComp, languageComp, datatypeComp;
    private IModel<String> extraModel, languageModel, datatypeModel;
    private IRI iri;
    private RestrictedChoice restrictedChoice;
    private Label showMoreLabelLiteral, showMoreLabelHTML;
    private final Template template;

    /**
     * Constructor for ReadonlyItem.
     *
     * @param id              the component id
     * @param parentId        the parent id (e.g., "subj", "obj")
     * @param iriP            the IRI of the item
     * @param statementPartId the statement part ID
     * @param rg              the repetition group
     */
    public ReadonlyItem(String id, String parentId, final IRI iriP, IRI statementPartId, final RepetitionGroup rg) {
        super(id, rg.getContext());
        this.iri = iriP;
        template = context.getTemplate();
        model = (IModel<String>) context.getComponentModels().get(iri);
        boolean modelIsNew = false;
        if (model == null) {
            model = Model.of("");
            context.getComponentModels().put(iri, model);
            modelIsNew = true;
        }
        String postfix = Utils.getUriPostfix(iri);
        if (modelIsNew && context.hasParam(postfix)) {
            model.setObject(context.getParam(postfix));
        }
        if (model.getObject().isEmpty() && template.isRootNanopubPlaceholder(iri) && context.getReferenceNanopub() == null) {
            model.setObject(LocalUri.of("nanopub").stringValue());
        }

        final Map<String, String> foafNameMap;
        if (context.getExistingNanopub() == null) {
            foafNameMap = new HashMap<>();
        } else {
            foafNameMap = Utils.getFoafNameMap(context.getExistingNanopub());
        }

        prefix = template.getPrefix(iri);
        if (prefix == null) prefix = "";
        if (template.isRestrictedChoicePlaceholder(iri)) {
            restrictedChoice = new RestrictedChoice(iri, context);
        }
        add(new Label("prefix", new Model<String>() {

            @Override
            public String getObject() {
                String prefixLabel = template.getPrefixLabel(iri);
                String v = getFullValue();
                if (prefixLabel == null || IndividualAgent.isUser(v) || foafNameMap.containsKey(v)) {
                    return "";
                } else if (prefixLabel.matches("https?://.*")) {
                    // Hide prefix label that leaks through as a raw URL.
                    return "";
                } else {
                    if (!prefixLabel.isEmpty() && parentId.equals("subj")) {
                        // Capitalize first letter of label if at subject position:
                        prefixLabel = prefixLabel.substring(0, 1).toUpperCase() + prefixLabel.substring(1);
                    }
                    return prefixLabel;
                }
            }

        }));

        linkComp = new ExternalLink("link", new Model<String>() {

            @Override
            public String getObject() {
                String obj = getFullValue();
                if (obj == null) return "";
                if (obj.equals(LocalUri.of("nanopub").stringValue())) {
                    if (context.getExistingNanopub() != null) {
                        obj = context.getExistingNanopub().getUri().stringValue();
                        return ExplorePage.MOUNT_PATH + "?id=" + URLEncoder.encode(obj, Charsets.UTF_8);
                    } else {
                        return "";
                    }
                } else if (obj.equals(LocalUri.of("assertion").stringValue())) {
                    if (context.getExistingNanopub() != null) {
                        obj = context.getExistingNanopub().getAssertionUri().stringValue();
                        return ExplorePage.MOUNT_PATH + "?id=" + URLEncoder.encode(obj, Charsets.UTF_8);
                    } else {
                        return "";
                    }
                } else if (obj.matches("https?://.+")) {
                    return NanodashLink.getPageUrl(obj);
                } else {
                    return "";
                }
            }

        }, new Model<String>() {

            @Override
            public String getObject() {
                String obj = getFullValue();
                if (rootResolvesToThisNanopub()) {
                    // No prior value migrated (e.g. supersede with a newer template that added this slot),
                    // or we are deriving. Either way the root resolves to the new nanopub in
                    // TemplateContext.processValue, so surface that to the user in the form.
                    return "this nanopublication";
                }
                if (obj != null && obj.equals(LocalUri.of("nanopub").stringValue())) {
                    return "this nanopublication";
                }
                if (obj != null && obj.equals(LocalUri.of("assertion").stringValue())) {
                    return context.getType() == ContextType.ASSERTION ? "this assertion" : "the assertion above";
                }
                if (obj != null && obj.matches("https?://.+")) {
                    IRI objIri = vf.createIRI(obj);
                    if (iri.equals(NTEMPLATE.CREATOR_PLACEHOLDER)) {
                        // TODO We might want to introduce a "(you)" flag here at some point
                        return User.getShortDisplayName(objIri);
                    } else if (isAssertionValue(objIri)) {
                        if (context.getType() == ContextType.ASSERTION) {
                            return "this assertion";
                        } else {
                            return "the assertion above";
                        }
                    } else if (isNanopubValue(objIri)) {
                        return "this nanopublication";
                    } else if (IndividualAgent.isUser(obj)) {
                        return User.getShortDisplayName(objIri);
                    } else if (foafNameMap.containsKey(obj)) {
                        return foafNameMap.get(obj);
                    }
                    Space space = SpaceRepository.get().findById(obj);
                    if (space != null) return Utils.truncateLinkLabel(space.getLabel());
                    space = SpaceRepository.get().findByAltId(obj);
                    if (space != null) return Utils.truncateLinkLabel(space.getLabel());
                    MaintainedResource mr = MaintainedResourceRepository.get().findById(obj);
                    if (mr != null) return Utils.truncateLinkLabel(mr.getLabel());
                    return Utils.truncateLinkLabel(getLabelString(objIri));
                }
                return obj;
            }

        });
        if (template.isIntroducedResource(iri) || template.isEmbeddedResource(iri)) {
            linkComp.add(AttributeAppender.append("class", "introduced"));
        }
        linkComp.add(NavigationContext.hrefContextFallback());
        add(linkComp);
        add(new Label("description", new Model<String>() {

            @Override
            public String getObject() {
                String obj = getFullValue();
                if (rootResolvesToThisNanopub()) {
                    return "This is the identifier for this whole nanopublication.";
                }
                if (obj != null && obj.matches("https?://.+")) {
                    IRI objIri = vf.createIRI(obj);
                    if (isAssertionValue(objIri)) {
                        return "This is the identifier for the assertion of this nanopublication.";
                    } else if (isNanopubValue(objIri)) {
                        return "This is the identifier for this whole nanopublication.";
                    } else if (context.isReadOnly() && obj.startsWith(context.getExistingNanopub().getUri().stringValue())) {
                        return "This is a local identifier minted within the nanopublication.";
                    }
                    String labelString = getLabelString(objIri);
                    String description = "";
                    if (labelString.contains(" - ")) description = labelString.replaceFirst("^.* - ", "");
                    return description;
                } else if (obj != null && obj.startsWith("\"")) {
                    return "(this is a literal)";
                }
                return "";
            }

        }));
        Model<String> uriModel = new Model<String>() {

            @Override
            public String getObject() {
                String obj = getFullValue();
                if (rootResolvesToThisNanopub()) {
                    return LocalUri.of("nanopub").stringValue();
                }
                if (obj != null && obj.startsWith("\"")) return "";
                if (isAssertionValue(obj)) {
                    return getAssertionValue();
                } else if (isNanopubValue(obj)) {
                    return getNanopubValue();
                }
                return obj;
            }

        };
        add(Utils.getUriLink("uri", uriModel));
        extraModel = Model.of("");
        extraComp = new Label("extra", extraModel);
        extraComp.setVisible(false);
        add(extraComp);
        languageModel = Model.of("");
        languageComp = new Label("language", languageModel);
        languageComp.setVisible(false);
        add(languageComp);
        datatypeModel = Model.of("");
        datatypeComp = new Label("datatype", datatypeModel);
        datatypeComp.setVisible(false);
        add(datatypeComp);

        showMoreLabelLiteral = new Label("show-more-literal", "");
        add(showMoreLabelLiteral);
        showMoreLabelLiteral.setVisible(false);

        showMoreLabelHTML = new Label("show-more-html", "");
        add(showMoreLabelHTML);
        showMoreLabelHTML.setVisible(false);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void fillFinished() {
        String obj = getFullValue();
        if (obj != null) {
            if (isAssertionValue(obj)) {
                linkComp.add(new AttributeAppender("class", "this-assertion"));
            } else if (isNanopubValue(obj)) {
                linkComp.add(new AttributeAppender("class", "this-nanopub"));
            } else if (context.getExistingNanopub() != null) {
                Nanopub np = context.getExistingNanopub();
                if (NanopubUtils.getIntroducedIriIds(np).contains(obj) || NanopubUtils.getEmbeddedIriIds(np).contains(obj)) {
                    linkComp.add(AttributeAppender.append("class", "introduced"));
                }
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void finalizeValues() {
    }

    private String getLabelString(IRI iri) {
        if (template.getLabel(iri) != null) {
            return template.getLabel(iri).replaceFirst(" - .*$", "");
        } else if (context.getLabel(iri) != null) {
            return context.getLabel(iri).replaceFirst(" - .*$", "");
        } else {
            return Utils.getShortNameFromURI(iri.stringValue());
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void removeFromContext() {
        // Nothing to be done here.
    }

    private String getFullValue() {
        String s = model.getObject();
        if (s == null) return null;
        if (template.isAutoEscapePlaceholder(iri)) {
            s = Utils.urlEncode(s);
        }
        if (!prefix.isEmpty()) {
            s = prefix + s;
        }
        return s;
    }

    // True when the root-nanopub placeholder will resolve to the new nanopub itself:
    // either no prior root value was migrated, or we are deriving (which resets the root
    // to the new nanopub, see TemplateContext.processValue / issue #527).
    private boolean rootResolvesToThisNanopub() {
        if (!template.isRootNanopubPlaceholder(iri)) return false;
        String obj = getFullValue();
        return obj == null || obj.isEmpty() || context.getFillMode() == PublishForm.FillMode.DERIVE;
    }

    private boolean isNanopubValue(Object obj) {
        if (obj == null) return false;
        if (obj.toString().equals(LocalUri.of("nanopub").stringValue())) return true;
        // A fillSource match means a *prior* nanopub (supersede/derive), not "this" one — don't label it as such.
        if (context.getExistingNanopub() == null) return false;
        return obj.toString().equals(context.getExistingNanopub().getUri().stringValue());
    }

    private String getNanopubValue() {
        Nanopub ref = context.getReferenceNanopub();
        if (ref != null) {
            return ref.getUri().stringValue();
        } else {
            return LocalUri.of("nanopub").stringValue();
        }
    }

    private boolean isAssertionValue(Object obj) {
        if (obj == null) return false;
        if (obj.toString().equals(LocalUri.of("assertion").stringValue())) return true;
        // A fillSource match means a *prior* assertion (supersede/derive), not "this" one.
        if (context.getExistingNanopub() == null) return false;
        return obj.toString().equals(context.getExistingNanopub().getAssertionUri().stringValue());
    }

    private String getAssertionValue() {
        Nanopub ref = context.getReferenceNanopub();
        if (ref != null) {
            return ref.getAssertionUri().stringValue();
        } else {
            return LocalUri.of("assertion").stringValue();
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isUnifiableWith(Value v) {
        if (v == null) return true;
        if (v instanceof IRI) {
            String vs = v.stringValue();
            if (vs.equals(LocalUri.of("nanopub").stringValue())) {
                vs = getNanopubValue();
            } else if (vs.equals(LocalUri.of("assertion").stringValue())) {
                vs = getAssertionValue();
            }
            if (vs.startsWith(prefix)) vs = vs.substring(prefix.length());
//                        if (Utils.isLocalURI(vs)) vs = vs.replaceFirst("^" + LocalUri.PREFIX, "");
            if (template.isAutoEscapePlaceholder(iri)) {
                vs = Utils.urlDecode(vs);
            }
            Validatable<String> validatable = new Validatable<>(vs);
//                        if (template.isLocalResource(iri) && !Utils.isUriPostfix(vs)) {
//                                vs = Utils.getUriPostfix(vs);
//                        }
            new Validator().validate(validatable);
            if (!validatable.isValid()) {
                return false;
            }
            if (model.getObject().isEmpty()) {
                return true;
            }
            return vs.equals(model.getObject());
        } else if (v instanceof Literal vL) {
            if (template.getRegex(iri) != null && !v.stringValue().matches(template.getRegex(iri))) {
                return false;
            }
            String languagetag = template.getLanguageTag(iri);
            IRI datatype = template.getDatatype(iri);
            if (template.isLanguageTagSelectable(iri)) {
                // Any tag from the allowed set unifies (any tag at all if unrestricted);
                // a declared nt:hasLanguageTag is only the picker's default.
                if (vL.getLanguage().isEmpty()) {
                    return false;
                }
                List<String> possibleTags = template.getPossibleLanguageTags(iri);
                if (possibleTags != null && !possibleTags.contains(Literals.normalizeLanguageTag(vL.getLanguage().get()))) {
                    return false;
                }
            } else if (languagetag != null) {
                if (vL.getLanguage().isEmpty() || !Literals.normalizeLanguageTag(vL.getLanguage().get()).equals(languagetag)) {
                    return false;
                }
            } else if (datatype != null) {
                if (!vL.getDatatype().equals(datatype)) {
                    return false;
                }
            }
            if (linkComp.getDefaultModelObject() == null || linkComp.getDefaultModelObject().toString().isEmpty()) {
                return true;
            }
            return linkComp.getDefaultModelObject().equals("\"" + v.stringValue() + "\"");
        }
        return false;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void unifyWith(Value v) throws UnificationException {
        if (v == null) return;
        String vs = v.stringValue();
        if (!isUnifiableWith(v)) {
            logger.error("Cannot unify {}", v);
            throw new UnificationException(vs);
        }
        if (v instanceof IRI) {
            if (vs.equals(LocalUri.of("nanopub").stringValue())) {
                vs = getNanopubValue();
            } else if (vs.equals(LocalUri.of("assertion").stringValue())) {
                vs = getAssertionValue();
            }
            if (!prefix.isEmpty() && vs.startsWith(prefix)) {
                vs = vs.substring(prefix.length());
                // With read-only items, we don't need preliminary local identifiers:
//                        } else if (Utils.isLocalURI(vs)) {
//                                vs = vs.replaceFirst("^" + LocalUri.PREFIX, "");
//                        } else if (template.isLocalResource(iri) && !Utils.isUriPostfix(vs)) {
//                                vs = Utils.getUriPostfix(vs);
            }
            if (template.isAutoEscapePlaceholder(iri)) {
                vs = Utils.urlDecode(vs);
            }
            model.setObject(vs);
        } else if (v instanceof Literal vL) {
            if (vs.length() >= LONG_LITERAL_LENGTH) {
                linkComp.add(AttributeAppender.append("class", "long-literal collapsed"));
                showMoreLabelLiteral.setVisible(true);
            }
            if (vL.getLanguage().isPresent()) {
                model.setObject("\"" + vs + "\"");
                languageModel.setObject("(" + Literals.normalizeLanguageTag(vL.getLanguage().get()) + ")");
                languageComp.setVisible(true);
            } else if (!vL.getDatatype().equals(XSD.STRING)) {
                model.setObject("\"" + vs + "\"");
                datatypeModel.setObject("(" + vL.getDatatype().stringValue().replace(XSD.NAMESPACE, "xsd:") + ")");
                datatypeComp.setVisible(true);
            } else {
                model.setObject("\"" + vs + "\"");
            }
            if (Utils.looksLikeHtml(vs)) {
                linkComp.setVisible(false);
                extraModel.setObject(Utils.sanitizeHtml(vs));
                extraComp.setEscapeModelStrings(false);
                extraComp.setVisible(true);
                showMoreLabelLiteral.setVisible(false);
                showMoreLabelHTML.setVisible(true);
            }
        }
    }

    /**
     * Validator class for validating the input.
     */
    protected class Validator extends InvalidityHighlighting implements IValidator<String> {

        /**
         * Default constructor for Validator.
         */
        public Validator() {
        }

        @Override
        public void validate(IValidatable<String> s) {
            String sv = s.getValue();
            String p = prefix;
            if (template.isAutoEscapePlaceholder(iri)) {
                sv = Utils.urlEncode(sv);
            }
            if (sv.matches("https?://.+")) {
                p = "";
            } else if (sv.contains(":")) {
                s.error(new ValidationError("Colon character is not allowed in postfix"));
            }
            String iriString = p + sv;
            if (iriString.matches("[^:# ]+")) {
                p = LocalUri.PREFIX;
                iriString = p + sv;
            }
            try {
                ParsedIRI piri = new ParsedIRI(iriString);
                if (!piri.isAbsolute()) {
                    s.error(new ValidationError("IRI not well-formed"));
                }
                if (p.isEmpty() && !Utils.isLocalURI(sv) && !sv.matches("https?://.+")) {
                    s.error(new ValidationError("Only http(s):// IRIs are allowed here"));
                }
            } catch (URISyntaxException ex) {
                s.error(new ValidationError("IRI not well-formed"));
            }
            String regex = template.getRegex(iri);
            if (regex != null) {
                if (!sv.matches(regex)) {
                    s.error(new ValidationError("Value '" + sv + "' doesn't match the pattern '" + regex + "'"));
                }
            }
            if (template.isRestrictedChoicePlaceholder(iri)) {
                if (!restrictedChoice.getPossibleValues().contains(iriString) && !restrictedChoice.hasPossibleRefValues()) {
                    // not checking the possible ref values can overgenerate, but normally works
                    s.error(new ValidationError("Invalid choice"));
                }
            }
            if (template.isExternalUriPlaceholder(iri)) {
                if (!iriString.matches("https?://.+")) {
                    s.error(new ValidationError("Not an external IRI"));
                }
            }
            if (template.isTrustyUriPlaceholder(iri)) {
                if (!TrustyUriUtils.isPotentialTrustyUri(iriString)) {
                    s.error(new ValidationError("Not a trusty URI"));
                }
            }
            if (iri.equals(NTEMPLATE.CREATOR_PLACEHOLDER) && context.getExistingNanopub() != null) {
                boolean found = false;
                for (IRI creator : SimpleCreatorPattern.getCreators(context.getExistingNanopub())) {
                    if (creator.stringValue().equals(iriString)) {
                        found = true;
                        break;
                    }
                }
                if (!found) {
                    s.error(new ValidationError("Not a creator of nanopub"));
                }
            }
        }

    }

    /**
     * <p>toString.</p>
     *
     * @return a {@link java.lang.String} object
     */
    public String toString() {
        return "[read-only IRI item: " + iri + "]";
    }

}

knowledgepixels / nanodash / 29395622307

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous