Mango/src/library/title.cr

require "digest"
require "../archive"

class Title
  include YAML::Serializable

  getter dir : String, parent_id : String, title_ids : Array(String),
    entries : Array(Entry), title : String, id : String,
    encoded_title : String, mtime : Time, signature : UInt64,
    entry_cover_url_cache : Hash(String, String)?
  setter entry_cover_url_cache : Hash(String, String)?,
    entry_sort_title_cache : Hash(String, String | Nil)?

  @[YAML::Field(ignore: true)]
  @sort_title : String?
  @[YAML::Field(ignore: true)]
  @entry_sort_title_cache : Hash(String, String | Nil)?
  @[YAML::Field(ignore: true)]
  @entry_display_name_cache : Hash(String, String)?
  @[YAML::Field(ignore: true)]
  @entry_cover_url_cache : Hash(String, String)?
  @[YAML::Field(ignore: true)]
  @cached_display_name : String?
  @[YAML::Field(ignore: true)]
  @cached_cover_url : String?

  def initialize(@dir : String, @parent_id, cache = {} of String => String)
    storage = Storage.default
    @signature = Dir.signature dir
    id = storage.get_title_id dir, signature
    if id.nil?
      id = random_str
      storage.insert_title_id({
        path:      dir,
        id:        id,
        signature: signature.to_s,
      })
    end
    @id = id
    @contents_signature = Dir.contents_signature dir, cache
    @title = File.basename dir
    @encoded_title = URI.encode @title
    @title_ids = [] of String
    @entries = [] of Entry
    @mtime = File.info(dir).modification_time

    Dir.entries(dir).each do |fn|
      next if fn.starts_with? "."
      path = File.join dir, fn
      if File.directory? path
        title = Title.new path, @id, cache
        unless title.entries.size == 0 && title.titles.size == 0
          Library.default.title_hash[title.id] = title
          @title_ids << title.id
        end
        if DirectoryEntry.validate_directory_entry path
          entry = DirectoryEntry.new path, self
          @entries << entry if entry.pages > 0 || entry.err_msg
        end
        next
      end
      if is_supported_file path
        entry = ZippedEntry.new path, self
        @entries << entry if entry.pages > 0 || entry.err_msg
      end
    end

    mtimes = [@mtime]
    mtimes += @title_ids.map { |e| Library.default.title_hash[e].mtime }
    mtimes += @entries.map &.mtime
    @mtime = mtimes.max

    @title_ids.sort! do |a, b|
      compare_numerically Library.default.title_hash[a].title,
        Library.default.title_hash[b].title
    end
    sorter = ChapterSorter.new @entries.map &.title
    @entries.sort! do |a, b|
      sorter.compare a.sort_title, b.sort_title
    end
  end

  # Utility method used in library rescanning.
  # - When the title does not exist on the file system anymore, return false
  #     and let it be deleted from the library instance
  # - When the title exists, but its contents signature is now different from
  #     the cache, it means some of its content (nested titles or entries)
  #     has been added, deleted, or renamed. In this case we update its
  #     contents signature and instance variables
  # - When the title exists and its contents signature is still the same, we
  #     return true so it can be reused without rescanning
  def examine(context : ExamineContext) : Bool
    return false unless Dir.exists? @dir
    contents_signature = Dir.contents_signature @dir,
      context["cached_contents_signature"]
    return true if @contents_signature == contents_signature

    @contents_signature = contents_signature
    @signature = Dir.signature @dir
    storage = Storage.default
    id = storage.get_title_id dir, signature
    if id.nil?
      id = random_str
      storage.insert_title_id({
        path:      dir,
        id:        id,
        signature: signature.to_s,
      })
    end
    @id = id
    @mtime = File.info(@dir).modification_time

    previous_titles_size = @title_ids.size
    @title_ids.select! do |title_id|
      title = Library.default.get_title title_id
      unless title # for if data consistency broken
        context["deleted_title_ids"].concat [title_id]
        next false
      end
      existence = title.examine context
      unless existence
        context["deleted_title_ids"].concat [title_id] +
                                            title.deep_titles.map &.id
        context["deleted_entry_ids"].concat title.deep_entries.map &.id
      end
      existence
    end
    remained_title_dirs = @title_ids.map do |title_id|
      title = Library.default.get_title! title_id
      title.dir
    end

    previous_entries_size = @entries.size
    @entries.select! do |entry|
      existence = entry.examine
      Fiber.yield
      context["deleted_entry_ids"] << entry.id unless existence
      existence
    end
    remained_entry_paths = @entries.map &.path

    is_titles_added = false
    is_entries_added = false
    Dir.entries(dir).each do |fn|
      next if fn.starts_with? "."
      path = File.join dir, fn
      if File.directory? path
        unless remained_entry_paths.includes? path
          if DirectoryEntry.validate_directory_entry path
            entry = DirectoryEntry.new path, self
            if entry.pages > 0 || entry.err_msg
              @entries << entry
              is_entries_added = true
              context["deleted_entry_ids"].select! do |deleted_entry_id|
                entry.id != deleted_entry_id
              end
            end
          end
        end

        next if remained_title_dirs.includes? path
        title = Title.new path, @id, context["cached_contents_signature"]
        unless title.entries.size == 0 && title.titles.size == 0
          Library.default.title_hash[title.id] = title
          @title_ids << title.id
          is_titles_added = true

          # We think they are removed, but they are here!
          # Cancel reserved jobs
          revival_title_ids = [title.id] + title.deep_titles.map &.id
          context["deleted_title_ids"].select! do |deleted_title_id|
            !(revival_title_ids.includes? deleted_title_id)
          end
          revival_entry_ids = title.deep_entries.map &.id
          context["deleted_entry_ids"].select! do |deleted_entry_id|
            !(revival_entry_ids.includes? deleted_entry_id)
          end
        end

        next
      end
      if is_supported_file path
        next if remained_entry_paths.includes? path
        entry = ZippedEntry.new path, self
        if entry.pages > 0 || entry.err_msg
          @entries << entry
          is_entries_added = true
          context["deleted_entry_ids"].select! do |deleted_entry_id|
            entry.id != deleted_entry_id
          end
        end
      end
    end

    mtimes = [@mtime]
    mtimes += @title_ids.map { |e| Library.default.title_hash[e].mtime }
    mtimes += @entries.map &.mtime
    @mtime = mtimes.max

    if is_titles_added || previous_titles_size != @title_ids.size
      @title_ids.sort! do |a, b|
        compare_numerically Library.default.title_hash[a].title,
          Library.default.title_hash[b].title
      end
    end
    if is_entries_added || previous_entries_size != @entries.size
      sorter = ChapterSorter.new @entries.map &.sort_title
      @entries.sort! do |a, b|
        sorter.compare a.sort_title, b.sort_title
      end
    end

    if @title_ids.size > 0 || @entries.size > 0
      true
    else
      context["deleted_title_ids"].concat [@id]
      false
    end
  end

  alias SortContext = NamedTuple(username: String, opt: SortOptions)

  def build_json(*, slim = false, depth = -1,
                 sort_context : SortContext? = nil,
                 percentage = false)
    _titles = if sort_context
                sorted_titles sort_context[:username],
                  sort_context[:opt]
              else
                self.titles
              end
    _entries = if sort_context
                 sorted_entries sort_context[:username],
                   sort_context[:opt]
               else
                 @entries
               end

    JSON.build do |json|
      json.object do
        {% for str in ["dir", "title", "id"] %}
        json.field {{str}}, @{{str.id}}
      {% end %}
        json.field "signature" { json.number @signature }
        json.field "sort_title", sort_title
        unless slim
          json.field "display_name", display_name
          json.field "cover_url", cover_url
          json.field "mtime" { json.number @mtime.to_unix }
        end
        unless depth == 0
          json.field "titles" do
            json.array do
              _titles.each do |title|
                json.raw title.build_json(slim: slim,
                  depth: depth > 0 ? depth - 1 : depth,
                  sort_context: sort_context, percentage: percentage)
              end
            end
          end
          json.field "entries" do
            json.array do
              _entries.each do |entry|
                json.raw entry.build_json(slim: slim)
              end
            end
          end
          if percentage && sort_context
            json.field "title_percentages" do
              json.array do
                _titles.each do |t|
                  json.number t.load_percentage sort_context[:username]
                end
              end
            end
            json.field "entry_percentages" do
              json.array do
                load_percentage_for_all_entries(
                  sort_context[:username],
                  sort_context[:opt]
                ).each do |p|
                  json.number p.nan? ? 0 : p
                end
              end
            end
          end
        end
        json.field "parents" do
          json.array do
            self.parents.each do |title|
              json.object do
                json.field "title", title.title
                json.field "id", title.id
              end
            end
          end
        end
      end
    end
  end

  def titles
    @title_ids.map { |tid| Library.default.get_title! tid }
  end

  def sorted_titles(username, opt : SortOptions? = nil)
    if opt.nil?
      opt = SortOptions.from_info_json @dir, username
    end

    # Helper function from src/util/util.cr
    sort_titles titles, opt.not_nil!, username
  end

  # Get all entries, including entries in nested titles
  def deep_entries
    return @entries if title_ids.empty?
    @entries + titles.flat_map &.deep_entries
  end

  def deep_titles
    return [] of Title if titles.empty?
    titles + titles.flat_map &.deep_titles
  end

  def parents
    ary = [] of Title
    tid = @parent_id
    while !tid.empty?
      title = Library.default.get_title! tid
      ary << title
      tid = title.parent_id
    end
    ary.reverse
  end

  # Returns a string the describes the content of the title
  #   e.g., - 3 titles and 1 entry
  #         - 4 entries
  #         - 1 title
  def content_label
    ary = [] of String
    tsize = titles.size
    esize = entries.size

    ary << "#{tsize} #{tsize > 1 ? "titles" : "title"}" if tsize > 0
    ary << "#{esize} #{esize > 1 ? "entries" : "entry"}" if esize > 0
    ary.join " and "
  end

  def sort_title
    sort_title_cached = @sort_title
    return sort_title_cached if sort_title_cached
    sort_title = Storage.default.get_title_sort_title id
    if sort_title
      @sort_title = sort_title
      return sort_title
    end
    @sort_title = @title
    @title
  end

  def set_sort_title(sort_title : String | Nil, username : String)
    Storage.default.set_title_sort_title id, sort_title
    if sort_title == "" || sort_title.nil?
      @sort_title = nil
    else
      @sort_title = sort_title
    end

    if parents.size > 0
      target = parents[-1].titles
    else
      target = Library.default.titles
    end
    remove_sorted_titles_cache target,
      [SortMethod::Auto, SortMethod::Title], username
  end

  def sort_title_db
    Storage.default.get_title_sort_title id
  end

  def entry_sort_title_db(entry_id)
    unless @entry_sort_title_cache
      @entry_sort_title_cache =
        Storage.default.get_entries_sort_title @entries.map &.id
    end

    @entry_sort_title_cache.not_nil![entry_id]?
  end

  def tags
    Storage.default.get_title_tags @id
  end

  def add_tag(tag)
    Storage.default.add_tag @id, tag
  end

  def delete_tag(tag)
    Storage.default.delete_tag @id, tag
  end

  def get_entry(eid)
    @entries.find &.id.== eid
  end

  def display_name
    cached_display_name = @cached_display_name
    return cached_display_name unless cached_display_name.nil?

    dn = @title
    TitleInfo.new @dir do |info|
      info_dn = info.display_name
      dn = info_dn unless info_dn.empty?
    end
    @cached_display_name = dn
    dn
  end

  def encoded_display_name
    URI.encode display_name
  end

  def display_name(entry_name)
    unless @entry_display_name_cache
      TitleInfo.new @dir do |info|
        @entry_display_name_cache = info.entry_display_name
      end
    end

    dn = entry_name
    info_dn = @entry_display_name_cache.not_nil![entry_name]?
    unless info_dn.nil? || info_dn.empty?
      dn = info_dn
    end
    dn
  end

  def set_display_name(dn)
    @cached_display_name = dn
    TitleInfo.new @dir do |info|
      info.display_name = dn
      info.save
    end
  end

  def set_display_name(entry_name : String, dn)
    TitleInfo.new @dir do |info|
      info.entry_display_name[entry_name] = dn
      @entry_display_name_cache = info.entry_display_name
      info.save
    end
  end

  def cover_url
    cached_cover_url = @cached_cover_url
    return cached_cover_url unless cached_cover_url.nil?

    url = "#{Config.current.base_url}img/icons/icon_x192.png"
    readable_entries = @entries.select &.err_msg.nil?
    if readable_entries.size > 0
      url = readable_entries[0].cover_url
    end
    TitleInfo.new @dir do |info|
      info_url = info.cover_url
      unless info_url.nil? || info_url.empty?
        url = File.join Config.current.base_url, info_url
      end
    end
    @cached_cover_url = url
    url
  end

  def set_cover_url(url : String)
    @cached_cover_url = url
    TitleInfo.new @dir do |info|
      info.cover_url = url
      info.save
    end
  end

  def set_cover_url(entry_name : String, url : String)
    TitleInfo.new @dir do |info|
      info.entry_cover_url[entry_name] = url
      @entry_cover_url_cache = info.entry_cover_url
      info.save
    end
  end

  # Set the reading progress of all entries and nested libraries to 100%
  def read_all(username)
    @entries.each do |e|
      e.save_progress username, e.pages
    end
    titles.each &.read_all username
  end

  # Set the reading progress of all entries and nested libraries to 0%
  def unread_all(username)
    @entries.each &.save_progress(username, 0)
    titles.each &.unread_all username
  end

  def deep_read_page_count(username) : Int32
    key = "#{@id}:#{username}:progress_sum"
    sig = Digest::SHA1.hexdigest (entries.map &.id).to_s
    cached_sum = LRUCache.get key
    return cached_sum[1] if cached_sum.is_a? Tuple(String, Int32) &&
                            cached_sum[0] == sig
    sum = load_progress_for_all_entries(username, nil, true).sum +
          titles.flat_map(&.deep_read_page_count username).sum
    LRUCache.set generate_cache_entry key, {sig, sum}
    sum
  end

  def deep_total_page_count : Int32
    entries.sum(&.pages) +
      titles.flat_map(&.deep_total_page_count).sum
  end

  def load_percentage(username)
    deep_read_page_count(username) / deep_total_page_count
  end

  def load_progress_for_all_entries(username, opt : SortOptions? = nil,
                                    unsorted = false)
    progress = {} of String => Int32
    TitleInfo.new @dir do |info|
      progress = info.progress[username]?
    end

    if unsorted
      ary = @entries
    else
      ary = sorted_entries username, opt
    end

    ary.map do |e|
      info_progress = 0
      if progress && progress.has_key? e.title
        info_progress = [progress[e.title], e.pages].min
      end
      info_progress
    end
  end

  def load_percentage_for_all_entries(username, opt : SortOptions? = nil,
                                      unsorted = false)
    if unsorted
      ary = @entries
    else
      ary = sorted_entries username, opt
    end

    progress = load_progress_for_all_entries username, opt, unsorted
    ary.map_with_index do |e, i|
      progress[i] / e.pages
    end
  end

  # Returns the sorted entries array
  #
  # When `opt` is nil, it uses the preferred sorting options in info.json, or
  #   use the default (auto, ascending)
  # When `opt` is not nil, it saves the options to info.json
  def sorted_entries(username, opt : SortOptions? = nil)
    cache_key = SortedEntriesCacheEntry.gen_key @id, username, @entries, opt
    cached_entries = LRUCache.get cache_key
    return cached_entries if cached_entries.is_a? Array(Entry)

    if opt.nil?
      opt = SortOptions.from_info_json @dir, username
    end

    case opt.not_nil!.method
    when .title?
      ary = @entries.sort do |a, b|
        compare_numerically a.sort_title, b.sort_title
      end
    when .time_modified?
      ary = @entries.sort { |a, b| (a.mtime <=> b.mtime).or \
        compare_numerically a.sort_title, b.sort_title }
    when .time_added?
      ary = @entries.sort { |a, b| (a.date_added <=> b.date_added).or \
        compare_numerically a.sort_title, b.sort_title }
    when .progress?
      percentage_ary = load_percentage_for_all_entries username, opt, true
      ary = @entries.zip(percentage_ary)
        .sort { |a_tp, b_tp| (a_tp[1] <=> b_tp[1]).or \
          compare_numerically a_tp[0].sort_title, b_tp[0].sort_title }
        .map &.[0]
    else
      unless opt.method.auto?
        Logger.warn "Unknown sorting method #{opt.not_nil!.method}. Using " \
                    "Auto instead"
      end
      sorter = ChapterSorter.new @entries.map &.sort_title
      ary = @entries.sort do |a, b|
        sorter.compare(a.sort_title, b.sort_title).or \
          compare_numerically a.sort_title, b.sort_title
      end
    end

    ary.reverse! unless opt.not_nil!.ascend

    LRUCache.set generate_cache_entry cache_key, ary
    ary
  end

  # === helper methods ===

  # Gets the last read entry in the title. If the entry has been completed,
  #   returns the next entry. Returns nil when no entry has been read yet,
  #   or when all entries are completed
  def get_last_read_entry(username) : Entry?
    progress = {} of String => Int32
    TitleInfo.new @dir do |info|
      progress = info.progress[username]?
    end
    return if progress.nil?

    last_read_entry = nil

    sorted_entries(username).reverse_each do |e|
      if progress.has_key?(e.title) && progress[e.title] > 0
        last_read_entry = e
        break
      end
    end

    if last_read_entry && last_read_entry.finished? username
      last_read_entry = last_read_entry.next_entry username
    end

    last_read_entry
  end

  # Equivalent to `@entries.map &. date_added`, but much more efficient
  def get_date_added_for_all_entries
    da = {} of String => Time
    TitleInfo.new @dir do |info|
      da = info.date_added
    end

    @entries.each do |e|
      next if da.has_key? e.title
      da[e.title] = ctime e.path
    end

    TitleInfo.new @dir do |info|
      info.date_added = da
      info.save
    end

    @entries.map { |e| da[e.title] }
  end

  def deep_entries_with_date_added
    da_ary = get_date_added_for_all_entries
    zip = @entries.map_with_index do |e, i|
      {entry: e, date_added: da_ary[i]}
    end
    return zip if title_ids.empty?
    zip + titles.flat_map &.deep_entries_with_date_added
  end

  def remove_sorted_entries_cache(sort_methods : Array(SortMethod),
                                  username : String)
    [false, true].each do |ascend|
      sort_methods.each do |sort_method|
        sorted_entries_cache_key =
          SortedEntriesCacheEntry.gen_key @id, username, @entries,
            SortOptions.new(sort_method, ascend)
        LRUCache.invalidate sorted_entries_cache_key
      end
    end
  end

  def remove_sorted_caches(sort_methods : Array(SortMethod), username : String)
    remove_sorted_entries_cache sort_methods, username
    parents.each do |parent|
      remove_sorted_titles_cache parent.titles, sort_methods, username
    end
    remove_sorted_titles_cache Library.default.titles, sort_methods, username
  end

  def bulk_progress(action, ids : Array(String), username)
    LRUCache.invalidate "#{@id}:#{username}:progress_sum"
    parents.each do |parent|
      LRUCache.invalidate "#{parent.id}:#{username}:progress_sum"
    end
    remove_sorted_caches [SortMethod::Progress], username

    selected_entries = ids
      .map { |id|
        @entries.find &.id.==(id)
      }
      .select(Entry)

    TitleInfo.new @dir do |info|
      selected_entries.each do |e|
        page = action == "read" ? e.pages : 0
        if info.progress[username]?.nil?
          info.progress[username] = {e.title => page}
        else
          info.progress[username][e.title] = page
        end
      end
      info.save
    end
  end
end