Add a bsplayer module to get subtitles

app/polochon_modules.go

@@ -4,6 +4,7 @@ import (
 	// Modules
 	_ "github.com/odwrtw/polochon/modules/addicted"
 	_ "github.com/odwrtw/polochon/modules/aria2"
+	_ "github.com/odwrtw/polochon/modules/bsplayer"
 	_ "github.com/odwrtw/polochon/modules/canape"
 	_ "github.com/odwrtw/polochon/modules/eztv"
 	_ "github.com/odwrtw/polochon/modules/fsnotify"

config.example.yml

@@ -140,6 +140,7 @@ movie:
     - mkvinfo
     - yifysubs
     - opensubtitles
+    - bsplayer
 
 modules_params:
     # Required for the transmission client, if the downloader is enabled.

modules/bsplayer/bsplayer.go

@@ -0,0 +1,230 @@
+package bsplayer
+
+import (
+	"bytes"
+	"compress/gzip"
+	"encoding/xml"
+	"fmt"
+	"io"
+	"math/rand"
+	"net/http"
+	"strconv"
+	"strings"
+	"text/template"
+	"time"
+
+	polochon "github.com/odwrtw/polochon/lib"
+)
+
+var (
+	random       *rand.Rand
+	baseURL      = "http://s%d.api.bsplayer-subtitles.com/v1.php"
+	domains      = []int{1, 2, 3, 4, 5, 6, 7, 8, 101, 102, 103, 104, 105, 106, 107, 108, 109}
+	soapTemplate = `<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:ns1="{{.Endpoint}}">
+    <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+        <ns1:{{.Action}}>{{.Params}}</ns1:{{.Action}}>
+    </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+`
+	soap         = template.Must(template.New("soap").Parse(soapTemplate))
+	loginPayload = `
+        <username></username>
+        <password></password>
+        <AppID>BSPlayer v2.72</AppID>
+	`
+)
+
+func init() {
+	random = rand.New(rand.NewSource(time.Now().UnixNano()))
+}
+
+type soapParams struct {
+	Endpoint string
+	Action   string
+	Params   string
+}
+
+type loginResponse struct {
+	Status int    `xml:"Body>logInResponse>return>result"`
+	Token  string `xml:"Body>logInResponse>return>data"`
+}
+
+type subtitle struct {
+	Lang   string `xml:"subLang"`
+	Name   string `xml:"subName"`
+	Format string `xml:"subFormat"`
+	URL    string `xml:"subDownloadLink"`
+	Rating string `xml:"subRating"`
+
+	FileHash string `xml:"movieHash"`
+	FileSize string `xml:"movieSize"`
+	ImdbID   string `xml:"movieIMBDID"`
+}
+
+func (s *subtitle) String() string {
+	var out strings.Builder
+	fmt.Fprintf(&out, "Name:%s\n", s.Name)
+	fmt.Fprintf(&out, "ImdbID:%s\n", s.ImdbID)
+	fmt.Fprintf(&out, "Lang:%s\n", s.Lang)
+	fmt.Fprintf(&out, "Format:%s\n", s.Format)
+	fmt.Fprintf(&out, "Rating:%s\n", s.Rating)
+	fmt.Fprintf(&out, "Hash:%s\n", s.FileHash)
+	fmt.Fprintf(&out, "Size:%s\n", s.FileSize)
+	fmt.Fprintf(&out, "URL:%s\n", s.URL)
+	return out.String()
+}
+
+type searchResponse struct {
+	Status int         `xml:"Body>searchSubtitlesResponse>return>result>result"`
+	Subs   []*subtitle `xml:"Body>searchSubtitlesResponse>return>data>item"`
+}
+
+func getEndpoint() string {
+	domain := domains[random.Intn(len(domains))]
+	return fmt.Sprintf(baseURL, domain)
+}
+
+func query(endpoint, action, payload string) ([]byte, error) {
+	params := &bytes.Buffer{}
+	err := soap.Execute(params, &soapParams{
+		Endpoint: endpoint,
+		Action:   action,
+		Params:   payload,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	req, err := http.NewRequest("POST", endpoint, params)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("User-Agent", "BSPlayer/2.x (1022.12362)")
+	req.Header.Add("Content-Type", "text/xml; charset=utf-8")
+	req.Header.Add("Connection", "close")
+	req.Header.Add("SoapAction", fmt.Sprintf("%s#%s", endpoint, action))
+
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("bsplayer: http response code %d", resp.StatusCode)
+	}
+
+	data, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	return data, nil
+}
+
+func login() (string, string, error) {
+	endpoint := getEndpoint()
+
+	body, err := query(endpoint, "logIn", loginPayload)
+	if err != nil {
+		return "", "", err
+	}
+
+	data := loginResponse{}
+	if err := xml.Unmarshal(body, &data); err != nil {
+		return "", "", err
+	}
+
+	if data.Status != http.StatusOK {
+		return "", "", fmt.Errorf("bsplayer: xml login response code %d", data.Status)
+	}
+
+	if data.Token == "" {
+		return "", "", fmt.Errorf("bsplayer: missing login token")
+	}
+
+	return endpoint, data.Token, nil
+}
+
+type queryParams struct {
+	imdbID string
+	size   string
+	hash   string
+	lang   string
+}
+
+var langs = map[polochon.Language]string{
+	polochon.EN: "eng",
+	polochon.FR: "fre",
+}
+
+func newQuery(imdbID string, lang polochon.Language, file *polochon.File) (*queryParams, error) {
+	if file == nil {
+		return nil, fmt.Errorf("bsplayer: missing file")
+	}
+
+	l, ok := langs[lang]
+	if !ok {
+		return nil, fmt.Errorf("bsplayer: lang %s not handled", lang)
+	}
+
+	hash, err := file.OpensubHash()
+	if err != nil {
+		return nil, err
+	}
+
+	return &queryParams{
+		imdbID: strings.ReplaceAll(imdbID, "tt", ""),
+		hash:   fmt.Sprintf("%016x", hash),
+		size:   strconv.Itoa(int(file.Size)),
+		lang:   l,
+	}, nil
+}
+
+func search(qp *queryParams) ([]*subtitle, error) {
+	endpoint, token, err := login()
+	if err != nil {
+		return nil, err
+	}
+
+	params := strings.Builder{}
+	fmt.Fprintf(&params, "<handle>%s</handle>", token)
+	fmt.Fprintf(&params, "<movieHash>%s</movieHash>", qp.hash)
+	fmt.Fprintf(&params, "<movieSize>%s</movieSize>", qp.size)
+	fmt.Fprintf(&params, "<languageId>%s</languageId>", qp.lang)
+	fmt.Fprintf(&params, "<imdbId>%s</imdbId>", qp.imdbID)
+
+	ret, err := query(endpoint, "searchSubtitles", params.String())
+	if err != nil {
+		return nil, err
+	}
+
+	data := searchResponse{}
+	if err := xml.Unmarshal(ret, &data); err != nil {
+		return nil, err
+	}
+
+	if data.Status != http.StatusOK {
+		return nil, fmt.Errorf("bsplayer: login response code %d", data.Status)
+	}
+
+	return data.Subs, nil
+}
+
+func fetch(url string) (io.ReadCloser, error) {
+	resp, err := http.Get(url)
+	if err != nil {
+		return nil, err
+	}
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("bsplayer: fetch http status: %s", resp.Status)
+	}
+
+	return gzip.NewReader(resp.Body)
+}

modules/bsplayer/module.go

@@ -0,0 +1,111 @@
+package bsplayer
+
+import (
+	"errors"
+	"io"
+	"path/filepath"
+
+	"github.com/agnivade/levenshtein"
+	polochon "github.com/odwrtw/polochon/lib"
+	"github.com/sirupsen/logrus"
+)
+
+const moduleName = "bsplayer"
+
+var _ polochon.Subtitler = (*Client)(nil)
+
+var ErrNotAVideo = errors.New("bsplayer: not a video")
+
+func init() {
+	polochon.RegisterModule(&Client{})
+}
+
+// Client represents the bsplayer API client.
+type Client struct {
+}
+
+// Init implements the polochon.Module interface.
+func (c *Client) Init(_ []byte) error {
+	return nil
+}
+
+// Name implements the polochon.Module interface.
+func (c *Client) Name() string {
+	return moduleName
+}
+
+// Status implements the polochon.Module interface.
+func (c *Client) Status() (polochon.ModuleStatus, error) {
+	qp := &queryParams{
+		imdbID: "133093",
+		size:   "1991716652",
+		hash:   "6513e3c7b21e645c",
+		lang:   "eng",
+	}
+
+	subs, err := search(qp)
+	if err != nil || len(subs) == 0 {
+		return polochon.StatusFail, err
+	}
+
+	return polochon.StatusOK, nil
+}
+
+// GetSubtitle implements the polochon.Subtitler interface.
+func (c *Client) GetSubtitle(i interface{}, lang polochon.Language, _ *logrus.Entry) (*polochon.Subtitle, error) {
+	var qp *queryParams
+	var err error
+
+	switch resource := i.(type) {
+	case *polochon.Movie:
+		qp, err = newQuery(resource.ImdbID, lang, resource.GetFile())
+	case *polochon.ShowEpisode:
+		qp, err = newQuery(resource.ShowImdbID, lang, resource.GetFile())
+	default:
+		return nil, ErrNotAVideo
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	subs, err := search(qp)
+	if err != nil {
+		return nil, err
+	}
+
+	video, ok := i.(polochon.Video)
+	if !ok {
+		return nil, ErrNotAVideo
+	}
+
+	var selected *subtitle
+	minScore := 1000
+
+	release := filepath.Base(video.GetFile().PathWithoutExt())
+	for _, sub := range subs {
+		dist := levenshtein.ComputeDistance(release, sub.Name)
+		if dist < minScore {
+			selected = sub
+			minScore = dist
+		}
+	}
+
+	if selected == nil {
+		return nil, polochon.ErrNoSubtitleFound
+	}
+
+	rc, err := fetch(selected.URL)
+	if err != nil {
+		return nil, err
+	}
+	defer rc.Close()
+
+	s := polochon.NewSubtitleFromVideo(video, lang)
+	s.Data, err = io.ReadAll(rc)
+	if err != nil {
+		return nil, err
+	}
+
+	return s, nil
+}