githubmirror/omim

map/search_mark.cpp
632 строки19 KB
r.kuznetsov
Fixed search result badge appearance
23 ноя 2018, 17:47
23 ноя 2018, 17:47c028e51
#include "map/search_mark.hpp"
#include "map/bookmark_manager.hpp"
#include "map/place_page_info.hpp"

#include "drape_frontend/drape_engine.hpp"
#include "drape_frontend/visual_params.hpp"

#include "platform/platform.hpp"

#include "base/stl_helpers.hpp"

#include <algorithm>
#include <array>
#include <limits>

#include "defines.hpp"

namespace
{
enum class SearchMarkType
{
  Default = 0,
  Booking,
  Cafe,
  Bakery,
  Bar,
  Pub,
  Restaurant,
  FastFood,
  Casino,
  Cinema,
  Marketplace,
  Nightclub,
  Playground,
  ShopAlcohol,
  ShopButcher,
  ShopClothes,
  ShopConfectionery,
  ShopConvenience,
  ShopCosmetics,
  ShopDepartmentStore,
  ShopGift,
  ShopGreengrocer,
  ShopJewelry,
  ShopMall,
  ShopSeafood,
  ShopShoes,
  ShopSports,
  ShopSupermarket,
  ShopToys,
  ThemePark,
  WaterPark,
  Zoo,

  NotFound, // Service value used in developer tools.
  Count
};

static_assert(static_cast<uint32_t>(SearchMarkType::Count) <= std::numeric_limits<uint8_t>::max(),
              "Change SearchMarkPoint::m_type type.");

SearchMarkType SMT(uint8_t type)
{
  return static_cast<SearchMarkType>(type);
}

std::array<std::string, static_cast<size_t>(SearchMarkType::Count)> const kSymbols = {
    "search-result",                        // Default.
    "coloredmark-default-l",                // Booking.
    "search-result-cafe",                   // Cafe.
    "search-result-bakery",                 // Bakery.
    "search-result-bar",                    // Bar.
    "search-result-pub",                    // Pub.
    "search-result-restaurant",             // Restaurant.
    "search-result-fastfood",               // FastFood.
    "search-result-casino",                 // Casino.
    "search-result-cinema",                 // Cinema.
    "search-result-marketplace",            // Marketplace.
    "search-result-nightclub",              // Nightclub.
    "search-result-playground",             // Playground.
    "search-result-shop-alcohol",           // ShopAlcohol.
    "search-result-shop-butcher",           // ShopButcher.
    "search-result-shop-clothes",           // ShopClothes.
    "search-result-shop-confectionery",     // ShopConfectionery.
    "search-result-shop-convenience",       // ShopConvenience.
    "search-result-shop-cosmetics",         // ShopCosmetics.
    "search-result-shop-department_store",  // ShopDepartmentStore.
    "search-result-shop-gift",              // ShopGift.
    "search-result-shop-greengrocer",       // ShopGreengrocer.
    "search-result-shop-jewelry",           // ShopJewelry.
    "search-result-shop-mall",              // ShopMall.
    "search-result-shop-seafood",           // ShopSeafood.
    "search-result-shop-shoes",             // ShopShoes.
    "search-result-shop-sports",            // ShopSports.
    "search-result-shop-supermarket",       // ShopSupermarket.
    "search-result-shop-toys",              // ShopToys.
    "search-result-theme-park",             // ThemePark.
    "search-result-water-park",             // WaterPark.
    "search-result-zoo",                    // Zoo.

    "non-found-search-result",  // NotFound.
};

std::string const kSaleBadgeName = "search-badge-booking-sale";
std::string const kUGCRatingBadgeName = "search-badge-rating";
std::string const kRatedDefaultSearchIcon = "rated-default-search-result";
std::string const kLocalAdsRatedDefaultSearchIcon = "local_ads-rated-default-search-result";

float const kRatingThreshold = 6.0f;
float const kMetricThreshold = 0.38f;

int constexpr kUGCBadgeMinZoomLevel = 10;

inline bool HasRating(float rating)
{
  return rating > kInvalidRatingValue;
}

float CalculateAggregateMetric(float rating, int pricing)
{
  float const p1 = base::clamp(rating, 0.0f, 10.0f) / 10.0f;
  float const p2 = (3 - base::clamp(pricing, 0, 3)) / 3.0f;
  float const s = p1 + p2;
  if (fabs(s) < 1e-5)
    return 0.0f;
  return 2.0f * p1 * p2 / s;
}

std::string GetBookingBadgeName(int pricing)
{
  if (pricing == 0)
    return {};

  return std::string("search-badge-booking-ext-") + strings::to_string(pricing);
}

bool NeedShowBookingBadge(float rating, int pricing)
{
  if (pricing == 0)
    return false;
  auto const metric = CalculateAggregateMetric(rating, pricing);
  return metric >= kMetricThreshold;
}

std::string GetBookingSmallIcon(SearchMarkType type, bool hasLocalAds)
{
  if (type != SearchMarkType::Booking)
    return {};

  return hasLocalAds ? "search-adv" : "coloredmark-default-s";
}

std::string GetSymbol(SearchMarkType searchMarkType, bool hasLocalAds, bool isRated)
{
  if (searchMarkType == SearchMarkType::Default && isRated)
    return hasLocalAds ? kLocalAdsRatedDefaultSearchIcon : kRatedDefaultSearchIcon;

  auto const index = static_cast<size_t>(searchMarkType);
  ASSERT_LESS(index, kSymbols.size(), ());
  if (!hasLocalAds)
    return kSymbols[index];

  if (searchMarkType == SearchMarkType::Booking)
    return "searchbookingadv-default-l";

  return "local_ads-" + kSymbols[index];
}

bool HasLocalAdsVariant(SearchMarkType searchMarkType)
{
  if (searchMarkType == SearchMarkType::NotFound)
    return false;
  return true;
}

std::string GetPreparingSymbol(SearchMarkType searchMarkType, bool hasLocalAds, bool isRated)
{
  if (!hasLocalAds && searchMarkType == SearchMarkType::Booking)
    return "coloredmark-inactive";
  return GetSymbol(searchMarkType, hasLocalAds, isRated);
}

m2::PointD GetSize(SearchMarkType searchMarkType, bool hasLocalAds, bool isRated,
                   ScreenBase const & modelView)
{
  if (!SearchMarks::HaveSizes())
    return {};

  auto const pixelSize =
      SearchMarks::GetSize(GetSymbol(searchMarkType, hasLocalAds, isRated)).get_value_or({});
  double const pixelToMercator = modelView.GetScale();
  return {pixelToMercator * pixelSize.x, pixelToMercator * pixelSize.y};
}

class SearchMarkTypeChecker
{
public:
  static SearchMarkTypeChecker & Instance()
  {
    static SearchMarkTypeChecker checker;
    return checker;
  }

  SearchMarkType GetSearchMarkType(uint32_t type) const
  {
    auto const it = std::lower_bound(m_searchMarkTypes.cbegin(), m_searchMarkTypes.cend(),
                                     Type(type, SearchMarkType::Count), base::LessBy(&Type::first));
    if (it == m_searchMarkTypes.cend() || it->first != type)
      return SearchMarkType::Default;

    return it->second;
  }

private:
  using Type = std::pair<uint32_t, SearchMarkType>;

  SearchMarkTypeChecker()
  {
    auto const & c = classif();
    std::vector<std::pair<std::vector<std::string>, SearchMarkType>> const table = {
      {{"amenity", "cafe"},          SearchMarkType::Cafe},
      {{"shop", "bakery"},           SearchMarkType::Bakery},
      {{"amenity", "bar"},           SearchMarkType::Bar},
      {{"amenity", "pub"},           SearchMarkType::Pub},
      {{"amenity", "biergarten"},    SearchMarkType::Pub},
      {{"amenity", "restaurant"},    SearchMarkType::Restaurant},
      {{"amenity", "fast_food"},     SearchMarkType::FastFood},
      {{"amenity", "casino"},        SearchMarkType::Casino},
      {{"amenity", "cinema"},        SearchMarkType::Cinema},
      {{"amenity", "marketplace"},   SearchMarkType::Marketplace},
      {{"amenity", "nightclub"},     SearchMarkType::Nightclub},
      {{"leisure", "playground"},    SearchMarkType::Playground},
      {{"shop", "alcohol"},          SearchMarkType::ShopAlcohol},
      {{"shop", "beverages"},        SearchMarkType::ShopAlcohol},
      {{"shop", "wine"},             SearchMarkType::ShopAlcohol},
      {{"shop", "butcher"},          SearchMarkType::ShopButcher},
      {{"shop", "clothes"},          SearchMarkType::ShopClothes},
      {{"shop", "confectionery"},    SearchMarkType::ShopConfectionery},
      {{"shop", "convenience"},      SearchMarkType::ShopConvenience},
      {{"shop", "variety_store"},    SearchMarkType::ShopConvenience},
      {{"shop", "cosmetics"},        SearchMarkType::ShopCosmetics},
      {{"shop", "department_store"}, SearchMarkType::ShopDepartmentStore},
      {{"shop", "gift"},             SearchMarkType::ShopGift},
      {{"shop", "greengrocer"},      SearchMarkType::ShopGreengrocer},
      {{"shop", "jewelry"},          SearchMarkType::ShopJewelry},
      {{"shop", "mall"},             SearchMarkType::ShopMall},
      {{"shop", "seafood"},          SearchMarkType::ShopSeafood},
      {{"shop", "shoes"},            SearchMarkType::ShopShoes},
      {{"shop", "sports"},           SearchMarkType::ShopSports},
      {{"shop", "supermarket"},      SearchMarkType::ShopSupermarket},
      {{"shop", "toys"},             SearchMarkType::ShopToys},
      {{"tourism", "theme_park"},    SearchMarkType::ThemePark},
      {{"leisure", "water_park"},    SearchMarkType::WaterPark},
      {{"tourism", "zoo"},           SearchMarkType::Zoo}
    };

    m_searchMarkTypes.reserve(table.size());
    for (auto const & p : table)
      m_searchMarkTypes.push_back({c.GetTypeByPath(p.first), p.second});

    std::sort(m_searchMarkTypes.begin(), m_searchMarkTypes.end(), base::LessBy(&Type::first));
  }

  std::vector<Type> m_searchMarkTypes;
};

SearchMarkType GetSearchMarkType(uint32_t type)
{
  auto const & checker = SearchMarkTypeChecker::Instance();
  return checker.GetSearchMarkType(type);
}
}  // namespace

SearchMarkPoint::SearchMarkPoint(m2::PointD const & ptOrg)
  : UserMark(ptOrg, UserMark::Type::SEARCH)
{
  m_titleDecl.m_anchor = dp::Center;
  m_titleDecl.m_primaryTextFont.m_color = df::GetColorConstant("RatingText");
  m_titleDecl.m_primaryTextFont.m_size =
      static_cast<float>(12.0 / df::VisualParams::Instance().GetFontScale());

  m_ugcTitleDecl.m_anchor = dp::LeftTop;
  m_ugcTitleDecl.m_primaryTextFont.m_color = df::GetColorConstant("UGCRatingText");
  m_ugcTitleDecl.m_primaryTextFont.m_size =
      static_cast<float>(14.0 / df::VisualParams::Instance().GetFontScale());
}

std::string SearchMarkPoint::GetSymbolName() const
{
  std::string name;
  if (m_type >= static_cast<uint8_t>(SearchMarkType::Count))
  {
    ASSERT(false, ("Unknown search mark symbol."));
    name = GetSymbol(SearchMarkType::Default, false /* hasLocalAds */, HasRating(m_rating));
  }
  else if (m_isPreparing)
  {
    name = GetPreparingSymbol(SMT(m_type), m_hasLocalAds, HasRating(m_rating));
  }
  else
  {
    name = GetSymbol(SMT(m_type), m_hasLocalAds, HasRating(m_rating));
  }
  return name;
}

drape_ptr<df::UserPointMark::SymbolNameZoomInfo> SearchMarkPoint::GetSymbolNames() const
{
  auto const name = GetSymbolName();
  auto symbol = make_unique_dp<SymbolNameZoomInfo>();
  if (IsBookingSpecialMark())
  {
    symbol->insert(std::make_pair(
        1 /* zoomLevel */,
        m_rating < kRatingThreshold ? GetBookingSmallIcon(SMT(m_type), m_hasLocalAds) : name));
    symbol->insert(std::make_pair(17 /* zoomLevel */, name));
  }
  else
  {
    symbol->insert(std::make_pair(1 /* zoomLevel */, name));
  }
  return symbol;
}

drape_ptr<df::UserPointMark::SymbolNameZoomInfo> SearchMarkPoint::GetBadgeNames() const
{
  auto const badgeName = GetBadgeName();
  if (badgeName.empty())
    return nullptr;
  
  if (IsBookingSpecialMark())
  {
    auto symbol = make_unique_dp<SymbolNameZoomInfo>();
    if (NeedShowBookingBadge(m_rating, m_pricing) && m_rating >= kRatingThreshold)
      symbol->insert(std::make_pair(10 /* zoomLevel */, badgeName));
    else
      symbol->insert(std::make_pair(17 /* zoomLevel */, badgeName));
    return symbol;
  }
  
  if (IsUGCMark())
  {
    auto symbol = make_unique_dp<SymbolNameZoomInfo>();
    symbol->insert(std::make_pair(kUGCBadgeMinZoomLevel /* zoomLevel */, badgeName));
    return symbol;
  }
  
  return nullptr;
}

drape_ptr<df::UserPointMark::SymbolOffsets> SearchMarkPoint::GetSymbolOffsets() const
{
  auto const badgeName = GetBadgeName();
  if (badgeName.empty())
    return nullptr;

  auto const name = GetSymbolName();
  auto const iconSz = SearchMarks::GetSize(name).get_value_or({});

  float horizontalOffset = 0.0f;
  if (SMT(m_type) != SearchMarkType::Booking && m_hasLocalAds)
  {
    float constexpr kLocalAdsSymbolOffset = 0.4f;
    horizontalOffset = kLocalAdsSymbolOffset;
  }
  SymbolOffsets offsets(scales::UPPER_STYLE_SCALE);
  for (size_t i = 0; i < offsets.size(); i++)
  {
    auto const badgeSz = SearchMarks::GetSize(badgeName).get_value_or({});
    offsets[i] = {(0.5f + horizontalOffset) * static_cast<float>(badgeSz.x - iconSz.x), 0.0};
  }

  return make_unique_dp<SymbolOffsets>(offsets);
}

bool SearchMarkPoint::IsMarkAboveText() const
{
  return !IsBookingSpecialMark();
}

df::ColorConstant SearchMarkPoint::GetColorConstant() const
{
  if (!IsBookingSpecialMark())
    return {};

  if (SMT(m_type) == SearchMarkType::Booking && m_hasLocalAds)
    return "RatingLocalAds";

  if (!HasRating(m_rating))
    return "RatingNone";
  if (m_rating < 2.0f)
    return "RatingHorrible";
  if (m_rating < 4.0f)
    return "RatingBad";
  if (m_rating < 6.0f)
    return "RatingNormal";
  if (m_rating < 8.0f)
    return "RatingGood";
  return "RatingExcellent";
}

drape_ptr<df::UserPointMark::TitlesInfo> SearchMarkPoint::GetTitleDecl() const
{
  auto const isUGC = IsUGCMark();
  if ((!IsBookingSpecialMark() && !isUGC) || !HasRating(m_rating))
    return nullptr;

  auto titles = make_unique_dp<TitlesInfo>();
  if (isUGC)
  {
    auto titleDecl = m_ugcTitleDecl;
    auto const sz = SearchMarks::GetSize(GetSymbolName());
    if (!sz)
      return nullptr;
    auto constexpr kShadowOffset = 4.0;
    auto const centerOffset = -0.5 * sz.get().y - kShadowOffset;
    titleDecl.m_primaryOffset.y =
        static_cast<float>(centerOffset / df::VisualParams::Instance().GetVisualScale()) -
        0.5f * titleDecl.m_primaryTextFont.m_size;
    titles->push_back(titleDecl);
  }
  else
  {
    titles->push_back(m_titleDecl);
  }
  return titles;
}

int SearchMarkPoint::GetMinTitleZoom() const
{
  if (IsBookingSpecialMark() && m_rating < kRatingThreshold)
    return 17;
  if (IsUGCMark())
    return kUGCBadgeMinZoomLevel;
  return 1;
}

df::DepthLayer SearchMarkPoint::GetDepthLayer() const
{
  return df::DepthLayer::SearchMarkLayer;
}

void SearchMarkPoint::SetFoundFeature(FeatureID const & feature)
{
  SetAttributeValue(m_featureID, feature);
}

void SearchMarkPoint::SetMatchedName(std::string const & name)
{
  SetAttributeValue(m_matchedName, name);
}

void SearchMarkPoint::SetFromType(uint32_t type, bool hasLocalAds)
{
  SetAttributeValue(m_hasLocalAds, hasLocalAds);
  SetAttributeValue(m_type, static_cast<uint8_t>(GetSearchMarkType(type)));
}

void SearchMarkPoint::SetBookingType(bool hasLocalAds)
{
  SetAttributeValue(m_hasLocalAds, hasLocalAds);
  SetAttributeValue(m_type, static_cast<uint8_t>(SearchMarkType::Booking));
}

void SearchMarkPoint::SetNotFoundType()
{
  SetAttributeValue(m_hasLocalAds, false);
  SetAttributeValue(m_type, static_cast<uint8_t>(SearchMarkType::NotFound));
}

void SearchMarkPoint::SetPreparing(bool isPreparing)
{
  SetAttributeValue(m_isPreparing, isPreparing);
}

void SearchMarkPoint::SetRating(float rating)
{
  SetAttributeValue(m_rating, rating);
  m_titleDecl.m_primaryText = place_page::rating::GetRatingFormatted(rating);
  m_ugcTitleDecl.m_primaryText = m_titleDecl.m_primaryText;
}

void SearchMarkPoint::SetPricing(int pricing)
{
  SetAttributeValue(m_pricing, pricing);
}

void SearchMarkPoint::SetSale(bool hasSale)
{
  SetAttributeValue(m_hasSale, hasSale);
}

bool SearchMarkPoint::IsBookingSpecialMark() const
{
  return (SMT(m_type) == SearchMarkType::Booking) && !m_isPreparing;
}

bool SearchMarkPoint::IsUGCMark() const
{
  return (SMT(m_type) != SearchMarkType::Booking) && HasRating(m_rating);
}

std::string SearchMarkPoint::GetBadgeName() const
{
  std::string badgeName;
  if (IsBookingSpecialMark())
    badgeName = m_hasSale ? kSaleBadgeName : GetBookingBadgeName(m_pricing);
  else if (IsUGCMark())
    badgeName = kUGCRatingBadgeName;
  
  if (badgeName.empty() || !SearchMarks::GetSize(badgeName))
    return {};
  
  return badgeName;
}

// static
std::map<std::string, m2::PointF> SearchMarks::m_searchMarksSizes;

SearchMarks::SearchMarks()
  : m_bmManager(nullptr)
{}

void SearchMarks::SetDrapeEngine(ref_ptr<df::DrapeEngine> engine)
{
  m_drapeEngine.Set(engine);
  if (engine == nullptr)
    return;

  std::vector<std::string> symbols;
  auto const searchMarkTypesCount = static_cast<size_t>(SearchMarkType::Count);
  for (size_t t = 0; t < searchMarkTypesCount; ++t)
  {
    auto const searchMarkType = SMT(t);
    symbols.emplace_back(GetSymbol(searchMarkType, false /* hasLocalAds */, false /* isRated */));
    symbols.emplace_back(GetSymbol(searchMarkType, false /* hasLocalAds */, true /* isRated */));
    if (HasLocalAdsVariant(searchMarkType))
    {
      symbols.emplace_back(GetSymbol(searchMarkType, true /* hasLocalAds */, false /* isRated */));
      symbols.emplace_back(GetSymbol(searchMarkType, true /* hasLocalAds */, true /* isRated */));
    }
  }

  for (int pricing = 1; pricing <= 3; pricing++)
    symbols.emplace_back(GetBookingBadgeName(pricing));
  symbols.emplace_back(kSaleBadgeName);
  symbols.emplace_back(kUGCRatingBadgeName);

  base::SortUnique(symbols);

  m_drapeEngine.SafeCall(&df::DrapeEngine::RequestSymbolsSize, symbols,
                         [](std::map<std::string, m2::PointF> && sizes)
  {
    GetPlatform().RunTask(Platform::Thread::Gui, [sizes = std::move(sizes)]() mutable
    {
      m_searchMarksSizes = std::move(sizes);
    });
  });
}

void SearchMarks::SetBookmarkManager(BookmarkManager * bmManager)
{
  m_bmManager = bmManager;
}

double SearchMarks::GetMaxDimension(ScreenBase const & modelView) const
{
  double dimension = 0.0;
  m2::PointD markSize;
  auto measurer = [&dimension, &markSize](SearchMarkType searchMarkType,
                                          bool hasLocalAds,
                                          ScreenBase const & modelView)
  {
    for (size_t j = 0; j < 2; ++j)
    {
      markSize = ::GetSize(searchMarkType, true /* hasLocalAds */,
                           j > 0 /* isRated */, modelView);
      dimension = std::max(dimension, std::max(markSize.x, markSize.y));
    }
  };

  for (size_t i = 0; i < static_cast<size_t>(SearchMarkType::Count); ++i)
  {
    auto const searchMarkType = SMT(i);
    measurer(searchMarkType, false /* hasLocalAds */, modelView);
    if (HasLocalAdsVariant(searchMarkType))
      measurer(searchMarkType, true /* hasLocalAds */, modelView);
  }
  return dimension;
}

// static
boost::optional<m2::PointD> SearchMarks::GetSize(std::string const & symbolName)
{
  auto const it = m_searchMarksSizes.find(symbolName);
  if (it == m_searchMarksSizes.end())
    return {};
  return m2::PointD(it->second);
}

void SearchMarks::SetPreparingState(std::vector<FeatureID> const & features, bool isPreparing)
{
  FilterAndProcessMarks(features, [isPreparing](SearchMarkPoint * mark)
  {
    mark->SetPreparing(isPreparing);
  });
}

void SearchMarks::SetSales(std::vector<FeatureID> const & features, bool hasSale)
{
  FilterAndProcessMarks(features, [hasSale](SearchMarkPoint * mark)
  {
    mark->SetSale(hasSale);
  });
}

void SearchMarks::FilterAndProcessMarks(std::vector<FeatureID> const & features,
                                        std::function<void(SearchMarkPoint *)> && processor)
{
  if (m_bmManager == nullptr || processor == nullptr)
    return;

  ASSERT(std::is_sorted(features.begin(), features.end()), ());

  auto editSession = m_bmManager->GetEditSession();
  for (auto markId : m_bmManager->GetUserMarkIds(UserMark::Type::SEARCH))
  {
    auto * mark = editSession.GetMarkForEdit<SearchMarkPoint>(markId);
    if (std::binary_search(features.begin(), features.end(), mark->GetFeatureID()))
      processor(mark);
  }
}