jellyfin-plugin-danmu/Jellyfin.Plugin.Danmu/Scrapers/AbstractScraper.cs

using System.Collections.Generic;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using Jellyfin.Plugin.Danmu.Configuration;
using Jellyfin.Plugin.Danmu.Scrapers.Entity;
using MediaBrowser.Controller.Entities;
using Microsoft.Extensions.Logging;

namespace Jellyfin.Plugin.Danmu.Scrapers;

public abstract class AbstractScraper
{
    protected ILogger log;

    public virtual int DefaultOrder => 999;

    public virtual bool DefaultEnable => false;

    public abstract string Name { get; }

    /// <summary>
    /// Gets the provider name.
    /// </summary>
    public abstract string ProviderName { get; }

    /// <summary>
    /// Gets the provider id.
    /// </summary>
    public abstract string ProviderId { get; }
    
    /// <summary>
    /// 用于区分不同源的animeId前缀
    /// </summary>
    public abstract uint HashPrefix { get; }

     /// <summary>
     /// 是否已废弃
     /// </summary>
     /// <returns>是否已废弃</returns>
    public virtual bool IsDeprecated => false;

    public PluginConfiguration Config
    {
        get
        {
            return Plugin.Instance?.Configuration ?? new Configuration.PluginConfiguration();
        }
    }


    public AbstractScraper(ILogger log)
    {
        this.log = log;
    }

    /// <summary>
    /// 搜索影片
    /// </summary>
    /// <param name="item">元数据item</param>
    /// <returns>影片列表</returns>
    public abstract Task<List<ScraperSearchInfo>> Search(BaseItem item);

    /// <summary>
    /// 搜索匹配的影片id
    /// </summary>
    /// <param name="item">元数据item</param>
    /// <returns>影片id</returns>
    public abstract Task<string?> SearchMediaId(BaseItem item);

    /// <summary>
    /// 根据文件搜索匹配的影片id
    /// </summary>
    /// <param name="video">影片对象</param>
    /// <returns>影片id</returns>
    public virtual Task<string?> SearchMediaIdByFile(Video video)
    {
        return Task.FromResult<string?>(null);
    }

    /// <summary>
    /// 获取影片信息
    /// </summary>
    /// <param name="item">元数据item</param>
    /// <param name="id">影片id</param>
    /// <returns>影片信息</returns>
    public abstract Task<ScraperMedia?> GetMedia(BaseItem item, string id);

    /// <summary>
    /// 需要更新弹幕时调用
    /// </summary>
    /// <param name="item">元数据item</param>
    /// <param name="id">元数据保存的id</param>
    /// <returns>剧集信息</returns>
    public abstract Task<ScraperEpisode?> GetMediaEpisode(BaseItem item, string id);

    /// <summary>
    /// 获取弹幕
    /// </summary>
    /// <param name="item">元数据item</param>
    /// <param name="commentId">弹幕id</param>
    /// <returns>弹幕内容</returns>
    public abstract Task<ScraperDanmaku?> GetDanmuContent(BaseItem item, string commentId);

    /// <summary>
    /// 搜索影片（用于api）
    /// </summary>
    /// <returns>影片列表</returns>
    public virtual async Task<List<ScraperSearchInfo>> SearchForApi(string keyword)
    {
        return new List<ScraperSearchInfo>();
    }

    /// <summary>
    /// 获取影片剧集数据（用于api）
    /// </summary>
    /// <returns>剧集列表</returns>
    public virtual async Task<List<ScraperEpisode>> GetEpisodesForApi(string id)
    {
        return new List<ScraperEpisode>();
    }

    /// <summary>
    /// 下载弹幕（用于api）
    /// </summary>
    /// <param name="commentId">弹幕id</param>
    /// <returns>弹幕内容</returns>
    public virtual async Task<ScraperDanmaku?> DownloadDanmuForApi(string commentId)
    {
        return null;
    }


    protected virtual string NormalizeSearchName(string name)
    {
        // 去掉可能存在的季名称
        return Regex.Replace(name, @"\s*第.季", "").Trim();
    }
}