• Home
• org.apache.solr
• solr-core
• 9.6.0
• source code
• PackageManager.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.apache.solr.packagemanager.PackageManager Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.solr.packagemanager;

import static org.apache.solr.packagemanager.PackageUtils.getMapper;

import com.jayway.jsonpath.InvalidPathException;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.PathNotFoundException;
import java.io.Closeable;
import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Scanner;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import org.apache.solr.cli.SolrCLI;
import org.apache.solr.client.api.util.SolrVersion;
import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrRequest;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.client.solrj.impl.SolrZkClientTimeout;
import org.apache.solr.client.solrj.request.GenericSolrRequest;
import org.apache.solr.client.solrj.request.V2Request;
import org.apache.solr.client.solrj.request.beans.PackagePayload;
import org.apache.solr.client.solrj.request.beans.PluginMeta;
import org.apache.solr.client.solrj.response.V2Response;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.SolrException.ErrorCode;
import org.apache.solr.common.cloud.SolrZkClient;
import org.apache.solr.common.cloud.ZkStateReader;
import org.apache.solr.common.params.ModifiableSolrParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.common.util.Pair;
import org.apache.solr.common.util.StrUtils;
import org.apache.solr.common.util.Utils;
import org.apache.solr.filestore.DistribFileStore;
import org.apache.solr.handler.admin.ContainerPluginsApi;
import org.apache.solr.packagemanager.SolrPackage.Command;
import org.apache.solr.packagemanager.SolrPackage.Manifest;
import org.apache.solr.packagemanager.SolrPackage.Plugin;
import org.apache.solr.pkg.SolrPackageLoader;
import org.apache.zookeeper.KeeperException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Handles most of the management of packages that are already installed in Solr. */
public class PackageManager implements Closeable {

  final String solrBaseUrl;
  final SolrClient solrClient;
  final SolrZkClient zkClient;

  private Map> packages = null;

  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

  public PackageManager(SolrClient solrClient, String solrBaseUrl, String zkHost) {
    this.solrBaseUrl = solrBaseUrl;
    this.solrClient = solrClient;
    this.zkClient =
        new SolrZkClient.Builder()
            .withUrl(zkHost)
            .withTimeout(SolrZkClientTimeout.DEFAULT_ZK_CLIENT_TIMEOUT, TimeUnit.MILLISECONDS)
            .build();
    log.info("Done initializing a zkClient instance...");
  }

  @Override
  public void close() throws IOException {
    if (zkClient != null) {
      zkClient.close();
    }
  }

  public void uninstall(String packageName, String version)
      throws IOException, SolrServerException {
    SolrPackageInstance packageInstance = getPackageInstance(packageName, version);
    if (packageInstance == null) {
      PackageUtils.printRed(
          "Package "
              + packageName
              + ":"
              + version
              + " doesn't exist. Use the install command to install this package version first.");
      System.exit(1);
    }

    // Make sure that this package instance is not deployed on any collection
    Map collectionsDeployedOn = getDeployedCollections(packageName);
    for (String collection : collectionsDeployedOn.keySet()) {
      if (version.equals(collectionsDeployedOn.get(collection))) {
        PackageUtils.printRed(
            "Package "
                + packageName
                + " is currently deployed on collection: "
                + collection
                + ". Undeploy the package with undeploy  -collections [,,...] before attempting to uninstall the package.");
        System.exit(1);
      }
    }

    // Make sure that no plugin from this package instance has been deployed as cluster level
    // plugins
    Map clusterPackages = getPackagesDeployedAsClusterLevelPlugins();
    for (String clusterPackageName : clusterPackages.keySet()) {
      SolrPackageInstance clusterPackageInstance = clusterPackages.get(clusterPackageName);
      if (packageName.equals(clusterPackageName)
          && version.equals(clusterPackageInstance.version)) {
        PackageUtils.printRed(
            "Package "
                + packageName
                + "is currently deployed as a cluster-level plugin ("
                + clusterPackageInstance.getCustomData()
                + "). Undeploy the package with undeploy  -collections [,,...] before uninstalling the package.");
        System.exit(1);
      }
    }

    // Delete the package by calling the Package API and remove the Jar

    PackageUtils.printGreen("Executing Package API to remove this package...");
    PackagePayload.DelVersion del = new PackagePayload.DelVersion();
    del.version = version;
    del.pkg = packageName;

    V2Request req =
        new V2Request.Builder(PackageUtils.PACKAGE_PATH)
            .forceV2(true)
            .withMethod(SolrRequest.METHOD.POST)
            .withPayload(Collections.singletonMap("delete", del))
            .build();

    try {
      V2Response resp = req.process(solrClient);
      PackageUtils.printGreen("Response: " + resp.jsonStr());
    } catch (SolrServerException | IOException e) {
      throw new SolrException(ErrorCode.BAD_REQUEST, e);
    }

    PackageUtils.printGreen(
        "Executing Package Store API to remove the " + packageName + " package...");

    List filesToDelete = new ArrayList<>(packageInstance.files);
    filesToDelete.add(
        String.format(Locale.ROOT, "/package/%s/%s/%s", packageName, version, "manifest.json"));
    for (String filePath : filesToDelete) {
      DistribFileStore.deleteZKFileEntry(zkClient, filePath);
      String path = "/api/cluster/files" + filePath;
      PackageUtils.printGreen("Deleting " + path);
      solrClient.request(new GenericSolrRequest(SolrRequest.METHOD.DELETE, path));
    }

    PackageUtils.printGreen("Package uninstalled: " + packageName + ":" + version + ":-)");
  }

  public List fetchInstalledPackageInstances() throws SolrException {
    log.info("Getting packages from packages.json...");
    List ret = new ArrayList<>();
    packages = new HashMap<>();
    try {
      if (zkClient.exists(ZkStateReader.SOLR_PKGS_PATH, true)) {
        @SuppressWarnings("unchecked")
        Map>> packagesZnodeMap =
            (Map>>)
                getMapper()
                    .readValue(
                        new String(
                            zkClient.getData(ZkStateReader.SOLR_PKGS_PATH, null, null, true),
                            StandardCharsets.UTF_8),
                        Map.class)
                    .get("packages");
        for (String packageName : packagesZnodeMap.keySet()) {
          List> pkg = packagesZnodeMap.get(packageName);
          for (Map pkgVersion : pkg) {
            Manifest manifest =
                PackageUtils.fetchManifest(
                    solrClient,
                    pkgVersion.get("manifest").toString(),
                    pkgVersion.get("manifestSHA512").toString());
            List solrPlugins = manifest.plugins;
            SolrPackageInstance pkgInstance =
                new SolrPackageInstance(
                    packageName,
                    null,
                    pkgVersion.get("version").toString(),
                    manifest,
                    solrPlugins,
                    manifest.parameterDefaults);
            @SuppressWarnings("unchecked")
            List files = (List) pkgVersion.get("files");
            if (files != null) {
              pkgInstance.files = files;
            }
            List list =
                packages.computeIfAbsent(packageName, k -> new ArrayList<>());
            list.add(pkgInstance);
            ret.add(pkgInstance);
          }
        }
      }
    } catch (Exception e) {
      throw new SolrException(ErrorCode.BAD_REQUEST, e);
    }
    log.info("Got packages: {}", ret);
    return ret;
  }

  @SuppressWarnings({"unchecked"})
  public Map getPackagesDeployed(String collection) {
    Map packages = null;
    try {
      NamedList