Directorization.h

/*
 *  Copyright (C) 2015-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "FileItem.h"
#include "URL.h"
#include "utils/CharsetConverter.h"
#include "utils/StringUtils.h"
#include "utils/URIUtils.h"

#include <string>
#include <utility>
#include <vector>

namespace XFILE
{
  template<class TEntry>
  using DirectorizeEntryToFileItemFunction = CFileItemPtr(*)(const TEntry& entry, const std::string& label, const std::string& path, bool isFolder);

  template<class TEntry>
  using DirectorizeEntry = std::pair<std::string, TEntry>;
  template<class TEntry>
  using DirectorizeEntries = std::vector<DirectorizeEntry<TEntry>>;

  template<class TEntry>
  static void Directorize(const CURL& url, const DirectorizeEntries<TEntry>& entries, DirectorizeEntryToFileItemFunction<TEntry> converter, CFileItemList& items)
  {
    if (url.Get().empty() || entries.empty())
      return;

    const std::string& options = url.GetOptions();
    const std::string& filePath = url.GetFileName();

    CURL baseUrl(url);
    baseUrl.SetOptions(""); // delete options to have a clean path to add stuff too
    baseUrl.SetFileName(""); // delete filename too as our names later will contain it

    std::string basePath = baseUrl.Get();
    URIUtils::AddSlashAtEnd(basePath);

    std::vector<std::string> filePathTokens;
    if (!filePath.empty())
      StringUtils::Tokenize(filePath, filePathTokens, "/");

    bool fastLookup = items.GetFastLookup();
    items.SetFastLookup(true);
    for (const auto& entry : entries)
    {
      std::string entryPath = entry.first;
      std::string entryFileName = entryPath;
      StringUtils::Replace(entryFileName, '\\', '/');

      // skip the requested entry
      if (entryFileName == filePath)
        continue;

      // Disregard Apple Resource Fork data
      std::size_t found = entryPath.find("__MACOSX");
      if (found != std::string::npos)
        continue;

      std::vector<std::string> pathTokens;
      StringUtils::Tokenize(entryFileName, pathTokens, "/");

      // ignore any entries in lower directory hierarchies
      if (pathTokens.size() < filePathTokens.size() + 1)
        continue;

      // ignore any entries in different directory hierarchies
      bool ignoreItem = false;
      entryFileName.clear();
      for (auto filePathToken = filePathTokens.begin(); filePathToken != filePathTokens.end(); ++filePathToken)
      {
        if (*filePathToken != pathTokens[std::distance(filePathTokens.begin(), filePathToken)])
        {
          ignoreItem = true;
          break;
        }
        entryFileName = URIUtils::AddFileToFolder(entryFileName, *filePathToken);
      }
      if (ignoreItem)
        continue;

      entryFileName = URIUtils::AddFileToFolder(entryFileName, pathTokens[filePathTokens.size()]);
      char c = entryPath[entryFileName.size()];
      if (c == '/' || c == '\\')
        URIUtils::AddSlashAtEnd(entryFileName);

      std::string itemPath = URIUtils::AddFileToFolder(basePath, entryFileName) + options;
      bool isFolder = false;
      if (URIUtils::HasSlashAtEnd(entryFileName)) // this is a directory
      {
        // check if the directory has already been added
        if (items.Contains(itemPath)) // already added
          continue;

        isFolder = true;
        URIUtils::AddSlashAtEnd(itemPath);
      }

      // determine the entry's filename
      std::string label = pathTokens[filePathTokens.size()];
      g_charsetConverter.unknownToUTF8(label);

      // convert the entry into a CFileItem
      CFileItemPtr item = converter(entry.second, label, itemPath, isFolder);
      item->SetPath(itemPath);
      item->m_bIsFolder = isFolder;
      if (isFolder)
        item->m_dwSize = 0;

      items.Add(item);
    }
    items.SetFastLookup(fastLookup);
  }
}