src/main/java/com/google/devtools/build/lib/skyframe/BlacklistedPackagePrefixesFunction.java

// Copyright 2015 The Bazel Authors. All rights reserved.
//
// 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.devtools.build.lib.skyframe;

import com.google.common.collect.ImmutableSet;
import com.google.common.io.CharStreams;
import com.google.common.io.LineProcessor;
import com.google.devtools.build.lib.actions.FileValue;
import com.google.devtools.build.lib.actions.InconsistentFilesystemException;
import com.google.devtools.build.lib.pkgcache.PathPackageLocator;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.Root;
import com.google.devtools.build.lib.vfs.RootedPath;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyFunctionException;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import javax.annotation.Nullable;

/**
 * A function that returns the union of a set of hardcoded blacklisted package prefixes and the
 * contents of a hardcoded filepath whose contents is a blacklisted package prefix on each line.
 */
public class BlacklistedPackagePrefixesFunction implements SkyFunction {
  private ImmutableSet<PathFragment> hardcodedBlacklistedPackagePrefixes;
  private PathFragment additionalBlacklistedPackagePrefixesFile;

  public BlacklistedPackagePrefixesFunction(
      ImmutableSet<PathFragment> hardcodedBlacklistedPackagePrefixes,
      PathFragment additionalBlacklistedPackagePrefixesFile) {
    this.hardcodedBlacklistedPackagePrefixes = hardcodedBlacklistedPackagePrefixes;
    this.additionalBlacklistedPackagePrefixesFile = additionalBlacklistedPackagePrefixesFile;
  }

  @Nullable
  @Override
  public SkyValue compute(SkyKey key, Environment env)
      throws SkyFunctionException, InterruptedException {
    ImmutableSet.Builder<PathFragment> blacklistedPackagePrefixesBuilder = ImmutableSet.builder();

    blacklistedPackagePrefixesBuilder.addAll(hardcodedBlacklistedPackagePrefixes);

    if (!additionalBlacklistedPackagePrefixesFile.equals(PathFragment.EMPTY_FRAGMENT)) {
      PathPackageLocator pkgLocator = PrecomputedValue.PATH_PACKAGE_LOCATOR.get(env);
      if (env.valuesMissing()) {
        return null;
      }

      for (Root packagePathEntry : pkgLocator.getPathEntries()) {
        RootedPath rootedPatternFile =
            RootedPath.toRootedPath(packagePathEntry, additionalBlacklistedPackagePrefixesFile);
        FileValue patternFileValue = (FileValue) env.getValue(FileValue.key(rootedPatternFile));
        if (patternFileValue == null) {
          return null;
        }
        if (patternFileValue.isFile()) {
          try {
            try (InputStreamReader reader =
                new InputStreamReader(rootedPatternFile.asPath().getInputStream(),
                    StandardCharsets.UTF_8)) {
              blacklistedPackagePrefixesBuilder.addAll(
                  CharStreams.readLines(reader, new PathFragmentLineProcessor()));
              break;
            }
          } catch (IOException e) {
            String errorMessage = e.getMessage() != null
                ? "error '" + e.getMessage() + "'" : "an error";
            throw new BlacklistedPatternsFunctionException(
                new InconsistentFilesystemException(
                    rootedPatternFile.asPath() + " is not readable because: " +  errorMessage
                        + ". Was it modified mid-build?"));
          }
        }
      }
    }

    return new BlacklistedPackagePrefixesValue(blacklistedPackagePrefixesBuilder.build());
  }

  private static final class PathFragmentLineProcessor
      implements LineProcessor<ImmutableSet<PathFragment>> {
    private final ImmutableSet.Builder<PathFragment> fragments = ImmutableSet.builder();

    @Override
    public boolean processLine(String line) throws IOException {
      if (!line.isEmpty()) {
        fragments.add(PathFragment.create(line));
      }
      return true;
    }

    @Override
    public ImmutableSet<PathFragment> getResult() {
      return fragments.build();
    }
  }

  @Nullable
  @Override
  public String extractTag(SkyKey skyKey) {
    return null;
  }

  private static final class BlacklistedPatternsFunctionException extends SkyFunctionException {
    public BlacklistedPatternsFunctionException(InconsistentFilesystemException e) {
      super(e, Transience.TRANSIENT);
    }
  }
}