src/main/java/com/google/gerrit/server/ssh/SshKeyCacheImpl.java

// Copyright (C) 2009 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.server.ssh;

import com.google.gerrit.client.reviewdb.Account;
import com.google.gerrit.client.reviewdb.AccountSshKey;
import com.google.gerrit.client.reviewdb.ReviewDb;
import com.google.gerrit.server.cache.Cache;
import com.google.gerrit.server.cache.CacheModule;
import com.google.gerrit.server.cache.SelfPopulatingCache;
import com.google.gwtorm.client.OrmException;
import com.google.gwtorm.client.SchemaFactory;
import com.google.inject.Inject;
import com.google.inject.Module;
import com.google.inject.Singleton;
import com.google.inject.TypeLiteral;
import com.google.inject.name.Named;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/** Provides the {@link SshKeyCacheEntry}. */
@Singleton
public class SshKeyCacheImpl implements SshKeyCache {
  private static final Logger log = LoggerFactory.getLogger(SshKeyCacheImpl.class);
  private static final String CACHE_NAME = "sshkeys";

  public static Module module() {
    return new CacheModule() {
      @Override
      protected void configure() {
        final TypeLiteral<Cache<String, Iterable<SshKeyCacheEntry>>> type =
            new TypeLiteral<Cache<String, Iterable<SshKeyCacheEntry>>>() {};
        core(type, CACHE_NAME);
        bind(SshKeyCacheImpl.class);
        bind(SshKeyCache.class).to(SshKeyCacheImpl.class);
      }
    };
  }

  private final SchemaFactory<ReviewDb> schema;
  private final SelfPopulatingCache<String, Iterable<SshKeyCacheEntry>> self;

  @Inject
  SshKeyCacheImpl(final SchemaFactory<ReviewDb> schema,
      @Named(CACHE_NAME) final Cache<String, Iterable<SshKeyCacheEntry>> raw) {
    this.schema = schema;
    self = new SelfPopulatingCache<String, Iterable<SshKeyCacheEntry>>(raw) {
      @Override
      protected Iterable<SshKeyCacheEntry> createEntry(final String username)
          throws Exception {
        return lookup(username);
      }

      @Override
      protected Iterable<SshKeyCacheEntry> missing(final String username) {
        return Collections.emptyList();
      }
    };
  }

  public Iterable<SshKeyCacheEntry> get(String username) {
    return self.get(username);
  }

  public void evict(String username) {
    self.remove(username);
  }

  private Iterable<SshKeyCacheEntry> lookup(final String username)
      throws Exception {
    final ReviewDb db = schema.open();
    try {
      final Account user = db.accounts().bySshUserName(username);
      if (user == null) {
        return Collections.<SshKeyCacheEntry> emptyList();
      }

      final List<SshKeyCacheEntry> kl = new ArrayList<SshKeyCacheEntry>(4);
      for (final AccountSshKey k : db.accountSshKeys().valid(user.getId())) {
        add(db, kl, k);
      }
      if (kl.isEmpty()) {
        return Collections.<SshKeyCacheEntry> emptyList();
      }
      return Collections.unmodifiableList(kl);
    } finally {
      db.close();
    }
  }

  private void add(ReviewDb db, List<SshKeyCacheEntry> kl, AccountSshKey k) {
    try {
      kl.add(new SshKeyCacheEntry(k.getKey(), SshUtil.parse(k)));
    } catch (OutOfMemoryError e) {
      // This is the only case where we assume the problem has nothing
      // to do with the key object, and instead we must abort this load.
      //
      throw e;
    } catch (Throwable e) {
      markInvalid(db, k);
    }
  }

  private void markInvalid(final ReviewDb db, final AccountSshKey k) {
    try {
      log.info("Flagging SSH key " + k.getKey() + " invalid");
      k.setInvalid();
      db.accountSshKeys().update(Collections.singleton(k));
    } catch (OrmException e) {
      log.error("Failed to mark SSH key" + k.getKey() + " invalid", e);
    }
  }
}