path: root/src/tangara/lua/lua_database.cpp

/*
 * Copyright 2023 jacqueline <me@jacqueline.id.au>
 *
 * SPDX-License-Identifier: GPL-3.0-only
 */

#include "lua/lua_database.hpp"

#include <memory>
#include <string>
#include <type_traits>
#include <variant>

#include "lua.hpp"
#include "lua/bridge.hpp"

#include "esp_log.h"
#include "lauxlib.h"
#include "lua.h"
#include "lua/lua_thread.hpp"
#include "lvgl.h"

#include "database/database.hpp"
#include "database/index.hpp"
#include "database/records.hpp"
#include "database/track.hpp"
#include "events/event_queue.hpp"
#include "lua/property.hpp"
#include "system_fsm/service_locator.hpp"
#include "ui/ui_events.hpp"

namespace lua {

[[maybe_unused]] static constexpr char kTag[] = "lua_db";

static constexpr char kDbIndexMetatable[] = "db_index";
static constexpr char kDbRecordMetatable[] = "db_record";
static constexpr char kDbIteratorMetatable[] = "db_iterator";

struct LuaIndexInfo {
  database::IndexId id;
  database::MediaType type;
  size_t name_size;
  char name_data[];

  auto name() -> std::string_view { return {name_data, name_size}; }
};

static_assert(std::is_trivially_destructible<LuaIndexInfo>());
static_assert(std::is_trivially_copy_assignable<LuaIndexInfo>());

static auto indexes(lua_State* state) -> int {
  Bridge* instance = Bridge::Get(state);

  lua_newtable(state);

  auto db = instance->services().database().lock();
  if (!db) {
    return 1;
  }

  for (const auto& i : db->getIndexes()) {
    LuaIndexInfo* data = reinterpret_cast<LuaIndexInfo*>(
        lua_newuserdata(state, sizeof(LuaIndexInfo) + i.name.size()));
    luaL_setmetatable(state, kDbIndexMetatable);
    *data = LuaIndexInfo{
        .id = i.id,
        .type = i.type,
        .name_size = i.name.size(),
    };
    std::memcpy(data->name_data, i.name.data(), i.name.size());
    lua_rawseti(state, -2, i.id);
  }

  return 1;
}

auto pushTagValue(lua_State* L, const database::TagValue& val) -> void {
  std::visit(
      [&](auto&& arg) {
        using T = std::decay_t<decltype(arg)>;
        if constexpr (std::is_same_v<T, std::pmr::string>) {
          lua_pushlstring(L, arg.data(), arg.size());
        } else if constexpr (std::is_same_v<
                                 T, std::span<const std::pmr::string>>) {
          lua_createtable(L, 0, arg.size());
          for (const auto& i : arg) {
            lua_pushlstring(L, i.data(), i.size());
            lua_pushboolean(L, true);
            lua_rawset(L, -3);
          }
        } else if constexpr (std::is_same_v<T, uint32_t>) {
          lua_pushinteger(L, arg);
        } else {
          lua_pushnil(L);
        }
      },
      val);
}

static void pushTrack(lua_State* L, const database::Track& track) {
  lua_newtable(L);

  lua_pushliteral(L, "tags");
  lua_newtable(L);
  for (const auto& tag : track.tags().allPresent()) {
    lua_pushstring(L, database::tagName(tag).c_str());
    pushTagValue(L, track.tags().get(tag));
    lua_settable(L, -3);
  }
  lua_settable(L, -3);

  lua_pushliteral(L, "id");
  lua_pushinteger(L, track.data().id);
  lua_settable(L, -3);

  lua_pushliteral(L, "filepath");
  lua_pushstring(L, track.data().filepath.c_str());
  lua_settable(L, -3);

  lua_pushliteral(L, "saved_position");
  lua_pushinteger(L, track.data().last_position);
  lua_settable(L, -3);

  lua_pushliteral(L, "play_count");
  lua_pushinteger(L, track.data().play_count);
  lua_settable(L, -3);
}

static auto version(lua_State* L) -> int {
  Bridge* instance = Bridge::Get(L);
  auto db = instance->services().database().lock();
  if (!db) {
    return 0;
  }
  auto res = db->schemaVersion();
  lua_pushlstring(L, res.data(), res.size());
  return 1;
}

static auto size(lua_State* L) -> int {
  Bridge* instance = Bridge::Get(L);
  auto db = instance->services().database().lock();
  if (!db) {
    return 0;
  }
  lua_pushinteger(L, db->sizeOnDiskBytes());
  return 1;
}

static auto recreate(lua_State* L) -> int {
  ESP_LOGI(kTag, "recreate");
  return 0;
}

static auto update(lua_State* L) -> int {
  Bridge* instance = Bridge::Get(L);
  auto db = instance->services().database().lock();
  if (!db) {
    return 0;
  }

  instance->services().bg_worker().Dispatch<void>(
      [=]() { db->updateIndexes(); });
  return 0;
}

static auto track_by_id(lua_State* L) -> int {
  auto id = luaL_checkinteger(L, -1);

  Bridge* instance = Bridge::Get(L);
  auto db = instance->services().database().lock();
  if (!db) {
    return 0;
  }

  auto track = db->getTrack(id);
  if (!track) {
    return 0;
  }

  pushTrack(L, *track);

  return 1;
}

static const struct luaL_Reg kDatabaseFuncs[] = {
    {"indexes", indexes}, {"version", version},
    {"size", size},       {"recreate", recreate},
    {"update", update},   {"track_by_id", track_by_id},
    {NULL, NULL}};

static auto push_lua_record(lua_State* state,
                            const database::Record& r) -> void {
  database::Record** data = reinterpret_cast<database::Record**>(
      lua_newuserdata(state, sizeof(uintptr_t)));
  *data = new database::Record(r);
  luaL_setmetatable(state, kDbRecordMetatable);
}

auto db_check_record(lua_State* L, int stack_pos) -> database::Record* {
  database::Record* rec = *reinterpret_cast<database::Record**>(
      luaL_checkudata(L, stack_pos, kDbRecordMetatable));
  return rec;
}

static auto db_record_gc(lua_State* state) -> int {
  database::Record* rec = db_check_record(state, 1);
  delete rec;
  return 0;
}

auto db_check_iterator(lua_State* L, int stack_pos) -> database::Iterator* {
  database::Iterator* it = *reinterpret_cast<database::Iterator**>(
      luaL_checkudata(L, stack_pos, kDbIteratorMetatable));
  return it;
}

static auto push_iterator(lua_State* state,
                          const database::Iterator& it) -> void {
  database::Iterator** data = reinterpret_cast<database::Iterator**>(
      lua_newuserdata(state, sizeof(uintptr_t)));
  *data = new database::Iterator(it);
  luaL_setmetatable(state, kDbIteratorMetatable);
}

static auto db_iterate_prev(lua_State* state) -> int {
  database::Iterator* it = db_check_iterator(state, 1);
  std::optional<database::Record> res = --(*it);

  if (res) {
    push_lua_record(state, *res);
  } else {
    lua_pushnil(state);
  }

  return 1;
}

static auto db_iterate(lua_State* state) -> int {
  database::Iterator* it = db_check_iterator(state, 1);
  std::optional<database::Record> res = ++(*it);

  if (res) {
    push_lua_record(state, *res);
  } else {
    lua_pushnil(state);
  }

  return 1;
}

static auto db_iterator_value(lua_State* state) -> int {
  database::Iterator* it = db_check_iterator(state, 1);
  std::optional<database::Record> res = it->value();

  if (res) {
    push_lua_record(state, *res);
  } else {
    lua_pushnil(state);
  }

  return 1;
}

static auto db_iterator_clone(lua_State* state) -> int {
  database::Iterator* it = db_check_iterator(state, 1);
  push_iterator(state, *it);
  return 1;
}

static auto db_iterator_gc(lua_State* state) -> int {
  database::Iterator* it = db_check_iterator(state, 1);
  delete it;
  return 0;
}

static const struct luaL_Reg kDbIteratorFuncs[] = {
    {"next", db_iterate},         {"prev", db_iterate_prev},
    {"clone", db_iterator_clone}, {"__call", db_iterate},
    {"__gc", db_iterator_gc},     {"value", db_iterator_value},
    {NULL, NULL}};

static auto record_text(lua_State* state) -> int {
  database::Record* rec = db_check_record(state, 1);
  lua_pushlstring(state, rec->text().data(), rec->text().size());
  return 1;
}

static auto record_contents(lua_State* state) -> int {
  database::Record* rec = db_check_record(state, 1);

  std::visit(
      [&](auto&& arg) {
        using T = std::decay_t<decltype(arg)>;
        if constexpr (std::is_same_v<T, database::TrackId>) {
          lua_pushinteger(state, arg);
        } else if constexpr (std::is_same_v<T, database::IndexKey::Header>) {
          Bridge* bridge = Bridge::Get(state);
          auto db = bridge->services().database().lock();
          if (!db) {
            lua_pushnil(state);
          } else {
            push_iterator(state, database::Iterator{db, arg});
          }
        }
      },
      rec->contents());

  return 1;
}

static const struct luaL_Reg kDbRecordFuncs[] = {{"title", record_text},
                                                 {"contents", record_contents},
                                                 {"__tostring", record_text},
                                                 {"__gc", db_record_gc},
                                                 {NULL, NULL}};

static auto index_name(lua_State* state) -> int {
  LuaIndexInfo* data = reinterpret_cast<LuaIndexInfo*>(
      luaL_checkudata(state, 1, kDbIndexMetatable));
  if (data == NULL) {
    return 0;
  }
  lua_pushlstring(state, data->name_data, data->name_size);
  return 1;
}

static auto index_id(lua_State* state) -> int {
  LuaIndexInfo* data = reinterpret_cast<LuaIndexInfo*>(
      luaL_checkudata(state, 1, kDbIndexMetatable));
  if (data == NULL) {
    return 0;
  }
  lua_pushinteger(state, static_cast<int>(data->id));
  return 1;
}

static auto index_type(lua_State* state) -> int {
  LuaIndexInfo* data = reinterpret_cast<LuaIndexInfo*>(
      luaL_checkudata(state, 1, kDbIndexMetatable));
  if (data == NULL) {
    return 0;
  }
  lua_pushinteger(state, static_cast<int>(data->type));
  return 1;
}

static auto index_iter(lua_State* state) -> int {
  LuaIndexInfo* data = reinterpret_cast<LuaIndexInfo*>(
      luaL_checkudata(state, 1, kDbIndexMetatable));
  if (data == NULL) {
    return 0;
  }
  Bridge* bridge = Bridge::Get(state);
  auto db = bridge->services().database().lock();
  if (!db) {
    lua_pushnil(state);
  }
  push_iterator(state, database::Iterator{db, data->id});
  return 1;
}

static const struct luaL_Reg kDbIndexFuncs[] = {
    {"name", index_name}, {"id", index_id},           {"type", index_type},
    {"iter", index_iter}, {"__tostring", index_name}, {NULL, NULL},
};

static auto lua_database(lua_State* state) -> int {
  // Metatable for indexes
  luaL_newmetatable(state, kDbIndexMetatable);

  lua_pushliteral(state, "__index");
  lua_pushvalue(state, -2);
  lua_settable(state, -3);  // metatable.__index = metatable

  // Add member funcs to the metatable.
  luaL_setfuncs(state, kDbIndexFuncs, 0);

  luaL_newmetatable(state, kDbIteratorMetatable);
  lua_pushliteral(state, "__index");
  lua_pushvalue(state, -2);
  lua_settable(state, -3);  // metatable.__index = metatable
  luaL_setfuncs(state, kDbIteratorFuncs, 0);

  luaL_newmetatable(state, kDbRecordMetatable);
  lua_pushliteral(state, "__index");
  lua_pushvalue(state, -2);
  lua_settable(state, -3);  // metatable.__index = metatable
  luaL_setfuncs(state, kDbRecordFuncs, 0);

  luaL_newlib(state, kDatabaseFuncs);

  lua_pushliteral(state, "MediaTypes");
  lua_newtable(state);
  lua_pushliteral(state, "Unknown");
  lua_pushinteger(state, (int)database::MediaType::kUnknown);
  lua_rawset(state, -3);
  lua_pushliteral(state, "Music");
  lua_pushinteger(state, (int)database::MediaType::kMusic);
  lua_rawset(state, -3);
  lua_pushliteral(state, "Podcast");
  lua_pushinteger(state, (int)database::MediaType::kPodcast);
  lua_rawset(state, -3);
  lua_pushliteral(state, "Audiobook");
  lua_pushinteger(state, (int)database::MediaType::kAudiobook);
  lua_rawset(state, -3);
  lua_rawset(state, -3);

  lua_pushliteral(state, "IndexTypes");
  lua_newtable(state);
  lua_pushliteral(state, "ALBUMS_BY_ARTIST");
  lua_pushinteger(state, (int)database::kAlbumsByArtist.id);
  lua_rawset(state, -3);
  lua_pushliteral(state, "TRACKS_BY_GENRE");
  lua_pushinteger(state, (int)database::kTracksByGenre.id);
  lua_rawset(state, -3);
  lua_pushliteral(state, "ALL_TRACKS");
  lua_pushinteger(state, (int)database::kAllTracks.id);
  lua_rawset(state, -3);
  lua_pushliteral(state, "ALL_ALBUMS");
  lua_pushinteger(state, (int)database::kAllAlbums.id);
  lua_rawset(state, -3);
  lua_pushliteral(state, "ALL_ARTISTS");
  lua_pushinteger(state, (int)database::kAllArtists.id);
  lua_rawset(state, -3);
  lua_pushliteral(state, "PODCASTS");
  lua_pushinteger(state, (int)database::kPodcasts.id);
  lua_rawset(state, -3);
  lua_pushliteral(state, "AUDIOBOOKS");
  lua_pushinteger(state, (int)database::kAudiobooks.id);
  lua_rawset(state, -3);
  lua_rawset(state, -3);

  return 1;
}

auto RegisterDatabaseModule(lua_State* s) -> void {
  luaL_requiref(s, "database", lua_database, true);
  lua_pop(s, 1);
}

}  // namespace lua