FileSpec.h

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * 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.
 */
 
#pragma once
 
#include <cstdint>
#include <functional>
#include <map>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
#include <vrs/VrsExport.h>
 
namespace vrs {
using std::map;
using std::string;
using std::string_view;
using std::vector;
 
struct VRS_API FileSpec {
  using Extras = map<string, string, std::less<>>;
 
  FileSpec() = default;
  FileSpec(string filehandler, const vector<string>& chunksIn)
      : fileHandlerName{std::move(filehandler)}, chunks{chunksIn} {}
  FileSpec(string filehandler, const vector<string>&& chunksIn)
      : fileHandlerName{std::move(filehandler)}, chunks{chunksIn} {}
  explicit FileSpec(const vector<string>& chunksIn) : chunks{chunksIn} {}
  explicit FileSpec(vector<string>&& chunksIn) : chunks{std::move(chunksIn)} {}
 
  void clear();
 
  bool empty() const;
 
  bool isDiskFile() const;
 
  static int parseUri(string_view uri, string& outScheme, string& outPath, Extras& outQueryParams);
 
  int fromPathJsonUri(string_view pathJsonUri, string_view defaultFileHandlerName = {});
 
  string toPathJsonUri() const;
 
  // Parse json and extract file specs, with optional extra parameters.
  // @param jsonStr: ex. {"storage": "mystorage", "chunks":["chunk1", "chunk2"],
  // "filename":"file.vrs"}.
  // @return True if parsing the json succeeded.
  bool fromJson(string_view jsonStr);
 
  // Generate json string from a file spec.
  // @return jsonStr: ex. {"storage": "mystorage", "chunks":["chunk1", "chunk2"],
  // "filename":"file.vrs"}.
  string toJson() const;
 
  int parseUri();
 
  bool hasChunkSizes() const;
  int64_t getFileSize() const;
  string getSourceLocation() const;
  string getEasyPath() const;
  string getFileName() const;
 
  string getXXHash() const;
 
  bool operator==(const FileSpec& rhs) const;
 
  const string& getExtra(string_view name) const;
  bool getExtra(string_view name, string& outValue) const;
  bool hasExtra(string_view name) const;
  int getExtraAsInt(string_view name, int defaultValue = 0) const;
  int64_t getExtraAsInt64(string_view name, int64_t defaultValue = 0) const;
  uint64_t getExtraAsUInt64(string_view name, uint64_t defaultValue = 0) const;
  double getExtraAsDouble(string_view name, double defaultValue = 0) const;
  bool getExtraAsBool(string_view name, bool defaultValue = false) const;
 
  static int decodeQuery(string_view query, string& outKey, string& outValue);
  static int urldecode(string_view in, string& out);
 
  void setExtra(string_view name, string_view value);
  void setExtra(string_view name, const char* value);
  void setExtra(string_view name, bool value);
  void setExtra(string_view name, const string& value);
  template <typename T>
  void setExtra(string_view name, T value) {
    extras[string(name)] = std::to_string(value);
  }
 
  void unsetExtra(string_view name);
 
  string fileHandlerName;
  string fileName;
  string uri;
  vector<string> chunks;
  vector<int64_t> chunkSizes;
  Extras extras;
};
 
} // namespace vrs