apoc.trigger.TriggerHandlerNewProcedures Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apoc-core Show documentation
Core package for Neo4j Procedures
There is a newer version: 5.24.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package apoc.trigger;

import static apoc.ApocConfig.APOC_TRIGGER_ENABLED;
import static apoc.ApocConfig.apocConfig;
import static apoc.trigger.TriggerInfo.fromNode;

import apoc.SystemLabels;
import apoc.SystemPropertyKeys;
import apoc.util.Util;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;
import org.apache.commons.lang3.tuple.Pair;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.ResourceIterator;
import org.neo4j.graphdb.Transaction;

public class TriggerHandlerNewProcedures {
    public static final String NOT_ENABLED_ERROR = "Triggers have not been enabled."
            + " Set 'apoc.trigger.enabled=true' in your apoc.conf file located in the $NEO4J_HOME/conf/ directory.";

    private static boolean isEnabled() {
        return apocConfig().getBoolean(APOC_TRIGGER_ENABLED);
    }

    public static void checkEnabled() {
        if (!isEnabled()) {
            throw new RuntimeException(NOT_ENABLED_ERROR);
        }
    }

    public static TriggerInfo install(
            String databaseName,
            String triggerName,
            String statement,
            Map selector,
            Map params,
            Transaction tx) {
        final TriggerInfo result;

        Node node = Util.mergeNode(
                tx,
                SystemLabels.ApocTrigger,
                null,
                Pair.of(SystemPropertyKeys.database.name(), databaseName),
                Pair.of(SystemPropertyKeys.name.name(), triggerName));

        node.setProperty(SystemPropertyKeys.statement.name(), statement);
        node.setProperty(SystemPropertyKeys.selector.name(), Util.toJson(selector));
        node.setProperty(SystemPropertyKeys.params.name(), Util.toJson(params));
        node.setProperty(SystemPropertyKeys.paused.name(), false);

        // we'll return current trigger info
        result = fromNode(node, true);

        setLastUpdate(databaseName, tx);

        return result;
    }

    public static TriggerInfo drop(String databaseName, String triggerName, Transaction tx) {
        final TriggerInfo[] previous = new TriggerInfo[1];

        getTriggerNodes(databaseName, tx, triggerName).forEachRemaining(node -> {
            previous[0] = fromNode(node, false);
            node.delete();
        });

        setLastUpdate(databaseName, tx);

        return previous[0];
    }

    public static TriggerInfo updatePaused(String databaseName, String name, boolean paused, Transaction tx) {
        final TriggerInfo[] result = new TriggerInfo[1];

        getTriggerNodes(databaseName, tx, name).forEachRemaining(node -> {
            node.setProperty(SystemPropertyKeys.paused.name(), paused);

            // we'll return previous trigger info
            result[0] = fromNode(node, true);
        });

        setLastUpdate(databaseName, tx);

        return result[0];
    }

    public static List dropAll(String databaseName, Transaction tx) {
        final List previous = new ArrayList<>();

        getTriggerNodes(databaseName, tx).forEachRemaining(node -> {
            // we'll return previous trigger info
            previous.add(fromNode(node, false));
            node.delete();
        });
        setLastUpdate(databaseName, tx);

        return previous;
    }

    public static Stream getTriggerNodesList(String databaseName, Transaction tx) {
        return getTriggerNodes(databaseName, tx).stream().map(trigger -> TriggerInfo.fromNode(trigger, true));
    }

    public static ResourceIterator getTriggerNodes(String databaseName, Transaction tx) {
        return getTriggerNodes(databaseName, tx, null);
    }

    public static ResourceIterator getTriggerNodes(String databaseName, Transaction tx, String name) {
        final SystemLabels label = SystemLabels.ApocTrigger;
        final String dbNameKey = SystemPropertyKeys.database.name();
        if (name == null) {
            return tx.findNodes(label, dbNameKey, databaseName);
        }
        return tx.findNodes(label, dbNameKey, databaseName, SystemPropertyKeys.name.name(), name);
    }

    public static void setLastUpdate(String databaseName, Transaction tx) {
        Node node = tx.findNode(SystemLabels.ApocTriggerMeta, SystemPropertyKeys.database.name(), databaseName);
        if (node == null) {
            node = tx.createNode(SystemLabels.ApocTriggerMeta);
            node.setProperty(SystemPropertyKeys.database.name(), databaseName);
        }
        final long value = System.currentTimeMillis();
        node.setProperty(SystemPropertyKeys.lastUpdated.name(), value);
    }
}