blob: f807b19c1636e0ab806c70247c47a54f951b0205 [file] [log] [blame]
// Copyright (C) 2012 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.google.gerrit.sshd;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.server.DynamicOptions;
import com.google.gerrit.server.plugins.Plugin;
import com.google.gerrit.server.plugins.ReloadPluginListener;
import com.google.gerrit.server.plugins.StartPluginListener;
import com.google.inject.Inject;
import com.google.inject.Key;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.google.inject.TypeLiteral;
import com.google.inject.internal.MoreTypes;
import java.util.ArrayList;
import java.util.List;
import org.apache.sshd.server.command.Command;
@Singleton
class SshPluginStarterCallback implements StartPluginListener, ReloadPluginListener {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
private final DispatchCommandProvider root;
private final DynamicMap<DynamicOptions.DynamicBean> dynamicBeans;
@Inject
SshPluginStarterCallback(
@CommandName(Commands.ROOT) DispatchCommandProvider root,
DynamicMap<DynamicOptions.DynamicBean> dynamicBeans) {
this.root = root;
this.dynamicBeans = dynamicBeans;
}
@Override
public void onStartPlugin(Plugin plugin) {
Provider<Command> cmd = load(plugin);
if (cmd != null) {
plugin.add(root.register(Commands.named(plugin.getName()), cmd));
}
}
@Override
public void onReloadPlugin(Plugin oldPlugin, Plugin newPlugin) {
Provider<Command> cmd = load(newPlugin);
if (cmd != null) {
newPlugin.add(root.replace(Commands.named(newPlugin.getName()), cmd));
}
}
@Nullable
private Provider<Command> load(Plugin plugin) {
if (plugin.getSshInjector() != null) {
Key<Command> key = Commands.key(plugin.getName());
try {
return plugin.getSshInjector().getProvider(key);
} catch (RuntimeException err) {
if (!providesDynamicOptions(plugin) && !providesCommandInterceptor(plugin)) {
logger.atWarning().withCause(err).log(
"Plugin %s did not define its top-level command, any DynamicOptions, nor any Ssh*CommandInterceptors",
plugin.getName());
}
}
}
return null;
}
private boolean providesDynamicOptions(Plugin plugin) {
return dynamicBeans.plugins().contains(plugin.getName());
}
private boolean providesCommandInterceptor(Plugin plugin) {
List<TypeLiteral<?>> typeLiterals = new ArrayList<>(2);
typeLiterals.add(
MoreTypes.canonicalizeForKey(
(TypeLiteral<?>) TypeLiteral.get(SshExecuteCommandInterceptor.class)));
typeLiterals.add(
MoreTypes.canonicalizeForKey(
(TypeLiteral<?>) TypeLiteral.get(SshCreateCommandInterceptor.class)));
return plugin.getSshInjector().getAllBindings().keySet().stream()
.anyMatch(key -> typeLiterals.contains(key.getTypeLiteral()));
}
}