// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "extensions/common/manifest.h"

#include <string_view>
#include <utility>

#include "base/check.h"
#include "base/containers/contains.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/notreached.h"
#include "base/strings/strcat.h"
#include "base/strings/utf_string_conversions.h"
#include "base/value_iterators.h"
#include "extensions/common/api/shared_module.h"
#include "extensions/common/error_utils.h"
#include "extensions/common/features/feature.h"
#include "extensions/common/features/feature_provider.h"
#include "extensions/common/install_warning.h"
#include "extensions/common/manifest_constants.h"
#include "extensions/common/manifest_handler_helpers.h"

using extensions::mojom::ManifestLocation;

namespace extensions {

namespace keys = manifest_keys;

namespace {

// Rank extension locations in a way that allows
// Manifest::GetHigherPriorityLocation() to compare locations.
// An extension installed from two locations will have the location
// with the higher rank, as returned by this function. The actual
// integer values may change, and should never be persisted.
int GetLocationRank(ManifestLocation location) {
  const int kInvalidRank = -1;
  int rank = kInvalidRank;  // Will CHECK that rank is not kInvalidRank.

  switch (location) {
    // Component extensions can not be overridden by any other type.
    case ManifestLocation::kComponent:
      rank = 9;
      break;

    case ManifestLocation::kExternalComponent:
      rank = 8;
      break;

    // Policy controlled extensions may not be overridden by any type
    // that is not part of chrome.
    case ManifestLocation::kExternalPolicy:
      rank = 7;
      break;

    case ManifestLocation::kExternalPolicyDownload:
      rank = 6;
      break;

    // A developer-loaded extension should override any installed type
    // that a user can disable. Anything specified on the command-line should
    // override one loaded via the extensions UI.
    case ManifestLocation::kCommandLine:
      rank = 5;
      break;

    case ManifestLocation::kUnpacked:
      rank = 4;
      break;

    // The relative priority of various external sources is not important,
    // but having some order ensures deterministic behavior.
    case ManifestLocation::kExternalRegistry:
      rank = 3;
      break;

    case ManifestLocation::kExternalPref:
      rank = 2;
      break;

    case ManifestLocation::kExternalPrefDownload:
      rank = 1;
      break;

    // User installed extensions are overridden by any external type.
    case ManifestLocation::kInternal:
      rank = 0;
      break;

    // kInvalidLocation should never be passed to this function.
    case ManifestLocation::kInvalidLocation:
      break;
  }

  CHECK(rank != kInvalidRank);
  return rank;
}

int GetManifestVersion(const base::Value::Dict& manifest_value,
                       Manifest::Type type) {
  // Platform apps were launched after manifest version 2 was the preferred
  // version, so they default to that.
  return manifest_value.FindInt(keys::kManifestVersion)
      .value_or(type == Manifest::TYPE_PLATFORM_APP ? 2 : 1);
}

// Helper class to filter available values from a manifest.
class AvailableValuesFilter {
 public:
  // Filters `manifest.values()` removing any unavailable keys.
  static base::Value::Dict Filter(const Manifest& manifest) {
    return FilterInternal(manifest, *manifest.value(), "");
  }

 private:
  // Returns a base::Value::Dict corresponding to |input_dict| for the given
  // |manifest|, with all unavailable keys removed.
  static base::Value::Dict FilterInternal(const Manifest& manifest,
                                          const base::Value::Dict& input_dict,
                                          std::string current_path) {
    base::Value::Dict output_dict;
    DCHECK(CanAccessFeature(manifest, current_path));

    for (auto it : input_dict) {
      std::string child_path = CombineKeys(current_path, it.first);

      // Unavailable key, skip it.
      if (!CanAccessFeature(manifest, child_path)) {
        continue;
      }

      // If |child_path| corresponds to a leaf node, copy it.
      bool is_leaf_node = !it.second.is_dict();
      if (is_leaf_node) {
        output_dict.Set(it.first, it.second.Clone());
        continue;
      }

      // Child dictionary. Populate it recursively.
      output_dict.Set(
          it.first, FilterInternal(manifest, it.second.GetDict(), child_path));
    }
    return output_dict;
  }

  // Returns true if the manifest feature corresponding to |feature_path| is
  // available to this manifest. Note: This doesn't check parent feature
  // availability. This is ok since we check feature availability in a
  // breadth-first manner below which ensures that we only ever check a child
  // feature if its parent is available. Note that api features don't follow
  // similar availability semantics i.e. we can have child api features be
  // available even if the parent feature is not (e.g.,
  // runtime.sendMessage()).
  static bool CanAccessFeature(const Manifest& manifest,
                               const std::string& feature_path) {
    const Feature* feature =
        FeatureProvider::GetManifestFeatures()->GetFeature(feature_path);

    // TODO(crbug.com/40745121): We assume that if a feature does not exist,
    // it is available. This is ok for child features (if its parent is
    // available) but is probably not correct for top-level features. We
    // should see if false can be returned for these non-existent top-level
    // features here.
    if (!feature) {
      return true;
    }

    return feature
        ->IsAvailableToManifest(
            manifest.hashed_id(), manifest.type(), manifest.location(),
            manifest.manifest_version(), kUnspecifiedContextId)
        .is_available();
  }

  static std::string CombineKeys(const std::string& parent,
                                 const std::string& child) {
    if (parent.empty()) {
      return child;
    }

    return base::StrCat({parent, ".", child});
  }
};

}  // namespace

// static
ManifestLocation Manifest::GetHigherPriorityLocation(ManifestLocation loc1,
                                                     ManifestLocation loc2) {
  if (loc1 == loc2) {
    return loc1;
  }

  int loc1_rank = GetLocationRank(loc1);
  int loc2_rank = GetLocationRank(loc2);

  // If two different locations have the same rank, then we can not
  // deterministicly choose a location.
  CHECK(loc1_rank != loc2_rank);

  // Highest rank has highest priority.
  return loc1_rank > loc2_rank ? loc1 : loc2;
}

// static
Manifest::Type Manifest::GetTypeFromManifestValue(
    const base::Value::Dict& value,
    bool for_login_screen) {
  Type type = TYPE_UNKNOWN;
  if (value.Find(keys::kTheme)) {
    type = TYPE_THEME;
  } else if (value.Find(api::shared_module::ManifestKeys::kExport)) {
    type = TYPE_SHARED_MODULE;
  } else if (value.Find(keys::kApp)) {
    if (value.FindByDottedPath(keys::kWebURLs) ||
        value.FindByDottedPath(keys::kLaunchWebURL)) {
      type = TYPE_HOSTED_APP;
    } else if (value.FindByDottedPath(keys::kPlatformAppBackground)) {
      type = TYPE_PLATFORM_APP;
    } else {
      type = TYPE_LEGACY_PACKAGED_APP;
    }
  } else if (value.Find(keys::kChromeOSSystemExtension)) {
    type = TYPE_CHROMEOS_SYSTEM_EXTENSION;
  } else if (for_login_screen) {
    type = TYPE_LOGIN_SCREEN_EXTENSION;
  } else {
    type = TYPE_EXTENSION;
  }
  DCHECK_NE(type, TYPE_UNKNOWN);

  return type;
}

// static
bool Manifest::ShouldAlwaysLoadExtension(ManifestLocation location,
                                         bool is_theme) {
  if (location == ManifestLocation::kComponent) {
    return true;  // Component extensions are always allowed.
  }

  if (is_theme) {
    return true;  // Themes are allowed, even with --disable-extensions.
  }

  // TODO(devlin): This seems wrong. See https://crbug.com/833540.
  if (Manifest::IsExternalLocation(location)) {
    return true;
  }

  return false;
}

// static
std::unique_ptr<Manifest> Manifest::CreateManifestForLoginScreen(
    ManifestLocation location,
    base::Value::Dict value,
    ExtensionId extension_id) {
  CHECK(IsPolicyLocation(location));
  // Use base::WrapUnique + new because the constructor is private.
  return base::WrapUnique(
      new Manifest(location, std::move(value), std::move(extension_id), true));
}

Manifest::Manifest(ManifestLocation location,
                   base::Value::Dict value,
                   ExtensionId extension_id)
    : Manifest(location, std::move(value), std::move(extension_id), false) {}

Manifest::Manifest(ManifestLocation location,
                   base::Value::Dict value,
                   ExtensionId extension_id,
                   bool for_login_screen)
    : extension_id_(std::move(extension_id)),
      hashed_id_(HashedExtensionId(extension_id_)),
      location_(location),
      value_(std::move(value)),
      type_(GetTypeFromManifestValue(value_, for_login_screen)),
      manifest_version_(GetManifestVersion(value_, type_)) {
  DCHECK(!extension_id_.empty());

  available_values_ = AvailableValuesFilter::Filter(*this);
}

Manifest::~Manifest() = default;

void Manifest::ValidateManifest(std::vector<InstallWarning>* warnings) const {
  // Check every feature to see if it's in the manifest. Note that this means
  // we will ignore keys that are not features; we do this for forward
  // compatibility.

  const FeatureProvider* manifest_feature_provider =
      FeatureProvider::GetManifestFeatures();
  for (const auto& map_entry : manifest_feature_provider->GetAllFeatures()) {
    if (!value_.FindByDottedPath(map_entry.first)) {
      continue;
    }

    Feature::Availability result = map_entry.second->IsAvailableToManifest(
        hashed_id_, type_, location_, manifest_version_, kUnspecifiedContextId);
    if (!result.is_available()) {
      warnings->emplace_back(result.message(), map_entry.first);
    }
  }

  // Also generate warnings for keys that are not features.
  for (const auto item : value_) {
    if (!manifest_feature_provider->GetFeature(item.first)) {
      // There are a set of keys that are not handled by Chrome, but that we
      // explicitly allow. Don't add a warning for those keys.
      if (base::Contains(keys::kIgnoredUnrecognizedKeys, item.first)) {
        continue;
      }

      warnings->emplace_back(
          ErrorUtils::FormatErrorMessage(
              manifest_errors::kUnrecognizedManifestKey, item.first),
          item.first);
    }
  }

  if (IsUnpackedLocation(location_) &&
      value_.FindByDottedPath(manifest_keys::kDifferentialFingerprint)) {
    warnings->emplace_back(manifest_errors::kHasDifferentialFingerprint,
                           manifest_keys::kDifferentialFingerprint);
  }
}

const base::Value* Manifest::FindKey(std::string_view key) const {
  return available_values_.Find(key);
}

const base::Value* Manifest::FindPath(std::string_view path) const {
  return available_values_.FindByDottedPath(path);
}

std::optional<bool> Manifest::FindBoolPath(std::string_view path) const {
  return available_values_.FindBoolByDottedPath(path);
}

std::optional<int> Manifest::FindIntPath(std::string_view path) const {
  return available_values_.FindIntByDottedPath(path);
}

const std::string* Manifest::FindStringPath(std::string_view path) const {
  return available_values_.FindStringByDottedPath(path);
}

const base::Value::Dict* Manifest::FindDictPath(std::string_view path) const {
  return available_values_.FindDictByDottedPath(path);
}

bool Manifest::GetList(const std::string& path,
                       const base::Value** out_value) const {
  const base::Value* value = available_values_.FindByDottedPath(path);
  if (!value || !value->is_list()) {
    return false;
  }
  *out_value = value;
  return true;
}

bool Manifest::EqualsForTesting(const Manifest& other) const {
  return value_ == other.value_ && location_ == other.location_ &&
         extension_id_ == other.extension_id_;
}

}  // namespace extensions