src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginProvider.java

// Copyright (C) 2014 The Android Open Source Project
//
// 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 com.googlesource.gerrit.plugins.scripting.groovyprovider;

import com.google.common.collect.Sets;
import com.google.common.io.Files;
import com.google.gerrit.extensions.annotations.Listen;
import com.google.gerrit.extensions.annotations.PluginName;
import com.google.gerrit.server.plugins.InvalidPluginException;
import com.google.gerrit.server.plugins.ServerPlugin;
import com.google.gerrit.server.plugins.ServerPluginProvider;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.nio.file.Path;
import java.util.Set;
import org.eclipse.jgit.internal.storage.file.FileSnapshot;

/**
 * Groovy scripting plugins.
 *
 * <p>Allows to define a Groovy class to implement any type of Gerrit plugin.
 *
 * <p>Example of Groovy SSH Plugin (hello-1.0.groovy):
 * ------------------------------------------------ import com.google.gerrit.sshd.SshCommand import
 * com.google.gerrit.extensions.annotations.Export @Export("groovy") class GroovyCommand extends
 * SshCommand { public void run() { stdout.println("Hello Gerrit from Groovy !") }
 *
 * <p>The above example add a "hello groovy" command to Gerrit SSH interface that displays "Hello
 * Gerrit from Groovy !".
 */
@Listen
class GroovyPluginProvider implements ServerPluginProvider {
  private static final Set<String> GROOVY_EXTENSIONS =
      Sets.newHashSet("groovy", "gvy", "gy", "gsh");

  private final Provider<GroovyPluginScriptEngine> scriptEngineProvider;
  private final String providerPluginName;

  @Inject
  public GroovyPluginProvider(
      Provider<GroovyPluginScriptEngine> scriptEngineProvider,
      @PluginName String providerPluginName) {
    this.scriptEngineProvider = scriptEngineProvider;
    this.providerPluginName = providerPluginName;
  }

  @Override
  public ServerPlugin get(Path srcFile, FileSnapshot snapshot, PluginDescription description)
      throws InvalidPluginException {
    GroovyPluginScriptEngine scriptEngine = scriptEngineProvider.get();
    return new ServerPlugin(
        getPluginName(srcFile),
        description.canonicalUrl,
        description.user,
        srcFile,
        snapshot,
        new GroovyPluginScanner(getPluginName(srcFile), scriptEngine, srcFile),
        description.dataDir,
        scriptEngine.getGroovyClassLoader());
  }

  @Override
  public boolean handles(Path srcFile) {
    String scriptExtension = Files.getFileExtension(srcFile.toString()).toLowerCase();
    return GROOVY_EXTENSIONS.contains(scriptExtension);
  }

  @Override
  public String getPluginName(Path srcFile) {
    String srcFileName = srcFile.getFileName().toString();
    int dashPos = srcFileName.lastIndexOf('-');
    int dotPos = srcFileName.lastIndexOf('.');
    return srcFileName.substring(0, dashPos > 0 ? dashPos : dotPos);
  }

  @Override
  public String getProviderPluginName() {
    return providerPluginName;
  }
}