components/translate/core/browser/translate_ranker.h

// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_TRANSLATE_CORE_BROWSER_TRANSLATE_RANKER_H_
#define COMPONENTS_TRANSLATE_CORE_BROWSER_TRANSLATE_RANKER_H_

#include <memory>
#include <string>
#include <vector>

#include "base/macros.h"
#include "components/keyed_service/core/keyed_service.h"

class GURL;

namespace metrics {
class TranslateEventProto;
}  // namespace metrics

namespace translate {

// If enabled, downloads a translate ranker model and uses it to determine
// whether the user should be given a translation prompt or not.
class TranslateRanker : public KeyedService {
 public:
  TranslateRanker() = default;

  // Returns the version id for the ranker model.
  virtual uint32_t GetModelVersion() const = 0;

  // Returns true if executing the ranker model in the translation prompt
  // context described by |translate_event| and possibly
  // other global browser context attributes suggests that the user should be
  // prompted as to whether translation should be performed.
  virtual bool ShouldOfferTranslation(
      metrics::TranslateEventProto* translate_event) = 0;

  // Transfers cached translate events to the given vector pointer and clears
  // the cache.
  virtual void FlushTranslateEvents(
      std::vector<metrics::TranslateEventProto>* events) = 0;

  // Record |translate_event| with the given |event_type| and |url|.
  // |event_type| must be one of the values defined by
  // metrics::TranslateEventProto::EventType.
  virtual void RecordTranslateEvent(
      int event_type,
      const GURL& url,
      metrics::TranslateEventProto* translate_event) = 0;

  // If override is enabled, will return true and add |event_type| to
  // |translate_event.decision_overrides()|. If override is disabled,
  // returns false and finalize and record |translate_event| with
  // |event_type| as |translate_event.event_type()|.  |event_type|
  // must be one of the values defined by
  // metrics::TranslateEventProto::EventType.
  virtual bool ShouldOverrideDecision(
      int event_type,
      const GURL& url,
      metrics::TranslateEventProto* translate_event) = 0;

  // Override the default enabled/disabled state of translate event logging.
  virtual void EnableLogging(bool enable_logging) = 0;

 private:
  DISALLOW_COPY_AND_ASSIGN(TranslateRanker);
};

}  // namespace translate

#endif  // COMPONENTS_TRANSLATE_CORE_BROWSER_TRANSLATE_RANKER_H_