user-context.h

Go to the documentation of this file.

/* This file is part of SOMHunter.
 *
 * Copyright (C) 2021 Frantisek Mejzlik <frankmejzlik@protonmail.com>
 *                    Mirek Kratochvil <exa.exa@gmail.com>
 *                    Patrik Vesely <prtrikvesely@gmail.com>
 *
 * SOMHunter is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 2 of the License, or (at your option)
 * any later version.
 *
 * SOMHunter is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * SOMHunter. If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef USER_CONTEXT_H_
#define USER_CONTEXT_H_
 
#include <array>
#include <memory>
#include <optional>
#include <vector>
// ---
#include "async-som.h"
#include "common.h"
#include "dataset-features.h"
#include "eval-server-client.h"
#include "logger.h"
#include "search-context.h"
 
namespace sh {
class UserContext {
public:
    UserContext() = delete;
    UserContext(const Settings& settings, const std::string& username, const DatasetFrames* p_dataset_frames,
                const PrimaryFrameFeatures* p_dataset_features);
 
    const std::string& get_username() const { return _username; };
    const DatasetFrames* get_frames() const { return _p_dataset_frames; };
    const PrimaryFrameFeatures* get_features() const { return _p_dataset_features; };
 
    void reset() {
        // Reset SearchContext
        ctx.reset();
        // Make sure we're not pushing in any old screenshot
        ctx.screenshot_fpth = "";
        ctx.ID = 0;  //< This value means NULL state after the reset
 
        // Reset bookmarks
        _bookmarks.clear();
 
        _history.clear();
        //_history.emplace_back(ctx);
 
        _videos_seen.clear();
    }
 
    // ---
    bool operator==(const UserContext& other) const;
 
public:  //< This is temporary, until we support multiple users
    const DatasetFrames* _p_dataset_frames;
    const PrimaryFrameFeatures* _p_dataset_features;
 
    // *** SEARCH CONTEXT ***
    SearchContext ctx;
 
    // *** USER SPECIFIC ***
    std::string _username;
    std::string _user_eval_server_token;  //< For remote auth
    std::vector<SearchContext> _history;
 
    EvalServerClient _eval_server;
 
    Logger _logger;
 
    AsyncSom _async_SOM;
    std::vector<std::unique_ptr<AsyncSom>> _temp_async_SOM;
 
    BookmarksCont _bookmarks;
    bool _force_result_log;
 
    ScreenVideosCont _videos_seen;
};
 
struct GetDisplayResult {
    FramePointerRange _dataset_frames;
    const LikesCont& likes;
    const LikesCont& _bookmarks;
    const ScreenVideosCont& _videos_seen;
};
 
struct RescoreResult {
    size_t curr_ctx_ID;
    const std::vector<SearchContext>& _history;
    const std::vector<VideoFrame> targets;
    size_t target_pos;
};
 
};  // namespace sh
 
#endif  // USER_CONTEXT_H_