[GitHub] [solr] muse-dev[bot] commented on a change in pull request #20: SOLR-15051 Blob, DRAFT WIP

[GitBox <gi...@apache.org>]

muse-dev[bot] commented on a change in pull request #20:
URL: https://github.com/apache/solr/pull/20#discussion_r623725392



##########
File path: solr/contrib/blob-directory/src/java/org/apache/solr/blob/BlobDirectoryFactory.java
##########
@@ -0,0 +1,335 @@
+/*
+ * 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.blob;
+
+import java.io.File;
+import java.io.IOException;
+import java.lang.invoke.MethodHandles;
+import java.net.URI;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Locale;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.lucene.store.*;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.common.params.CoreAdminParams;
+import org.apache.solr.common.params.SolrParams;
+import org.apache.solr.common.util.IOUtils;
+import org.apache.solr.common.util.NamedList;
+import org.apache.solr.core.CachingDirectoryFactory;
+import org.apache.solr.core.CoreContainer;
+import org.apache.solr.core.CoreDescriptor;
+import org.apache.solr.core.DirectoryFactory;
+import org.apache.solr.core.backup.repository.BackupRepository;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class BlobDirectoryFactory extends CachingDirectoryFactory {
+
+  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+  /**
+   * Default maximum number of threads that push files concurrently to the repository.
+   */
+  private static final int DEFAULT_MAX_THREADS = 20;
+
+  /**
+   * Default size of the buffer used to transfer input-output stream to the repository, in bytes.
+   * The appropriate size depends on the repository.
+   * There is one buffer per thread.
+   */
+  public static final int DEFAULT_STREAM_BUFFER_SIZE = 32_768;
+
+  private static final Pattern INDEX_NAME_PATTERN = Pattern.compile("index(?:\\.[0-9]{17})?");
+
+  private String localRootPath;
+  private BackupRepository repository;
+  private URI repositoryLocation;
+  private BlobPusher blobPusher;
+  private MMapParams mMapParams;
+
+  @Override
+  public void initCoreContainer(CoreContainer cc) {
+    super.initCoreContainer(cc);
+    localRootPath = (dataHomePath == null ? cc.getCoreRootDirectory() : dataHomePath).getParent().toString();
+    // blobListingManager = BlobListingManager.getInstance(cc, "/blobDirListings");
+  }
+
+  @Override
+  public void init(@SuppressWarnings("rawtypes") NamedList args) {
+    super.init(args);
+    SolrParams params = args.toSolrParams();
+
+    // Repository where files are persisted.
+    // 'repository' parameter must be defined, we don't want to use a default one.
+    String repositoryName = params.get(CoreAdminParams.BACKUP_REPOSITORY);
+    if (repositoryName == null) {
+      throw new IllegalArgumentException("Parameter '" + CoreAdminParams.BACKUP_REPOSITORY + "' is required");
+    }
+    repository = coreContainer.newBackupRepository(repositoryName);
+
+    // 'location' parameter must be defined, we don't want to use a default one.
+    String location = repository.getBackupLocation(params.get(CoreAdminParams.BACKUP_LOCATION));
+    if (location == null) {
+      throw new IllegalArgumentException("Parameter '" + CoreAdminParams.BACKUP_LOCATION + "' is required");
+    }
+    repositoryLocation = repository.createURI(location);
+
+    // 'threads' defines the maximum number of threads that push files concurrently to the repository.
+    int maxThreads = params.getInt("threads", DEFAULT_MAX_THREADS);
+
+    // 'streamBufferSize' defines the size of the stream copy buffer.
+    // This determines the size of the chunk of data sent to the repository during files transfer.
+    // It is optional but recommended to set the appropriate size for the selected repository.
+    // There is one buffer per thread.
+    int streamBufferSize = params.getInt("streamBufferSize", DEFAULT_STREAM_BUFFER_SIZE);
+
+    blobPusher = new BlobPusher(repository, repositoryLocation, maxThreads, streamBufferSize);
+
+    // Filesystem MMapDirectory used as a local file cache.
+    mMapParams = new MMapParams(params);
+  }
+
+  BackupRepository getRepository() {
+    return repository;
+  }
+
+  URI getRepositoryLocation() {
+    return repositoryLocation;
+  }
+
+  MMapParams getMMapParams() {
+    return mMapParams;
+  }
+
+  @Override
+  public void doneWithDirectory(Directory directory) throws IOException {
+    log.debug("doneWithDirectory {}", directory);
+    ((BlobDirectory) directory).release();
+    super.doneWithDirectory(directory);
+  }
+
+  @Override
+  public void close() throws IOException {
+    log.debug("close");
+    IOUtils.closeQuietly(repository);
+    IOUtils.closeQuietly(blobPusher);
+    super.close();
+  }
+
+  @Override
+  protected LockFactory createLockFactory(String rawLockType) {
+    log.debug("createLockFactory {}", rawLockType);
+    if (rawLockType == null) {
+      rawLockType = DirectoryFactory.LOCK_TYPE_NATIVE;
+      log.warn("No lockType configured, assuming '{}'.", rawLockType);
+    }
+    String lockType = rawLockType.toLowerCase(Locale.ROOT).trim();
+    switch (lockType) {
+      case DirectoryFactory.LOCK_TYPE_SIMPLE:
+        return SimpleFSLockFactory.INSTANCE;
+      case DirectoryFactory.LOCK_TYPE_NATIVE:
+        return NativeFSLockFactory.INSTANCE;
+      case DirectoryFactory.LOCK_TYPE_SINGLE:
+        return new SingleInstanceLockFactory();
+      case DirectoryFactory.LOCK_TYPE_NONE:
+        return NoLockFactory.INSTANCE;
+      default:
+        throw new SolrException(SolrException.ErrorCode.SERVER_ERROR,
+                "Unrecognized lockType: " + rawLockType);
+    }
+  }
+
+  @Override
+  protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)
+      throws IOException {
+    log.debug("Create Directory {}", path);
+    // Create directly a MMapDirectory without calling MMapDirectoryFactory because this BlobDirectoryFactory
+    // is already a CachingDirectoryFactory, so we don't want another CachingDirectoryFactory.
+    MMapDirectory mapDirectory = createMMapDirectory(path, lockFactory);
+    String blobDirPath = getLocalRelativePath(path);
+    return new BlobDirectory(mapDirectory, blobDirPath, blobPusher);
+  }
+
+  private MMapDirectory createMMapDirectory(String path, LockFactory lockFactory) throws IOException {
+    MMapDirectory mapDirectory = new MMapDirectory(new File(path).toPath(), lockFactory, mMapParams.maxChunk);

Review comment:
       *PATH_TRAVERSAL_IN:*  This API (java/io/File.<init>(Ljava/lang/String;)V) reads a file whose location might be specified by user input [(details)](https://find-sec-bugs.github.io/bugs.htm#PATH_TRAVERSAL_IN)
   (at-me [in a reply](https://docs.muse.dev/docs/talk-to-muse/) with `help` or `ignore`)




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org