├── .gitignore ├── ygg ├── search_test.go ├── download_test.go ├── README.md ├── login.go ├── download.go └── search.go ├── tpb ├── proxy_test.go ├── README.md ├── search_test.go ├── proxy.go └── search.go ├── arc ├── search_test.go ├── README.md ├── download.go └── search.go ├── core ├── core_test.go └── core.go ├── otts ├── README.md ├── search_test.go ├── download.go └── search.go ├── go.mod ├── README.md ├── go.sum ├── torrengo.go └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | torrengo 3 | -------------------------------------------------------------------------------- /ygg/search_test.go: -------------------------------------------------------------------------------- 1 | package ygg 2 | 3 | import ( 4 | "testing" 5 | "time" 6 | ) 7 | 8 | func TestLookup(t *testing.T) { 9 | torrents, _, err := Lookup("Monte cristo", 5*time.Second) 10 | if err != nil { 11 | t.Fatal(err) 12 | } 13 | 14 | if len(torrents) == 0 { 15 | t.Fatal("Not torrent found.") 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /tpb/proxy_test.go: -------------------------------------------------------------------------------- 1 | package tpb 2 | 3 | import ( 4 | "context" 5 | "testing" 6 | ) 7 | 8 | func TestGetProxies(t *testing.T) { 9 | urls, err := getProxies(context.Background()) 10 | if err != nil { 11 | t.Fatal(err) 12 | } 13 | 14 | want := 10 15 | if len(urls) < want { 16 | t.Fatalf("Got %v TPB urls, want at least %v", len(urls), want) 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /arc/search_test.go: -------------------------------------------------------------------------------- 1 | package arc 2 | 3 | import ( 4 | "testing" 5 | "time" 6 | ) 7 | 8 | func TestLookup(t *testing.T) { 9 | torrents, err := Lookup("Monte Cristo", 30*time.Second) 10 | if err != nil { 11 | t.Fatal(err) 12 | } 13 | 14 | if len(torrents) == 0 { 15 | t.Fatal("Found no torrent.") 16 | } 17 | 18 | if torrents[0].Name == "" { 19 | t.Fatal("Torrents have no name.") 20 | } 21 | if torrents[0].DescURL == "" { 22 | t.Fatal("Torrents have no Description URL.") 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /arc/README.md: -------------------------------------------------------------------------------- 1 | # Description of the Archive.org scraping library 2 | 3 | **arc** searches torrents on Archive.org 4 | 5 | See [here the Go documentation](https://godoc.org/github.com/juliensalinas/torrengo/arc) of this library. 6 | 7 | The **Lookup** function searches Archive.org and returns a clean list of torrents. For each torrent the following info is retrieved: 8 | 9 | * name 10 | * description page 11 | 12 | The **FindAndDlFile** function opens a torrent description page, retrieves the torrent file url, and downloads the torrent file. 13 | -------------------------------------------------------------------------------- /core/core_test.go: -------------------------------------------------------------------------------- 1 | package core 2 | 3 | import ( 4 | "context" 5 | "strings" 6 | "testing" 7 | ) 8 | 9 | func TestFetch(t *testing.T) { 10 | // Testing a site that is supposed to use the Cloudflare challenge. 11 | // (Checking your browser before accessing xxx). 12 | html, _, err := Fetch(context.Background(), "https://support.litebit.eu/hc/en-us", nil) 13 | if err != nil { 14 | t.Fatal(err) 15 | } 16 | if strings.Contains(html, "CloudFlare") { 17 | t.Fatal("Website triggered a Cloudflare challenge while it shouldn't have.") 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /otts/README.md: -------------------------------------------------------------------------------- 1 | # Description of the 1337x scraping library 2 | 3 | **otts** searches torrents on 1337x.to 4 | 5 | See [here the Go documentation](https://godoc.org/github.com/juliensalinas/torrengo/otts) of this library. 6 | 7 | The **Lookup** function searches 1337x.to and returns a clean list of torrents. For each torrent the following info is retrieved: 8 | 9 | * name 10 | * description page 11 | * size 12 | * upload date 13 | * number of seeders 14 | * number of leechers 15 | 16 | The **ExtractMag** function opens a torrent description page and retrieves the torrent magnet link. 17 | -------------------------------------------------------------------------------- /ygg/download_test.go: -------------------------------------------------------------------------------- 1 | package ygg 2 | 3 | import ( 4 | "testing" 5 | "time" 6 | ) 7 | 8 | func TestFindAndDlFile(t *testing.T) { 9 | id := "" 10 | pass := "" 11 | 12 | _, client, err := Lookup("Monte Cristo", 10*time.Second) 13 | if err != nil { 14 | t.Fatal(err) 15 | } 16 | 17 | url, err := FindAndDlFile("https://www2.yggtorrent.si/torrent/ebook/audio/297687-alexandre+dumas+-+le+comte+de+monte-cristo+tome+1+2015+mp3+128kbps", 18 | "Monte Cristo", id, pass, 10*time.Second, client) 19 | 20 | if err != nil { 21 | t.Fatal(err) 22 | } 23 | 24 | if url == "" { 25 | t.Fatal("Got an empty url") 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /tpb/README.md: -------------------------------------------------------------------------------- 1 | # Description of the ThePirateBay scraping library 2 | 3 | **tpb** searches torrents on all The Pirate Bay proxies located on https://proxybay.bz 4 | 5 | See [here the Go documentation](https://godoc.org/github.com/juliensalinas/torrengo/tpb) of this library. 6 | 7 | The **Lookup** function retrieves all The Pirate Bay urls located on https://proxybay.bz, launches a search on all thoses urls concurrently, and returns a clean list of torrents from the url that responded first. The returned url is also checked in-depth because some proxies sometimes return a page with no error but the page actually does not have any result. For each torrent the following info is retrieved: 8 | 9 | * name 10 | * magnet link 11 | * size 12 | * upload date 13 | * number of seeders 14 | * number of leechers 15 | -------------------------------------------------------------------------------- /tpb/search_test.go: -------------------------------------------------------------------------------- 1 | package tpb 2 | 3 | import ( 4 | "testing" 5 | "time" 6 | ) 7 | 8 | func TestLookup(t *testing.T) { 9 | torrents, err := Lookup("Monte Cristo", 5*time.Second) 10 | if err != nil { 11 | t.Fatal(err) 12 | } 13 | 14 | if len(torrents) == 0 { 15 | t.Fatal("Found no torrent.") 16 | } 17 | 18 | if torrents[0].Name == "" { 19 | t.Fatal("Torrents have no name.") 20 | } 21 | if torrents[0].Magnet == "" { 22 | t.Fatal("Torrents have no magnet.") 23 | } 24 | if torrents[0].Size == "" { 25 | t.Fatal("Torrents have no size.") 26 | } 27 | if torrents[0].UplDate == "" { 28 | t.Fatal("Torrents have no Upload date.") 29 | } 30 | if torrents[0].Leechers == -1 { 31 | t.Fatal("Torrents have no leachers.") 32 | } 33 | if torrents[0].Seeders == -1 { 34 | t.Fatal("Torrents have no seeders.") 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /otts/search_test.go: -------------------------------------------------------------------------------- 1 | package otts 2 | 3 | import ( 4 | "testing" 5 | "time" 6 | ) 7 | 8 | func TestLookup(t *testing.T) { 9 | torrents, err := Lookup("Monte Cristo", 5*time.Second) 10 | if err != nil { 11 | t.Fatal(err) 12 | } 13 | 14 | if len(torrents) == 0 { 15 | t.Fatal("Found no torrent.") 16 | } 17 | 18 | if torrents[0].Name == "" { 19 | t.Fatal("Torrents have no name.") 20 | } 21 | if torrents[0].DescURL == "" { 22 | t.Fatal("Torrents have no description URL.") 23 | } 24 | if torrents[0].Size == "" { 25 | t.Fatal("Torrents have no size.") 26 | } 27 | if torrents[0].UplDate == "" { 28 | t.Fatal("Torrents have no Upload date.") 29 | } 30 | if torrents[0].Leechers == -1 { 31 | t.Fatal("Torrents have no leachers.") 32 | } 33 | if torrents[0].Seeders == -1 { 34 | t.Fatal("Torrents have no seeders.") 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /ygg/README.md: -------------------------------------------------------------------------------- 1 | # Description of the Ygg Torrent scraping library 2 | 3 | **ygg** searches torrents on yggtorrent 4 | 5 | See [here the Go documentation](https://godoc.org/github.com/juliensalinas/torrengo/ygg) of this library. 6 | 7 | Torrents can be searched freely on Ygg Torrent, but an account is needed to download the torrent file. This library authenticates the user before downloading the torrent file. 8 | 9 | The **Lookup** function searches yggtorrent and returns a clean list of torrents. For each torrent the following info is retrieved: 10 | 11 | * name 12 | * description page 13 | * size 14 | * upload date 15 | * number of seeders 16 | * number of leechers 17 | 18 | The **FindAndDlFile** function takes the Ygg Torrent user id and password, authenticates the user, opens a torrent description page, retrieves the torrent file url, and downloads the torrent file. 19 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/juliensalinas/torrengo 2 | 3 | go 1.18 4 | 5 | require ( 6 | github.com/PuerkitoBio/goquery v1.8.0 7 | github.com/chromedp/cdproto v0.0.0-20220217222649-d8c14a5c6edf 8 | github.com/chromedp/chromedp v0.7.8 9 | github.com/olekukonko/tablewriter v0.0.5 10 | github.com/onrik/logrus v0.9.0 11 | github.com/sirupsen/logrus v1.8.1 12 | golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd 13 | golang.org/x/net v0.0.0-20220225172249-27dd8689420f 14 | ) 15 | 16 | require ( 17 | github.com/andybalholm/cascadia v1.3.1 // indirect 18 | github.com/chromedp/sysutil v1.0.0 // indirect 19 | github.com/gobwas/httphead v0.1.0 // indirect 20 | github.com/gobwas/pool v0.2.1 // indirect 21 | github.com/gobwas/ws v1.1.0 // indirect 22 | github.com/josharian/intern v1.0.0 // indirect 23 | github.com/mailru/easyjson v0.7.7 // indirect 24 | github.com/mattn/go-runewidth v0.0.13 // indirect 25 | github.com/rivo/uniseg v0.2.0 // indirect 26 | golang.org/x/sys v0.0.0-20220318055525-2edf467146b5 // indirect 27 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect 28 | ) 29 | -------------------------------------------------------------------------------- /otts/download.go: -------------------------------------------------------------------------------- 1 | package otts 2 | 3 | import ( 4 | "context" 5 | "fmt" 6 | "strings" 7 | "time" 8 | 9 | "github.com/juliensalinas/torrengo/core" 10 | 11 | "github.com/PuerkitoBio/goquery" 12 | ) 13 | 14 | // parseDescPage parses the torrent description page and extracts the magnet link 15 | func parseDescPage(html string) (string, error) { 16 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 17 | if err != nil { 18 | return "", fmt.Errorf("could not load html response into GoQuery: %v", err) 19 | } 20 | 21 | magnet, ok := doc.Find(".torrent-detail-page li a").Eq(0).First().Attr("href") 22 | if !ok { 23 | return "", fmt.Errorf("could not extract magnet link") 24 | } 25 | 26 | return magnet, nil 27 | } 28 | 29 | // ExtractMag opens the torrent description page and extracts the magnet link. 30 | // A user timeout is set. 31 | func ExtractMag(descURL string, timeout time.Duration) (string, error) { 32 | ctx, cancel := context.WithTimeout(context.Background(), timeout) 33 | defer cancel() 34 | 35 | html, _, err := core.Fetch(ctx, descURL, nil) 36 | if err != nil { 37 | return "", fmt.Errorf("error while fetching url: %v", err) 38 | } 39 | 40 | magnet, err := parseDescPage(html) 41 | if err != nil { 42 | return "", fmt.Errorf("error while parsing torrent description page: %v", err) 43 | } 44 | 45 | return magnet, nil 46 | } 47 | -------------------------------------------------------------------------------- /tpb/proxy.go: -------------------------------------------------------------------------------- 1 | package tpb 2 | 3 | import ( 4 | "context" 5 | "fmt" 6 | "strings" 7 | 8 | "github.com/PuerkitoBio/goquery" 9 | "github.com/juliensalinas/torrengo/core" 10 | log "github.com/sirupsen/logrus" 11 | ) 12 | 13 | // parseProxiesPage retrieves all the tpb urls from the html page 14 | func parseProxiesPage(html string) ([]string, error) { 15 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 16 | if err != nil { 17 | return nil, fmt.Errorf("could not load html response into GoQuery: %v", err) 18 | } 19 | 20 | // urls stores a list of tpb potential sites 21 | var urls []string 22 | 23 | // Results are located in a clean html 24 | doc.Find(".proxies tbody tr").Each(func(i int, s *goquery.Selection) { 25 | // TPB site url is the href of a tag whose class is "site" 26 | url := strings.ToLower(s.Find("a").First().Text()) 27 | if url == "" { 28 | log.Debug("could not find an url for a proxy") 29 | return 30 | } 31 | urls = append(urls, "https://"+url) 32 | }) 33 | 34 | return urls, nil 35 | } 36 | 37 | // getProxies returns a list of all tpb urls 38 | func getProxies(ctx context.Context) ([]string, error) { 39 | html, _, err := core.Fetch(ctx, proxiesListURL, nil) 40 | if err != nil { 41 | return nil, fmt.Errorf("error while fetching url: %v", err) 42 | } 43 | 44 | urls, err := parseProxiesPage(html) 45 | if err != nil { 46 | return nil, fmt.Errorf("error while parsing torrent search results: %v", err) 47 | } 48 | 49 | return urls, nil 50 | } 51 | -------------------------------------------------------------------------------- /ygg/login.go: -------------------------------------------------------------------------------- 1 | package ygg 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "net/url" 7 | "strconv" 8 | "strings" 9 | 10 | "github.com/juliensalinas/torrengo/core" 11 | ) 12 | 13 | // loginURL is the url used to retrieve to authenticate user. 14 | var loginURL = url.URL{ 15 | Scheme: "https", 16 | Host: baseURL, 17 | Path: "user/login", 18 | } 19 | 20 | // authUser authenticates user and stores cookies so that authentication is memorized 21 | func authUser(userID string, userPass string, client *http.Client) (*http.Client, error) { 22 | // Encode id and password as get parameters that will be passed to the request body 23 | formData := url.Values{ 24 | "id": {userID}, 25 | "pass": {userPass}, 26 | } 27 | 28 | // Create the POST request and put credentials in the body 29 | req, err := http.NewRequest("POST", loginURL.String(), strings.NewReader(formData.Encode())) 30 | if err != nil { 31 | return nil, fmt.Errorf("could not build POST request to login url: %v", err) 32 | } 33 | 34 | // Set proper headers. 35 | // Content-Type and Content-Length are not compulsory with Ygg but this is good practice. 36 | req.Header.Add("Content-Type", "application/x-www-form-urlencoded") 37 | req.Header.Add("Content-Length", strconv.Itoa(len(formData.Encode()))) 38 | req.Header.Set("User-Agent", core.UserAgent) 39 | 40 | // Launch request 41 | resp, err := client.Do(req) 42 | if err != nil { 43 | return nil, fmt.Errorf("POST request to login url failed: %v", err) 44 | } 45 | defer resp.Body.Close() 46 | if resp.StatusCode != http.StatusOK { 47 | return nil, fmt.Errorf("authentication failed with status code %v", resp.StatusCode) 48 | } 49 | 50 | return client, nil 51 | } 52 | -------------------------------------------------------------------------------- /arc/download.go: -------------------------------------------------------------------------------- 1 | package arc 2 | 3 | import ( 4 | "context" 5 | "fmt" 6 | "net/http" 7 | "strings" 8 | "time" 9 | 10 | "github.com/PuerkitoBio/goquery" 11 | "github.com/juliensalinas/torrengo/core" 12 | ) 13 | 14 | // parseDescPage parses the torrent description page and extracts the torrent file url 15 | func parseDescPage(html string) (string, error) { 16 | // Load html response into GoQuery 17 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 18 | if err != nil { 19 | return "", fmt.Errorf("could not load html response into GoQuery: %v", err) 20 | } 21 | 22 | // Get the torrent file path from a """ whose class starts with 23 | // "format-summary" and whose text contains the word "TORRENT" 24 | var fileURL string 25 | doc.Find(".format-summary ").EachWithBreak(func(i int, s *goquery.Selection) bool { 26 | if strings.Contains(s.Text(), "TORRENT") { 27 | path, ok := s.Attr("href") 28 | if ok { 29 | fileURL = baseURL + path 30 | } 31 | return false 32 | } 33 | return true 34 | }) 35 | 36 | if fileURL != "" { 37 | return fileURL, nil 38 | } 39 | 40 | return "", fmt.Errorf("could not find a torrent file on the description page") 41 | } 42 | 43 | // FindAndDlFile opens the torrent description page and downloads the torrent 44 | // file. 45 | // A user timeout is set. 46 | // Returns the local path of downloaded torrent file. 47 | func FindAndDlFile(descURL string, in string, timeout time.Duration) (string, error) { 48 | ctx, cancel := context.WithTimeout(context.Background(), timeout) 49 | defer cancel() 50 | 51 | html, _, err := core.Fetch(ctx, descURL, nil) 52 | if err != nil { 53 | return "", fmt.Errorf("error while fetching url: %v", err) 54 | } 55 | 56 | fileURL, err := parseDescPage(html) 57 | if err != nil { 58 | return "", fmt.Errorf("error while parsing torrent description page: %v", err) 59 | } 60 | 61 | client := &http.Client{ 62 | Timeout: timeout, 63 | } 64 | 65 | filePath, err := core.DlFileWithoutChrome(fileURL, in, client) 66 | if err != nil { 67 | return "", fmt.Errorf("error while downloading torrent file: %v", err) 68 | } 69 | 70 | return filePath, nil 71 | } 72 | -------------------------------------------------------------------------------- /ygg/download.go: -------------------------------------------------------------------------------- 1 | package ygg 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "strings" 7 | "time" 8 | 9 | "github.com/PuerkitoBio/goquery" 10 | "github.com/juliensalinas/torrengo/core" 11 | ) 12 | 13 | func parseDescPage(html string) (string, error) { 14 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 15 | if err != nil { 16 | return "", fmt.Errorf("could not load html response into GoQuery: %v", err) 17 | } 18 | 19 | // file url is located in the 1st of the 2nd of class infos-torrents 20 | fileURL, ok := doc.Find(".infos-torrent tbody tr").First().Find("td").Eq(1).Find("a").First().Attr("href") 21 | if !ok { 22 | return "", fmt.Errorf("could not find a torrent file on the description page") 23 | } 24 | 25 | return fileURL, nil 26 | } 27 | 28 | // FindAndDlFile authenticates user, opens the torrent description page, 29 | // and downloads the torrent file. 30 | // Returns the local path of downloaded torrent file. 31 | // A user timeout is set. 32 | func FindAndDlFile(descURL string, in string, userID string, userPass string, 33 | timeout time.Duration, client *http.Client) (string, error) { 34 | // Set timeout. 35 | client.Timeout = timeout 36 | 37 | // Authenticate user and create http client that handles cookie and timeout. 38 | client, err := authUser(userID, userPass, client) 39 | if err != nil { 40 | return "", fmt.Errorf("error while authenticating: %v", err) 41 | } 42 | 43 | // Fetch url. 44 | html, client, err := core.FetchWithoutChrome(descURL, client) 45 | if err != nil { 46 | return "", fmt.Errorf("error while fetching url: %v", err) 47 | } 48 | 49 | // Check if authentication properly worked. 50 | if !strings.Contains(html, "Déconnexion") { 51 | return "", fmt.Errorf("authentication error") 52 | } 53 | 54 | // Parse html response. 55 | filePath, err := parseDescPage(html) 56 | if err != nil { 57 | return "", fmt.Errorf("error while parsing torrent description page: %v", err) 58 | } 59 | 60 | fileURL := "https://" + baseURL + filePath 61 | filePathOnDisk, err := core.DlFileWithoutChrome(fileURL, in, client) 62 | if err != nil { 63 | return "", fmt.Errorf("error while downloading torrent file: %v", err) 64 | } 65 | 66 | return filePathOnDisk, nil 67 | } 68 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Description of Torrengo 2 | 3 | ## How To 4 | 5 | ### Purpose 6 | 7 | Torrengo is a CLI (command line) program written in Go which concurrently searches torrent files from various sources. I really liked the [torrench](https://github.com/kryptxy/torrench) program which is an equivalent written in Python so I figured it could be nice to write a similar program in Go in order to increase speed thanks to concurrency. 8 | 9 | Nice supported features: 10 | 11 | * the user decides which sources he wants to search (all sources are searched by default) and the search is done **concurrently** 12 | * given that The Pirate Bay urls are changing quite often, this program concurrently launches a search on all The Pirate Bay urls found on and retrieves torrents from the fastest response (the returned url is also checked in-depth because some proxies sometimes return a page with no error but the page actually does not have any result) 13 | * torrent file search and download on Ygg Torrent, The Pirate Bay, and 1337, are protected by the Cloudflare bot detection. In order to comply, a Google Chrome browser is used under the hood (which means that you need to have Google Chrome installed in order for this program to work). 14 | * can be searched freely, but an account is needed to download the torrent file, so the program authenticates the user before downloading the torrent file 15 | * downloaded torrents can be launched in Deluge, QBittorrent, or Transmission 16 | * a timeout can be set so long-running requests are ignored 17 | 18 | Current supported sources are the following: 19 | 20 | 1. (called **arc** internally) 21 | 1. all The Pirate Bay urls located on (called **tpb** internally) 22 | 1. (called **otts** internally) 23 | 1. (previously t411, called**ygg** internally) 24 | 25 | **Caution!** Apart from Archive.org, the websites above might host some illegal content and in some countries their use might be prohibited. Read [legal issues regarding The Pirate Bay](https://en.wikipedia.org/wiki/The_Pirate_Bay#Legal_issues) for example. Neither I, nor the tool shall be held responsible for any action taken against you for using Torrengo on the above-mentioned sites. 26 | 27 | ### Installation 28 | 29 | **Prerequisite:** you need to have Google Chrome installed on your system. Torrengo needs a real Google Chrome browser in order to behave like any real browser and then properly deal with Javascript. 30 | 31 | For security reasons I don't provide with compiled binaries. The program can be easily installed and compiled with the usual Go tools: 32 | 33 | `go install github.com/juliensalinas/torrengo@latest` 34 | 35 | Each website's scraper is an independent library that can be installed and reused. For example if you only want to use the Archive.org scraping library, simply do: 36 | 37 | `go install github.com/juliensalinas/arc@latest` 38 | 39 | ### Usage 40 | 41 | Searching "Dumas Montecristo" from all sources is as simple as: 42 | 43 | `torrengo Dumas Montecristo` 44 | 45 | ![Torrgengo output](https://juliensalinas.com/en/images/torrengo-example_201809171014.png) 46 | 47 | If you want to search from a specific source (let's say Archive.org): 48 | 49 | `torrengo -s arc Dumas Montecristo` 50 | 51 | Sources names: 52 | 53 | * : arc 54 | * all The Pirate Bay urls located on : tpb 55 | * : otts 56 | * : ygg 57 | 58 | If you want to search from multiple sources (let's say Archive.org and ThePirateBay), use commas: 59 | 60 | `torrengo -s arc,tpb Dumas Montecristo` 61 | 62 | If some sources are too slow to respond, use a timeout. For example the following stops every HTTP requests that take more than 2 seconds and returns the other results found: 63 | 64 | `./torrengo -t 2000 Dumas Montecristo` 65 | 66 | Some sources give both a magnet link and a torrent file (you can choose which one you want), some only give a torrent file, and some only give a magnet link. 67 | 68 | Optionally you can open the torrent file or magnet link directly in your torrent client (**Deluge**, **QBittorrent** or **Transmission** are supported for the moment). 69 | -------------------------------------------------------------------------------- /arc/search.go: -------------------------------------------------------------------------------- 1 | // Package arc searches and downloads archive.org 2 | // 3 | // No check is done here regarding the user input. This check should be 4 | // achieved by the caller. 5 | // Parsing is achieved thanks to the GoQuery library. 6 | // 7 | // Torrent search is achieved by Lookup(). 8 | // Input is a search string. 9 | // Output is a slice of maps made up of the following keys: 10 | // 11 | // - DescUrl: the torrent description dedicated url 12 | // 13 | // - Name: the torrent name 14 | // 15 | // Torrent url extraction and torrent file download are achieved by FindAndDlFile(). 16 | // Input is the url of the torrent page. 17 | // Output is the local path where the torrent file was downloaded. 18 | package arc 19 | 20 | import ( 21 | "context" 22 | "fmt" 23 | "net/url" 24 | "strings" 25 | "time" 26 | 27 | "github.com/PuerkitoBio/goquery" 28 | "github.com/juliensalinas/torrengo/core" 29 | log "github.com/sirupsen/logrus" 30 | ) 31 | 32 | const baseURL string = "https://archive.org" 33 | 34 | // Torrent contains meta information about the torrent 35 | type Torrent struct { 36 | // Description url containing more info about the torrent including the torrent file address 37 | DescURL string 38 | Name string 39 | } 40 | 41 | // buildURL encodes the user search keywords into a proper url. 42 | // A typical final url looks like: 43 | // https://archive.org/search.php?query=Dumas%20AND%20format%3A%22Archive%20BitTorrent%22 44 | func buildSearchURL(in string) (string, error) { 45 | // Add the following suffix to the query in order for archive.org 46 | // to return torrents only 47 | in += ` AND format:"Archive BitTorrent"` 48 | 49 | // Encode baseURL as an url.URL type (Parse expects a pointer) 50 | // so we can work on it more easily 51 | var URL *url.URL 52 | URL, err := url.Parse(baseURL) 53 | if err != nil { 54 | return "", fmt.Errorf("error during url parsing: %v", err) 55 | } 56 | 57 | // Create base path of URL 58 | URL.Path += "/search.php" 59 | 60 | // Add GET parameters 61 | params := url.Values{} 62 | params.Add("query", in) 63 | URL.RawQuery = params.Encode() 64 | 65 | return URL.String(), nil 66 | } 67 | 68 | // parse parses an html slice of bytes and returns a clean list 69 | // of torrents found in this page 70 | func parseSearchPage(html string) ([]Torrent, error) { 71 | // Load html response into GoQuery 72 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 73 | if err != nil { 74 | return nil, fmt.Errorf("could not load html response into GoQuery: %v", err) 75 | } 76 | 77 | // torrents stores a list of torrents made up of the torrent description url 78 | // and its name 79 | var torrents []Torrent 80 | 81 | doc.Find(".item-ttl.C.C2").Each(func(i int, s *goquery.Selection) { 82 | // Get path to torrent description page from a "" tag located inside a 83 | // "class=C234" 84 | var t Torrent 85 | 86 | path, ok := s.Find("a").Eq(0).First().Attr("href") 87 | // If no description url found, stop here 88 | if !ok { 89 | log.Debug("Could not find a description page for a torrent so ignoring it") 90 | return 91 | } 92 | // Build the real url 93 | t.DescURL = baseURL + path 94 | 95 | // Get name from a "class=ttl" tag. 96 | // Remove dirty spaces before and after title. 97 | t.Name = strings.TrimSpace(s.Find(".ttl").First().Text()) 98 | 99 | torrents = append(torrents, t) 100 | 101 | }) 102 | 103 | return torrents, nil 104 | } 105 | 106 | // Lookup takes a user search as a parameter, launches the http request 107 | // with a custom timeout, and returns clean torrent information fetched from archive.org 108 | func Lookup(in string, timeout time.Duration) ([]Torrent, error) { 109 | url, err := buildSearchURL(in) 110 | if err != nil { 111 | return nil, fmt.Errorf("error while building url: %v", err) 112 | } 113 | 114 | ctx, cancel := context.WithTimeout(context.Background(), timeout) 115 | defer cancel() 116 | 117 | html, _, err := core.Fetch(ctx, url, nil) 118 | if err != nil { 119 | return nil, fmt.Errorf("error while fetching url: %v", err) 120 | } 121 | 122 | torrents, err := parseSearchPage(html) 123 | if err != nil { 124 | return nil, fmt.Errorf("error while parsing torrent search results: %v", err) 125 | } 126 | 127 | return torrents, nil 128 | } 129 | -------------------------------------------------------------------------------- /otts/search.go: -------------------------------------------------------------------------------- 1 | // Package otts searches and downloads torrents from 1337x.to 2 | // 3 | // No check is done here regarding the user input. This check should be 4 | // achieved by the caller. 5 | // Parsing is achieved thanks to the GoQuery library. 6 | // Comments common to all scraping libs are already done in the arc package which is very 7 | // similar to this package. Only additional comments specific to this lib are present here. 8 | // 9 | // Torrent search is achieved by Lookup(). 10 | // Input is a search string. 11 | // Output is a slice of maps made up of the following keys: 12 | // 13 | // - DescURL: the torrent description page 14 | // 15 | // - Name: the torrent name 16 | // 17 | // - Size: the size of the file to be downloaded 18 | // 19 | // - UplDate: the date of upload 20 | // 21 | // - Leechers: the number of leechers (set to -1 if cannot be converted to integer) 22 | // 23 | // - Seechers: the number of seechers (set to -1 if cannot be converted to integer) 24 | // 25 | // Magnet file extraction are achieved by ExtractMag(). 26 | // Input is the url of the torrent page. 27 | // Output is the magnet link. 28 | 29 | package otts 30 | 31 | import ( 32 | "context" 33 | "fmt" 34 | "net/url" 35 | "strconv" 36 | "strings" 37 | "time" 38 | 39 | "github.com/juliensalinas/torrengo/core" 40 | 41 | "github.com/PuerkitoBio/goquery" 42 | log "github.com/sirupsen/logrus" 43 | ) 44 | 45 | const baseURL string = "https://www.1377x.to" 46 | 47 | // Torrent contains meta information about the torrent 48 | type Torrent struct { 49 | DescURL string 50 | Name string 51 | Size string 52 | UplDate string 53 | // Seeders and Leechers are converted to -1 if cannot be converted to integers 54 | Seeders int 55 | Leechers int 56 | } 57 | 58 | // A typical final url looks like: 59 | // https://1337x.to/search/Dumas/1/ 60 | func buildSearchURL(in string) (string, error) { 61 | var URL *url.URL 62 | URL, err := url.Parse(baseURL) 63 | if err != nil { 64 | return "", fmt.Errorf("error during url parsing: %v", err) 65 | } 66 | 67 | URL.Path += "/search/" + in + "/1/" 68 | 69 | return URL.String(), nil 70 | } 71 | 72 | func parseSearchPage(html string) ([]Torrent, error) { 73 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 74 | if err != nil { 75 | return nil, fmt.Errorf("could not load html response into GoQuery: %v", err) 76 | } 77 | 78 | // torrents stores a list of torrents made up of the torrent description url, 79 | // its name, its size, its upload date, its seeders, and its leechers 80 | var torrents []Torrent 81 | 82 | // Results are located in a clean html
of the first
83 | doc.Find("tbody tr").Each(func(i int, s *goquery.Selection) { 84 | var t Torrent 85 | 86 | // Name is the text of the 2nd tag, and desc URL is the href 87 | path, ok := s.Find("a").Eq(1).First().Attr("href") 88 | if !ok { 89 | log.Debug("Could not find a description page for a torrent so ignoring it") 90 | return 91 | } 92 | t.DescURL = baseURL + path 93 | t.Name = s.Find("a").Eq(1).First().Text() 94 | 95 | // Seeders and leechers are located in the 2nd and 3rd
. 96 | // We convert it to integers and if conversion fails we convert it to -1. 97 | seedersStr := s.Find("td").Eq(1).First().Text() 98 | seeders, err := strconv.Atoi(seedersStr) 99 | if err != nil { 100 | seeders = -1 101 | } 102 | t.Seeders = seeders 103 | 104 | leechersStr := s.Find("td").Eq(2).First().Text() 105 | leechers, err := strconv.Atoi(leechersStr) 106 | if err != nil { 107 | leechers = -1 108 | } 109 | t.Leechers = leechers 110 | 111 | // Upload date is the text of the 4th tag 112 | t.UplDate = s.Find("td").Eq(3).First().Text() 113 | 114 | // Size is the text of the 5th tag 115 | t.Size = s.Find("td").Eq(4).First().Text() 116 | 117 | torrents = append(torrents, t) 118 | }) 119 | 120 | return torrents, nil 121 | } 122 | 123 | // Lookup takes a user search as a parameter, launches the http request 124 | // with a custom timeout, and returns clean torrent information fetched from 1337x.to 125 | func Lookup(in string, timeout time.Duration) ([]Torrent, error) { 126 | url, err := buildSearchURL(in) 127 | if err != nil { 128 | return nil, fmt.Errorf("error while building url: %v", err) 129 | } 130 | 131 | ctx, cancel := context.WithTimeout(context.Background(), timeout) 132 | defer cancel() 133 | 134 | html, _, err := core.Fetch(ctx, url, nil) 135 | if err != nil { 136 | return nil, fmt.Errorf("error while fetching url: %v", err) 137 | } 138 | 139 | torrents, err := parseSearchPage(html) 140 | if err != nil { 141 | return nil, fmt.Errorf("error while parsing torrent search results: %v", err) 142 | } 143 | 144 | return torrents, nil 145 | } 146 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/PuerkitoBio/goquery v1.8.0 h1:PJTF7AmFCFKk1N6V6jmKfrNH9tV5pNE6lZMkG0gta/U= 2 | github.com/PuerkitoBio/goquery v1.8.0/go.mod h1:ypIiRMtY7COPGk+I/YbZLbxsxn9g5ejnI2HSMtkjZvI= 3 | github.com/andybalholm/cascadia v1.3.1 h1:nhxRkql1kdYCc8Snf7D5/D3spOX+dBgjA6u8x004T2c= 4 | github.com/andybalholm/cascadia v1.3.1/go.mod h1:R4bJ1UQfqADjvDa4P6HZHLh/3OxWWEqc0Sk8XGwHqvA= 5 | github.com/chromedp/cdproto v0.0.0-20220217222649-d8c14a5c6edf h1:1omDWNUsWxn2HpiMiMuyRmzjl9uG7RP3IE6GTlpgJWU= 6 | github.com/chromedp/cdproto v0.0.0-20220217222649-d8c14a5c6edf/go.mod h1:At5TxYYdxkbQL0TSefRjhLE3Q0lgvqKKMSFUglJ7i1U= 7 | github.com/chromedp/cdproto v0.0.0-20220310232215-0e2f46551646 h1:/Q5ggyQMqseW9VCYCD2igR31iBoQcI3aXWDs3mDoikQ= 8 | github.com/chromedp/cdproto v0.0.0-20220310232215-0e2f46551646/go.mod h1:At5TxYYdxkbQL0TSefRjhLE3Q0lgvqKKMSFUglJ7i1U= 9 | github.com/chromedp/chromedp v0.7.8 h1:JFPIFb28LPjcx6l6mUUzLOTD/TgswcTtg7KrDn8S/2I= 10 | github.com/chromedp/chromedp v0.7.8/go.mod h1:HcIUFBa5vA+u2QI3+xljiU59llUQ8lgGoLzYSCBfmUA= 11 | github.com/chromedp/sysutil v1.0.0 h1:+ZxhTpfpZlmchB58ih/LBHX52ky7w2VhQVKQMucy3Ic= 12 | github.com/chromedp/sysutil v1.0.0/go.mod h1:kgWmDdq8fTzXYcKIBqIYvRRTnYb9aNS9moAV0xufSww= 13 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 14 | github.com/gobwas/httphead v0.1.0 h1:exrUm0f4YX0L7EBwZHuCF4GDp8aJfVeBrlLQrs6NqWU= 15 | github.com/gobwas/httphead v0.1.0/go.mod h1:O/RXo79gxV8G+RqlR/otEwx4Q36zl9rqC5u12GKvMCM= 16 | github.com/gobwas/pool v0.2.1 h1:xfeeEhW7pwmX8nuLVlqbzVc7udMDrwetjEv+TZIz1og= 17 | github.com/gobwas/pool v0.2.1/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw= 18 | github.com/gobwas/ws v1.1.0 h1:7RFti/xnNkMJnrK7D1yQ/iCIB5OrrY/54/H930kIbHA= 19 | github.com/gobwas/ws v1.1.0/go.mod h1:nzvNcVha5eUziGrbxFCo6qFIojQHjJV5cLYIbezhfL0= 20 | github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY= 21 | github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y= 22 | github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0= 23 | github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= 24 | github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0= 25 | github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= 26 | github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU= 27 | github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= 28 | github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec= 29 | github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY= 30 | github.com/onrik/logrus v0.9.0 h1:oT7VstCUxWBoX7fswYK61fi9bzRBSpROq5CR2b7wxQo= 31 | github.com/onrik/logrus v0.9.0/go.mod h1:qfe9NeZVAJfIxviw3cYkZo3kvBtLoPRJriAO8zl7qTk= 32 | github.com/orisano/pixelmatch v0.0.0-20210112091706-4fa4c7ba91d5/go.mod h1:nZgzbfBr3hhjoZnS66nKrHmduYNpc34ny7RK4z5/HM0= 33 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 34 | github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= 35 | github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= 36 | github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE= 37 | github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= 38 | github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= 39 | golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd h1:XcWmESyNjXJMLahc3mqVQJcgSTDxFxhETVlfk9uGc38= 40 | golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= 41 | golang.org/x/net v0.0.0-20210916014120-12bc252f5db8/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= 42 | golang.org/x/net v0.0.0-20220225172249-27dd8689420f h1:oA4XRj0qtSt8Yo1Zms0CUlsT3KG69V2UGQWPBxujDmc= 43 | golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= 44 | golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 45 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 46 | golang.org/x/sys v0.0.0-20201207223542-d4d67f95c62d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 47 | golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 48 | golang.org/x/sys v0.0.0-20220209214540-3681064d5158 h1:rm+CHSpPEEW2IsXUib1ThaHIjuBVZjxNgSKmBLFfD4c= 49 | golang.org/x/sys v0.0.0-20220209214540-3681064d5158/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 50 | golang.org/x/sys v0.0.0-20220318055525-2edf467146b5 h1:saXMvIOKvRFwbOMicHXr0B1uwoxq9dGmLe5ExMES6c4= 51 | golang.org/x/sys v0.0.0-20220318055525-2edf467146b5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 52 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 53 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY= 54 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= 55 | golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 56 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 57 | -------------------------------------------------------------------------------- /ygg/search.go: -------------------------------------------------------------------------------- 1 | // Package ygg searches and downloads torrents from Ygg Torrent 2 | // 3 | // No check is done here regarding the user input. This check should be 4 | // achieved by the caller. 5 | // Parsing is achieved thanks to the GoQuery library. 6 | // Comments common to all scraping libs are already done in the arc package which is very 7 | // similar to this package. Only additional comments specific to this lib are present here. 8 | // 9 | // Torrent search is achieved by Lookup(). 10 | // Input is a search string. 11 | // Output is a slice of maps made up of the following keys: 12 | // 13 | // - DescURL: the torrent description page 14 | // 15 | // - Name: the torrent name 16 | // 17 | // - Size: the size of the file to be downloaded 18 | // 19 | // - UplDate: the date of upload 20 | // 21 | // - Leechers: the number of leechers (set to -1 if cannot be converted to integer) 22 | // 23 | // - Seechers: the number of seechers (set to -1 if cannot be converted to integer) 24 | // 25 | // Magnet file extraction are achieved by ExtractMag(). 26 | // Input is the url of the torrent page. 27 | // Output is the magnet link. 28 | package ygg 29 | 30 | import ( 31 | "context" 32 | "fmt" 33 | "net/http" 34 | "net/http/cookiejar" 35 | "net/url" 36 | "strconv" 37 | "strings" 38 | "time" 39 | 40 | "github.com/PuerkitoBio/goquery" 41 | "github.com/juliensalinas/torrengo/core" 42 | log "github.com/sirupsen/logrus" 43 | "golang.org/x/net/publicsuffix" 44 | ) 45 | 46 | // const baseURL = "yggtorrent.to" 47 | // const baseURL = "www2.yggtorrent.gg" 48 | // const baseURL = "www2.yggtorrent.ch" 49 | // const baseURL = "www2.yggtorrent.ws" 50 | // const baseURL = "www2.yggtorrent.se" 51 | // const baseURL = "www2.yggtorrent.si" 52 | // const baseURL = "www4.yggtorrent.li" 53 | 54 | const baseURL = "www5.yggtorrent.fi" 55 | 56 | // searchURL is the url used to retrieve a list of torrents based on user keywords. 57 | // A typical final url looks like: 58 | // https://www.yggtorrent.is/engine/search?name=alexandre+dumas&do=search 59 | var searchURL = url.URL{ 60 | Scheme: "https", 61 | Host: baseURL, 62 | Path: "engine/search", 63 | } 64 | 65 | // searchParams are the hardcoded GET parameters. 66 | // Some other dynamic params are added further in the program. 67 | var searchParams = url.Values{ 68 | "do": {"search"}, 69 | } 70 | 71 | // Torrent contains meta information about the torrent 72 | type Torrent struct { 73 | DescURL string 74 | Name string 75 | Size string 76 | UplDate string 77 | // Seeders and Leechers are converted to -1 if cannot be converted to integers 78 | Seeders int 79 | Leechers int 80 | } 81 | 82 | func parseSearchPage(html string) ([]Torrent, error) { 83 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 84 | if err != nil { 85 | return nil, fmt.Errorf("could not load html response into GoQuery: %v", err) 86 | } 87 | 88 | // torrents stores a list of torrents made up of the torrent description url, 89 | // its name, its size, its upload date, its seeders, and its leechers 90 | var torrents []Torrent 91 | 92 | // Results are located in a clean html whose class is table 93 | doc.Find(".table tbody tr").Each(func(i int, s *goquery.Selection) { 94 | var t Torrent 95 | 96 | // Torrent name is the text of the 2th
tag and descURL is its href 97 | descURL, ok := s.Find("td a").Eq(1).First().Attr("href") 98 | if !ok { 99 | log.Debug("Could not find description URL for a torrent so ignoring it") 100 | return 101 | } 102 | t.DescURL = descURL 103 | 104 | t.Name = s.Find("td a").Eq(1).First().Text() 105 | 106 | // Upload date is the text of the div whose class is hidden in the 3rd tag. 107 | // A proper timestamp is retrieved. We convert it to datetime. 108 | timestampStr := s.Find("td").Eq(4).First().Find(".hidden").First().Text() 109 | timestamp, err := strconv.ParseInt(timestampStr, 10, 64) 110 | if err != nil { 111 | t.UplDate = "" 112 | } else { 113 | t.UplDate = time.Unix(timestamp, 0).Format("2006/01/02 15:04") 114 | } 115 | 116 | // File size is the text of the 4th tag 117 | t.Size = s.Find("td").Eq(5).First().Text() 118 | 119 | // Seeders is the text of the 6th tag 120 | seedersStr := s.Find("td").Eq(7).First().Text() 121 | seeders, err := strconv.Atoi(seedersStr) 122 | if err != nil { 123 | seeders = -1 124 | } 125 | t.Seeders = seeders 126 | 127 | // Leechers is the text of the 7th tag 128 | leechersStr := s.Find("td").Eq(8).First().Text() 129 | leechers, err := strconv.Atoi(leechersStr) 130 | if err != nil { 131 | leechers = -1 132 | } 133 | t.Leechers = leechers 134 | 135 | torrents = append(torrents, t) 136 | }) 137 | 138 | return torrents, nil 139 | } 140 | 141 | // Lookup takes a user search as a parameter, launches the http request 142 | // with a custom timeout, and returns clean torrent information fetched from Ygg Torrent. 143 | func Lookup(in string, timeout time.Duration) ([]Torrent, *http.Client, error) { 144 | searchParams.Add("name", in) 145 | searchURL.RawQuery = searchParams.Encode() 146 | 147 | ctx, cancel := context.WithTimeout(context.Background(), timeout) 148 | defer cancel() 149 | 150 | html, cookies, err := core.Fetch(ctx, searchURL.String(), nil) 151 | if err != nil { 152 | return nil, nil, fmt.Errorf("error while fetching url: %v", err) 153 | } 154 | 155 | torrents, err := parseSearchPage(html) 156 | if err != nil { 157 | return nil, nil, fmt.Errorf("error while parsing torrent search results: %v", err) 158 | } 159 | 160 | // Init cookies. 161 | // Using the publicsuffix list is recommended by Go docs 162 | cookieJar, _ := cookiejar.New(&cookiejar.Options{PublicSuffixList: publicsuffix.List}) 163 | client := &http.Client{ 164 | Timeout: timeout, 165 | Jar: cookieJar, 166 | } 167 | client.Jar.SetCookies(&searchURL, cookies) 168 | 169 | return torrents, client, nil 170 | } 171 | -------------------------------------------------------------------------------- /core/core.go: -------------------------------------------------------------------------------- 1 | package core 2 | 3 | import ( 4 | "context" 5 | "fmt" 6 | "io" 7 | "io/ioutil" 8 | "net/http" 9 | "os" 10 | "path/filepath" 11 | "strconv" 12 | "strings" 13 | "time" 14 | 15 | "github.com/chromedp/cdproto/cdp" 16 | "github.com/chromedp/cdproto/dom" 17 | "github.com/chromedp/cdproto/network" 18 | "github.com/chromedp/chromedp" 19 | "github.com/chromedp/chromedp/device" 20 | ) 21 | 22 | // UserAgent is a customer browser user agent used in every HTTP connections 23 | const UserAgent string = "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.62 Safari/537.36" 24 | 25 | var cookieExpiry = time.Now().Add(10 * time.Minute) 26 | 27 | // DlFileWithoutChrome downloads the torrent with a custom client created by user and returns the path of 28 | // downloaded file. 29 | // The name of the downloaded file is made up of the search arguments + the 30 | // Unix timestamp to avoid collision. Ex: comte_de_montecristo_1581064034469619222.torrent 31 | func DlFileWithoutChrome(fileURL string, in string, client *http.Client) (string, error) { 32 | // Get torrent file name from url 33 | fileName := strings.Replace(in, " ", "_", -1) 34 | fileName += "_" + strconv.Itoa(int(time.Now().UnixNano())) + ".torrent" 35 | 36 | // Create local torrent file 37 | out, err := os.Create(fileName) 38 | if err != nil { 39 | return "", fmt.Errorf("could not create the torrent file named %s: %v", fileName, err) 40 | } 41 | defer out.Close() 42 | 43 | // Download torrent 44 | req, err := http.NewRequest("GET", fileURL, nil) 45 | if err != nil { 46 | return "", fmt.Errorf("could not create request: %v", err) 47 | } 48 | req.Header.Set("User-Agent", UserAgent) 49 | resp, err := client.Do(req) 50 | if err != nil { 51 | return "", fmt.Errorf("could not download the torrent file: %v", err) 52 | } 53 | if resp.StatusCode != http.StatusOK { 54 | resp.Body.Close() 55 | return "", fmt.Errorf("status code error: %d %s", resp.StatusCode, resp.Status) 56 | } 57 | 58 | // Save torrent to disk 59 | _, err = io.Copy(out, resp.Body) 60 | if err != nil { 61 | return "", fmt.Errorf("could not save the torrent file to disk: %v", err) 62 | } 63 | 64 | // Get absolute file path of torrent 65 | dir, err := filepath.Abs(filepath.Dir(os.Args[0])) 66 | if err != nil { 67 | return "", fmt.Errorf("could not retrieve current directory of saved filed: %v", err) 68 | } 69 | filePath := dir + "/" + fileName 70 | 71 | return filePath, nil 72 | } 73 | 74 | // FetchWithoutChrome fetches a URL using Go http client under the hood 75 | // instead of Chrome. 76 | func FetchWithoutChrome(url string, client *http.Client) (string, *http.Client, error) { 77 | req, err := http.NewRequest("GET", url, nil) 78 | if err != nil { 79 | return "", nil, fmt.Errorf("could not create request: %v", err) 80 | } 81 | 82 | req.Header.Set("User-Agent", UserAgent) 83 | 84 | resp, err := client.Do(req) 85 | if err != nil { 86 | return "", nil, fmt.Errorf("could not launch request: %v", err) 87 | } 88 | 89 | if resp.StatusCode != http.StatusOK { 90 | resp.Body.Close() 91 | return "", nil, fmt.Errorf("status code error: %v", resp.StatusCode) 92 | } 93 | 94 | body, err := ioutil.ReadAll(resp.Body) 95 | if err != nil { 96 | return "", nil, fmt.Errorf("can't read response body: %w", err) 97 | } 98 | 99 | return string(body), client, nil 100 | } 101 | 102 | // Fetch opens a url with custom context and cookies passed by the caller. 103 | // It uses ChromeDP under the hood in order to emulate a real browser 104 | // running on Pixel 2 XL, and thus properly handle Javascript. 105 | func Fetch(ctx context.Context, url string, cookies []*http.Cookie) (string, []*http.Cookie, error) { 106 | var html string 107 | var newCDPCookies []*network.Cookie 108 | var newCookies []*http.Cookie 109 | 110 | ctx, cancel := chromedp.NewContext(ctx) 111 | defer cancel() 112 | 113 | // TODO(juliensalinas): check status code of the response 114 | err := chromedp.Run(ctx, 115 | setCookies(ctx, cookies), 116 | chromedp.Emulate(device.Pixel2XL), 117 | chromedp.Navigate(url), 118 | chromedp.ActionFunc(func(ctx context.Context) error { 119 | // Retrieve HTML response. 120 | node, err := dom.GetDocument().Do(ctx) 121 | if err != nil { 122 | return err 123 | } 124 | html, err = dom.GetOuterHTML().WithNodeID(node.NodeID).Do(ctx) 125 | if err != nil { 126 | return err 127 | } 128 | 129 | // Retrieve response cookies. 130 | newCDPCookies, err = network.GetAllCookies().Do(ctx) 131 | if err != nil { 132 | return err 133 | } 134 | 135 | newCookies = convertCookies(newCDPCookies) 136 | 137 | return nil 138 | }), 139 | ) 140 | 141 | if err != nil { 142 | return "", nil, fmt.Errorf("could not download page: %w", err) 143 | } 144 | 145 | return html, newCookies, nil 146 | } 147 | 148 | // convertCookies converts ChromeDP cookies to Go http cookies. 149 | func convertCookies(cookies []*network.Cookie) []*http.Cookie { 150 | var newCookies []*http.Cookie 151 | 152 | for _, cookie := range cookies { 153 | newCookie := http.Cookie{ 154 | Name: cookie.Name, 155 | Value: cookie.Value, 156 | Path: cookie.Path, 157 | Domain: cookie.Domain, 158 | Expires: cookieExpiry, 159 | Secure: cookie.Secure, 160 | HttpOnly: cookie.HTTPOnly, 161 | } 162 | newCookies = append(newCookies, &newCookie) 163 | } 164 | 165 | return newCookies 166 | } 167 | 168 | // setCookies retrieves Go http cookies and sets ChromeDP out of it. 169 | // 170 | // TODO(juliensalinas): try again to use network.SetCookies. Last 171 | // time it failed with "invalid parameter -32602 for some reason". 172 | func setCookies(ctx context.Context, cookies []*http.Cookie) chromedp.Action { 173 | return chromedp.ActionFunc(func(ctx context.Context) error { 174 | for _, cookie := range cookies { 175 | expiry := cdp.TimeSinceEpoch(cookieExpiry) 176 | err := network.SetCookie(cookie.Name, cookie.Value). 177 | WithExpires(&expiry). 178 | WithDomain(cookie.Domain). 179 | WithPath(cookie.Path). 180 | WithHTTPOnly(cookie.HttpOnly). 181 | WithSecure(cookie.Secure). 182 | Do(ctx) 183 | if err != nil { 184 | return err 185 | } 186 | } 187 | 188 | // Check that cookies were properly set. 189 | cookiesInBrowser, err := network.GetAllCookies().Do(ctx) 190 | if err != nil { 191 | return err 192 | } 193 | if len(cookiesInBrowser) != len(cookies) { 194 | return fmt.Errorf("cookies not properly set") 195 | } 196 | 197 | return nil 198 | }) 199 | } 200 | -------------------------------------------------------------------------------- /tpb/search.go: -------------------------------------------------------------------------------- 1 | // Package tpb searches and extracts magnet link from ThePirateBay 2 | // 3 | // No check is done here regarding the user input. This check should be 4 | // achieved by the caller. 5 | // Parsing is achieved thanks to the GoQuery library. 6 | // Comments common to all scraping libs are already done in the arc package which is very 7 | // similar to this package. Only additional comments specific to this lib are present here. 8 | // 9 | // Torrent search is achieved by Lookup(). All useful information is located in the search result page. 10 | // No need to open a second page. 11 | // Input is a search string. 12 | // Output is a slice of maps made up of the following keys: 13 | // 14 | // - Magnet: the torrent magnet 15 | // 16 | // - Name: the torrent name 17 | // 18 | // - Size: the size of the file to be downloaded 19 | // 20 | // - UplDate: the date of upload 21 | // 22 | // - Leechers: the number of leechers (set to -1 if cannot be converted to integer) 23 | // 24 | // - Seechers: the number of seechers (set to -1 if cannot be converted to integer) 25 | package tpb 26 | 27 | import ( 28 | "context" 29 | "fmt" 30 | "net/url" 31 | "strconv" 32 | "strings" 33 | "time" 34 | 35 | "github.com/PuerkitoBio/goquery" 36 | "github.com/juliensalinas/torrengo/core" 37 | log "github.com/sirupsen/logrus" 38 | ) 39 | 40 | const proxiesListURL = "https://pirateproxy.wtf" 41 | 42 | // Torrent contains meta information about the torrent 43 | type Torrent struct { 44 | Magnet string 45 | Name string 46 | Size string 47 | UplDate string 48 | // Seeders and Leechers are converted to -1 if cannot be converted to integers 49 | Seeders int 50 | Leechers int 51 | } 52 | 53 | // A typical final url looks like: 54 | // baseURL + /search/dumas/0/99/0 55 | func buildSearchURL(baseURL string, in string) (string, error) { 56 | var URL *url.URL 57 | URL, err := url.Parse(baseURL) 58 | if err != nil { 59 | return "", fmt.Errorf("error during url parsing: %v", err) 60 | } 61 | 62 | URL.Path += "/search.php" 63 | q := URL.Query() 64 | q.Set("q", in) 65 | URL.RawQuery = q.Encode() 66 | 67 | return URL.String(), nil 68 | } 69 | 70 | func parseSearchPage(html string) ([]Torrent, error) { 71 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 72 | if err != nil { 73 | return nil, fmt.Errorf("could not load html response into GoQuery: %v", err) 74 | } 75 | 76 | // torrents stores a list of torrents made up of the torrent description url, 77 | // its name, its size, its seeders, and its leechers 78 | var torrents []Torrent 79 | 80 | // Results are located in a clean list 81 | doc.Find("#torrents li").Each(func(i int, s *goquery.Selection) { 82 | var t Torrent 83 | // Magnet is the href of the 4th tag 84 | magnet, ok := s.Find("span").Eq(3).Find("a").First().Attr("h") 85 | if !ok { 86 | log.Debug("Could not find a magnet for a torrent so ignoring it") 87 | return 88 | } 89 | t.Magnet = magnet 90 | 91 | // Torrent name is the text of the tag in the 2nd 92 | t.Name = s.Find("span").Eq(1).Find("a").First().Text() 93 | 94 | // Upload date, size, seeders, and leechers, are the text of 95 | // other tags. 96 | t.UplDate = s.Find("span").Eq(2).Text() 97 | t.Size = s.Find("span").Eq(4).Text() 98 | 99 | // We convert seeders and leechers to integers and 100 | // conversion fails we convert it to -1. 101 | seedersStr := s.Find("span").Eq(5).Text() 102 | seedersStr = strings.TrimSpace(seedersStr) 103 | seeders, err := strconv.Atoi(seedersStr) 104 | 105 | if err != nil { 106 | seeders = -1 107 | } 108 | t.Seeders = seeders 109 | 110 | leechersStr := s.Find("span").Eq(6).Text() 111 | leechersStr = strings.TrimSpace(leechersStr) 112 | leechers, err := strconv.Atoi(leechersStr) 113 | if err != nil { 114 | leechers = -1 115 | } 116 | t.Leechers = leechers 117 | 118 | torrents = append(torrents, t) 119 | }) 120 | 121 | return torrents, nil 122 | } 123 | 124 | // checkEmptyResp checks whether the tpb response contains the 125 | // #searchResult id, otherwise it means the site is broken 126 | func checkEmptyResp(html string) bool { 127 | doc, err := goquery.NewDocumentFromReader(strings.NewReader(html)) 128 | if err != nil { 129 | return false 130 | } 131 | 132 | if doc.Find("#torrents").Nodes == nil { 133 | return false 134 | } 135 | 136 | return true 137 | } 138 | 139 | // Lookup takes a user search as a parameter and 140 | // returns clean torrent information fetched from ThePirateBay. 141 | // It first looks for the ThePirateBay proxies and then 142 | // concurrently fetches all of them and retrieve results from 143 | // the quickest one after checking that the latter is not broken. 144 | // A custom user timeout is set. 145 | func Lookup(in string, timeout time.Duration) ([]Torrent, error) { 146 | ctx, cancel := context.WithTimeout(context.Background(), timeout) 147 | defer cancel() 148 | 149 | // Retrieve tpb proxies urls. 150 | proxiesList, err := getProxies(ctx) 151 | if err != nil { 152 | return nil, fmt.Errorf("error while retrieving proxies: %v", err) 153 | } 154 | 155 | // Create channels for communicating http response and termination 156 | // event in case of error. 157 | htmlCh := make(chan string) 158 | htmlErrCh := make(chan struct{}) 159 | 160 | // For each tpb proxy, launch the same request through a new 161 | // goroutine. 162 | for _, baseURL := range proxiesList { 163 | fullURL, err := buildSearchURL(baseURL, in) 164 | if err != nil { 165 | log.WithFields(log.Fields{ 166 | "err": err, 167 | "baseURL": baseURL, 168 | }).Info("Could not build url for one of the TPB proxies") 169 | continue 170 | } 171 | go func(url string, localTimeout time.Duration) { 172 | html, _, err := core.Fetch(ctx, url, nil) 173 | if err != nil { 174 | log.WithFields(log.Fields{ 175 | "err": err, 176 | "url": url, 177 | }).Debug("Broken proxy") 178 | htmlErrCh <- struct{}{} 179 | return 180 | } 181 | 182 | ok := checkEmptyResp(html) 183 | if !ok { 184 | log.WithFields(log.Fields{ 185 | "url": url, 186 | }).Debug("Broken proxy (code 200 but empty response)") 187 | htmlErrCh <- struct{}{} 188 | return 189 | } 190 | log.WithFields(log.Fields{ 191 | "url": url, 192 | }).Debug("Found a working proxy") 193 | 194 | htmlCh <- html 195 | }(fullURL, timeout) 196 | 197 | } 198 | 199 | var torrents []Torrent 200 | 201 | // From goroutines receive termination event (in case of error) or 202 | // http response. If http response received, it means the tpb proxy 203 | // worked properly and was the fastest to answer so parse results from html page 204 | // and leave. 205 | for i := 0; i < len(proxiesList); i++ { 206 | select { 207 | case <-htmlErrCh: 208 | case html := <-htmlCh: 209 | torrents, err = parseSearchPage(html) 210 | if err != nil { 211 | return nil, fmt.Errorf("error while parsing torrent search results: %v", err) 212 | } 213 | 214 | return torrents, nil 215 | } 216 | } 217 | 218 | return nil, fmt.Errorf("no tpb proxy working") 219 | } 220 | -------------------------------------------------------------------------------- /torrengo.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "flag" 6 | "fmt" 7 | "net/http" 8 | "os" 9 | "os/exec" 10 | "runtime" 11 | "sort" 12 | "strconv" 13 | "strings" 14 | "syscall" 15 | "time" 16 | 17 | "github.com/olekukonko/tablewriter" 18 | "github.com/onrik/logrus/filename" 19 | log "github.com/sirupsen/logrus" 20 | "golang.org/x/crypto/ssh/terminal" 21 | 22 | "github.com/juliensalinas/torrengo/arc" 23 | "github.com/juliensalinas/torrengo/otts" 24 | "github.com/juliensalinas/torrengo/tpb" 25 | "github.com/juliensalinas/torrengo/ygg" 26 | ) 27 | 28 | // lineBreak sets the OS dependent line break (initialized in init()) 29 | var lineBreak string 30 | 31 | // sources maps source short names to real names 32 | var sources = map[string]string{ 33 | "arc": "Archive", 34 | "tpb": "The Pirate Bay", 35 | "otts": "1337x", 36 | "ygg": "Ygg Torrent", 37 | } 38 | 39 | // isVerbose is used to switch debugging on or off 40 | var isVerbose bool 41 | 42 | // ft is the final torrent the user wants to download 43 | var ft torrent 44 | 45 | // torrent contains meta information about the torrent 46 | type torrent struct { 47 | fileURL string 48 | magnet string 49 | // Description url containing more info about the torrent including the torrent file address 50 | descURL string 51 | name string 52 | size string 53 | seeders int 54 | leechers int 55 | // Date of upload 56 | uplDate string 57 | // Website the torrent is coming from 58 | source string 59 | // Local path where torrent was saved 60 | filePath string 61 | } 62 | 63 | // torListAndHTTPClient contains the torrents found and the http client 64 | type torListAndHTTPClient struct { 65 | torList []torrent 66 | httpClient *http.Client 67 | } 68 | 69 | // search represents the user search 70 | type search struct { 71 | in string 72 | out []torrent 73 | sourcesToLookup []string 74 | httpClient *http.Client 75 | } 76 | 77 | // cleanIn cleans the user search input 78 | func (s *search) cleanIn() error { 79 | // Clean user input by removing useless spaces 80 | strings.TrimSpace(s.in) 81 | 82 | // If user input is empty raise an error 83 | if s.in == "" { 84 | return fmt.Errorf("User input should not be empty") 85 | } 86 | 87 | return nil 88 | } 89 | 90 | // sortOut sorts torrents list based on number of seeders (top down) 91 | func (s *search) sortOut() { 92 | sort.Slice(s.out, func(i, j int) bool { 93 | return s.out[i].seeders > s.out[j].seeders 94 | }) 95 | } 96 | 97 | // render renders torrents in a tabular user-friendly way with colors in terminal 98 | func render(torrents []torrent) { 99 | // Turn type []torrent to type [][]string because this is what tablewriter expects 100 | var renderedTorrents [][]string 101 | for i, t := range torrents { 102 | // Replace -1 by unknown because more user-friendly 103 | seedersStr := strconv.Itoa(t.seeders) 104 | if seedersStr == "-1" { 105 | seedersStr = "Unknown" 106 | } 107 | leechersStr := strconv.Itoa(t.leechers) 108 | if leechersStr == "-1" { 109 | leechersStr = "Unknown" 110 | } 111 | renderedTorrent := []string{ 112 | strconv.Itoa(i), 113 | t.name, 114 | t.size, 115 | seedersStr, 116 | leechersStr, 117 | t.uplDate, 118 | sources[t.source], 119 | } 120 | renderedTorrents = append([][]string{renderedTorrent}, renderedTorrents...) 121 | } 122 | 123 | // Render results using tablewriter 124 | table := tablewriter.NewWriter(os.Stdout) 125 | table.SetHeader([]string{"Index", "Name", "Size", "Seeders", "Leechers", "Date of upload", "Source"}) 126 | table.SetRowLine(true) 127 | table.SetColumnColor( 128 | tablewriter.Colors{tablewriter.Normal, tablewriter.Normal}, 129 | tablewriter.Colors{tablewriter.Normal, tablewriter.Normal}, 130 | tablewriter.Colors{tablewriter.Normal, tablewriter.Normal}, 131 | tablewriter.Colors{tablewriter.Bold, tablewriter.FgHiGreenColor}, 132 | tablewriter.Colors{tablewriter.Bold, tablewriter.FgHiRedColor}, 133 | tablewriter.Colors{tablewriter.Normal, tablewriter.Normal}, 134 | tablewriter.Colors{tablewriter.Normal, tablewriter.Normal}, 135 | ) 136 | table.AppendBulk(renderedTorrents) 137 | table.Render() 138 | } 139 | 140 | // getTorrentFile retrieves and displays torrent file to user. 141 | // TODO(juliensalinas): pass a proper context.Context object instead 142 | // of a mere timeout. 143 | func getTorrentFile(userID, in string, userPass string, 144 | timeout time.Duration, httpClient *http.Client) { 145 | var err error 146 | switch ft.source { 147 | case "arc": 148 | log.WithFields(log.Fields{ 149 | "sourceToSearch": "arc", 150 | }).Debug("Download torrent file") 151 | ft.filePath, err = arc.FindAndDlFile(ft.descURL, in, timeout) 152 | case "ygg": 153 | log.WithFields(log.Fields{ 154 | "sourceToSearch": "ygg", 155 | }).Debug("Download torrent file") 156 | ft.filePath, err = ygg.FindAndDlFile( 157 | ft.descURL, in, userID, userPass, timeout, httpClient) 158 | } 159 | if err != nil { 160 | fmt.Println("Could not retrieve the torrent file (see logs for more details).") 161 | log.WithFields(log.Fields{ 162 | "descURL": ft.descURL, 163 | "error": err, 164 | }).Fatal("Could not retrieve the torrent file") 165 | } 166 | } 167 | 168 | // openMagOrTorInClient opens magnet link or torrent file in user torrent client 169 | func openMagOrTorInClient(resource string, torrentClient string) { 170 | // Open torrent in client 171 | log.WithFields(log.Fields{ 172 | "resource": resource, 173 | "client": torrentClient, 174 | }).Debug("Opening magnet link or torrent file with torrent client") 175 | fmt.Println("Opening torrent in client...") 176 | cmd := exec.Command(torrentClient, resource) 177 | 178 | // Use Start() instead of Run() because do not want to wait for the torrent 179 | // client process to complete (detached process). 180 | err := cmd.Start() 181 | if err != nil { 182 | fmt.Println("Could not open your torrent in client, you need to do it manually (see logs for more details).") 183 | log.WithFields(log.Fields{ 184 | "resource": resource, 185 | "client": torrentClient, 186 | "error": err, 187 | }).Fatal("Could not open torrent in client") 188 | } 189 | } 190 | 191 | // rmDuplicates removes duplicates from slice 192 | func rmDuplicates(elements []string) []string { 193 | encountered := map[string]bool{} 194 | 195 | // Create a map of all unique elements. 196 | for v := range elements { 197 | encountered[elements[v]] = true 198 | } 199 | 200 | // Place all keys from the map into a slice. 201 | result := []string{} 202 | for key := range encountered { 203 | result = append(result, key) 204 | } 205 | return result 206 | } 207 | 208 | // setLogger sets various logging parameters 209 | func setLogger(isVerbose bool) { 210 | // If verbose, set logger to debug, otherwise display errors only 211 | if isVerbose { 212 | log.SetLevel(log.DebugLevel) 213 | } else { 214 | log.SetLevel(log.ErrorLevel) 215 | } 216 | 217 | // Log as standard text 218 | log.SetFormatter(&log.TextFormatter{}) 219 | 220 | // Log as JSON instead of the default ASCII formatter 221 | // log.SetFormatter(&log.JSONFormatter{}) 222 | 223 | // Log filename and line number. 224 | // Should be removed from production because adds a performance cost. 225 | log.AddHook(filename.NewHook()) 226 | } 227 | 228 | func init() { 229 | // Set custom line break in order for the script to work on any OS 230 | if runtime.GOOS == "windows" { 231 | lineBreak = "\r\n" 232 | } else { 233 | lineBreak = "\n" 234 | } 235 | } 236 | 237 | func main() { 238 | // Get command line flags and arguments 239 | flag.Usage = func() { 240 | fmt.Fprintf( 241 | flag.CommandLine.Output(), 242 | "Usage of %[1]s:%[2]s%[2]s\t%[1]s [-s sources] [-t timeout] [-v] arg1 arg2 arg3 ...%[2]s%[2]s"+ 243 | "Examples:%[2]s%[2]s\tSearch 'Alexandre Dumas' on all sources:%[2]s\t\t%[1]s Alexandre Dumas%[2]s"+ 244 | "\tSearch 'Alexandre Dumas' on Archive.org and ThePirateBay only:%[2]s\t\t%[1]s -s arc,tpb Alexandre Dumas%[2]s%[2]s"+ 245 | "Options:%[2]s%[2]s", 246 | os.Args[0], lineBreak, 247 | ) 248 | flag.PrintDefaults() 249 | } 250 | usrSourcesPtr := flag.String("s", "all", "A comma separated list of sources "+ 251 | "you want to search."+lineBreak+"Choices: arc (Archive.org) | tpb (ThePirateBay) | otts (1337x) | ygg (YggTorrent). ") 252 | timeoutInMillisecPtr := flag.Int("t", 20000, "Timeout of HTTP requests in milliseconds. Set it to 0 to completely remove timeout.") 253 | isVerbosePtr := flag.Bool("v", false, "Verbose mode. Use it to see more logs.") 254 | flag.Parse() 255 | 256 | // Get timeout and convert it to a proper Go timeout in nanoseconds 257 | timeoutInMillisec := *timeoutInMillisecPtr 258 | timeout := time.Duration(timeoutInMillisec * 1000 * 1000) 259 | 260 | // Set logging parameters depending on the verbose user input 261 | isVerbose = *isVerbosePtr 262 | setLogger(isVerbose) 263 | 264 | // If no command line argument is supplied, then we stop here 265 | if len(flag.Args()) == 0 { 266 | fmt.Println("Please enter proper arguments (-h for help).") 267 | os.Exit(1) 268 | } 269 | 270 | // Initialize the user search with the user input and sourcesToLookup, and out is zeroed. 271 | // Remove possible duplicates from user input. 272 | // In case user chooses "all" as a source, convert it to the proper source names. 273 | // Stop if a user source is unknown. 274 | // Concatenate all input arguments into one single string in case user does not use quotes. 275 | usrSourcesSlc := strings.Split(*usrSourcesPtr, ",") 276 | cleanedUsrSourcesSlc := rmDuplicates(usrSourcesSlc) 277 | for _, usrSource := range cleanedUsrSourcesSlc { 278 | if usrSource == "all" { 279 | cleanedUsrSourcesSlc = []string{"arc", "tpb", "otts", "ygg"} 280 | break 281 | } 282 | if usrSource != "arc" && usrSource != "tpb" && usrSource != "otts" && usrSource != "ygg" { 283 | fmt.Printf("This website is not correct: %v%v", usrSource, lineBreak) 284 | log.WithFields(log.Fields{ 285 | "sourcesList": cleanedUsrSourcesSlc, 286 | "wrongSource": usrSource, 287 | }).Fatal("Unknown source in user sources list") 288 | } 289 | } 290 | s := search{ 291 | in: strings.Join(flag.Args(), " "), 292 | sourcesToLookup: cleanedUsrSourcesSlc, 293 | } 294 | 295 | // Clean user input 296 | err := s.cleanIn() 297 | if err != nil { 298 | fmt.Println("Could not process your input (see logs for more details).") 299 | log.WithFields(log.Fields{ 300 | "input": s.in, 301 | "error": err, 302 | }).Fatal("Could not clean user input") 303 | } 304 | 305 | // Channels for results 306 | arcTorListCh := make(chan []torrent) 307 | tpbTorListCh := make(chan []torrent) 308 | ottsTorListCh := make(chan []torrent) 309 | yggTorListAndHTTPClientCh := make(chan torListAndHTTPClient) 310 | 311 | // Channels for errors 312 | arcSearchErrCh := make(chan error) 313 | tpbSearchErrCh := make(chan error) 314 | ottsSearchErrCh := make(chan error) 315 | yggSearchErrCh := make(chan error) 316 | 317 | // Launch all torrent search goroutines 318 | log.WithFields(log.Fields{ 319 | "input": s.in, 320 | }).Debug("Launch search...") 321 | for _, source := range s.sourcesToLookup { 322 | switch source { 323 | // User wants to search arc 324 | case "arc": 325 | go func() { 326 | log.WithFields(log.Fields{ 327 | "input": s.in, 328 | "sourceToSearch": "arc", 329 | }).Debug("Start search goroutine") 330 | arcTorrents, err := arc.Lookup(s.in, timeout) 331 | if err != nil { 332 | arcSearchErrCh <- err 333 | return 334 | } 335 | var torList []torrent 336 | for _, arcTorrent := range arcTorrents { 337 | t := torrent{ 338 | descURL: arcTorrent.DescURL, 339 | name: arcTorrent.Name, 340 | size: "Unknown", 341 | leechers: -1, 342 | seeders: -1, 343 | source: "arc", 344 | } 345 | torList = append(torList, t) 346 | } 347 | arcTorListCh <- torList 348 | }() 349 | 350 | // User wants to search tpb 351 | case "tpb": 352 | go func() { 353 | log.WithFields(log.Fields{ 354 | "input": s.in, 355 | "sourceToSearch": "tpb", 356 | }).Debug("Start search goroutine") 357 | tpbTorrents, err := tpb.Lookup(s.in, timeout) 358 | if err != nil { 359 | tpbSearchErrCh <- err 360 | return 361 | } 362 | var torList []torrent 363 | for _, tpbTorrent := range tpbTorrents { 364 | t := torrent{ 365 | magnet: tpbTorrent.Magnet, 366 | name: tpbTorrent.Name, 367 | size: tpbTorrent.Size, 368 | uplDate: tpbTorrent.UplDate, 369 | leechers: tpbTorrent.Leechers, 370 | seeders: tpbTorrent.Seeders, 371 | source: "tpb", 372 | } 373 | torList = append(torList, t) 374 | } 375 | tpbTorListCh <- torList 376 | }() 377 | // User wants to search otts 378 | case "otts": 379 | go func() { 380 | log.WithFields(log.Fields{ 381 | "input": s.in, 382 | "sourceToSearch": "otts", 383 | }).Debug("Start search goroutine") 384 | ottsTorrents, err := otts.Lookup(s.in, timeout) 385 | if err != nil { 386 | ottsSearchErrCh <- err 387 | return 388 | } 389 | var torList []torrent 390 | for _, ottsTorrent := range ottsTorrents { 391 | t := torrent{ 392 | descURL: ottsTorrent.DescURL, 393 | name: ottsTorrent.Name, 394 | size: ottsTorrent.Size, 395 | uplDate: ottsTorrent.UplDate, 396 | leechers: ottsTorrent.Leechers, 397 | seeders: ottsTorrent.Seeders, 398 | source: "otts", 399 | } 400 | torList = append(torList, t) 401 | } 402 | ottsTorListCh <- torList 403 | }() 404 | // User wants to search ygg 405 | case "ygg": 406 | go func() { 407 | log.WithFields(log.Fields{ 408 | "input": s.in, 409 | "sourceToSearch": "ygg", 410 | }).Debug("Start search goroutine") 411 | yggTorrents, httpClient, err := ygg.Lookup(s.in, timeout) 412 | if err != nil { 413 | yggSearchErrCh <- err 414 | return 415 | } 416 | var torList []torrent 417 | for _, yggTorrent := range yggTorrents { 418 | t := torrent{ 419 | descURL: yggTorrent.DescURL, 420 | name: yggTorrent.Name, 421 | size: yggTorrent.Size, 422 | uplDate: yggTorrent.UplDate, 423 | leechers: yggTorrent.Leechers, 424 | seeders: yggTorrent.Seeders, 425 | source: "ygg", 426 | } 427 | torList = append(torList, t) 428 | } 429 | 430 | yggTorListAndHTTPClient := torListAndHTTPClient{torList, httpClient} 431 | yggTorListAndHTTPClientCh <- yggTorListAndHTTPClient 432 | }() 433 | } 434 | } 435 | 436 | // Initialize search errors 437 | var arcSearchErr, tpbSearchErr, ottsSearchErr, yggSearchErr error 438 | 439 | // Gather all goroutines results 440 | for _, source := range s.sourcesToLookup { 441 | switch source { 442 | case "arc": 443 | // Get results or error from arc 444 | select { 445 | case arcSearchErr = <-arcSearchErrCh: 446 | fmt.Printf("An error occured during search on %v%v", sources["arc"], lineBreak) 447 | log.WithFields(log.Fields{ 448 | "input": s.in, 449 | "error": arcSearchErr, 450 | }).Error("The arc search goroutine broke") 451 | case arcTorList := <-arcTorListCh: 452 | s.out = append(s.out, arcTorList...) 453 | log.WithFields(log.Fields{ 454 | "input": s.in, 455 | "sourceToSearch": "arc", 456 | }).Debug("Got search results from goroutine") 457 | } 458 | case "tpb": 459 | // Get results or error from tpb 460 | select { 461 | case tpbSearchErr = <-tpbSearchErrCh: 462 | fmt.Printf("An error occured during search on %v%v", sources["tpb"], lineBreak) 463 | log.WithFields(log.Fields{ 464 | "input": s.in, 465 | "error": tpbSearchErr, 466 | }).Error("The tpb search goroutine broke") 467 | case tpbTorList := <-tpbTorListCh: 468 | s.out = append(s.out, tpbTorList...) 469 | log.WithFields(log.Fields{ 470 | "input": s.in, 471 | "sourceToSearch": "tpb", 472 | }).Debug("Got search results from goroutine") 473 | } 474 | case "otts": 475 | // Get results or error from otts 476 | select { 477 | case ottsSearchErr = <-ottsSearchErrCh: 478 | fmt.Printf("An error occured during search on %v%v", sources["otts"], lineBreak) 479 | log.WithFields(log.Fields{ 480 | "input": s.in, 481 | "error": ottsSearchErr, 482 | }).Error("The otts search goroutine broke") 483 | case ottsTorList := <-ottsTorListCh: 484 | s.out = append(s.out, ottsTorList...) 485 | log.WithFields(log.Fields{ 486 | "input": s.in, 487 | "sourceToSearch": "otts", 488 | }).Debug("Got search results from goroutine") 489 | } 490 | case "ygg": 491 | // Get results or error from ygg 492 | select { 493 | case yggSearchErr = <-yggSearchErrCh: 494 | fmt.Printf("An error occured during search on %v%v", sources["ygg"], lineBreak) 495 | log.WithFields(log.Fields{ 496 | "input": s.in, 497 | "error": yggSearchErr, 498 | }).Error("The ygg search goroutine broke") 499 | case yggTorListAndHTTPClient := <-yggTorListAndHTTPClientCh: 500 | s.out = append(s.out, yggTorListAndHTTPClient.torList...) 501 | s.httpClient = yggTorListAndHTTPClient.httpClient 502 | log.WithFields(log.Fields{ 503 | "input": s.in, 504 | "sourceToSearch": "ygg", 505 | }).Debug("Got search results from goroutine") 506 | } 507 | } 508 | } 509 | // Stop the program only if all goroutines returned an error 510 | if arcSearchErr != nil && tpbSearchErr != nil && ottsSearchErr != nil && yggSearchErr != nil { 511 | fmt.Println("All searches returned an error.") 512 | log.WithFields(log.Fields{ 513 | "input": s.in, 514 | "error": err, 515 | }).Fatal("All searches broke") 516 | } 517 | 518 | // Stop the program if no result found 519 | if len(s.out) == 0 { 520 | fmt.Println("No result found...") 521 | os.Exit(1) 522 | } 523 | 524 | // Sort results (on seeders) 525 | log.Debug("Sort results") 526 | s.sortOut() 527 | 528 | // Render the list of results to user in terminal 529 | log.Debug("Render results") 530 | render(s.out) 531 | 532 | // Read from user input the index of torrent we want to download 533 | reader := bufio.NewReader(os.Stdin) 534 | fmt.Println("Please select a torrent to download (enter its index): ") 535 | var index int 536 | for { 537 | indexStr, err := reader.ReadString('\n') // returns string + delimiter 538 | if err != nil { 539 | fmt.Println("Could not read your input, please try again (should be an integer):") 540 | continue 541 | } 542 | // Remove delimiter which depends on OS + white spaces if any, and convert to integer 543 | index, err = strconv.Atoi(strings.TrimSpace(strings.TrimSuffix(indexStr, lineBreak))) 544 | if err != nil { 545 | fmt.Println("Please enter an integer:") 546 | continue 547 | } 548 | break 549 | } 550 | 551 | // Final torrent we're working on as of now 552 | ft = s.out[index] 553 | log.WithFields(log.Fields{ 554 | "descURL": ft.descURL, 555 | "torrentSource": ft.source, 556 | }).Debug("Got the final torrent to work on") 557 | 558 | // Read from user input whether he wants to open torrent in client or not 559 | reader = bufio.NewReader(os.Stdin) 560 | fmt.Println("Do you want to open torrent in torrent client? [y / n]") 561 | var launchClient string 562 | for { 563 | launchClientStr, err := reader.ReadString('\n') // returns string + delimiter 564 | if err != nil { 565 | fmt.Println("Could not read your input, please try again (should be 'y' or 'n'):") 566 | continue 567 | } 568 | // Remove delimiter which depends on OS + white spaces if any 569 | launchClient = strings.TrimSpace(strings.TrimSuffix(launchClientStr, lineBreak)) 570 | break 571 | } 572 | 573 | var torrentClientAbbr string 574 | if launchClient == "y" { 575 | // Read from user input whether he wants to open torrent in Deluge or QBittorrent client 576 | reader = bufio.NewReader(os.Stdin) 577 | fmt.Println("Do you want to open torrent in Deluge (d), QBittorrent (q), or Transmission (t)?") 578 | for { 579 | torrentClientAbbrStr, err := reader.ReadString('\n') 580 | if err != nil { 581 | fmt.Println("Could not read your input, please try again (should be 'd', 'q' or 't'):") 582 | continue 583 | } 584 | // Remove delimiter which depends on OS + white spaces if any 585 | torrentClientAbbr = strings.TrimSpace(strings.TrimSuffix(torrentClientAbbrStr, lineBreak)) 586 | if torrentClientAbbr != "d" && torrentClientAbbr != "q" && torrentClientAbbr != "t" { 587 | fmt.Println("Please enter a valid torrent client. It should be 'd', 'q' or 't':") 588 | continue 589 | } 590 | break 591 | } 592 | } 593 | 594 | // Convert user input into proper torrent client name 595 | var torrentClient string 596 | switch torrentClientAbbr { 597 | case "d": 598 | torrentClient = "deluge" 599 | case "q": 600 | torrentClient = "qbittorrent" 601 | case "t": 602 | torrentClient = "transmission-gtk" 603 | } 604 | 605 | // Download torrent and optionnaly open in torrent client 606 | switch ft.source { 607 | case "arc": 608 | getTorrentFile("", s.in, "", timeout, nil) 609 | fmt.Printf("Here is your torrent file: %s%s%s", lineBreak, ft.filePath, lineBreak) 610 | if launchClient == "y" { 611 | openMagOrTorInClient(ft.filePath, torrentClient) 612 | } 613 | case "tpb": 614 | fmt.Printf("Here is your magnet link: %s%s%s", lineBreak, ft.magnet, lineBreak) 615 | if launchClient == "y" { 616 | openMagOrTorInClient(ft.magnet, torrentClient) 617 | } 618 | case "otts": 619 | log.WithFields(log.Fields{ 620 | "sourceToSearch": "otts", 621 | }).Debug("Extract magnet") 622 | ft.magnet, err = otts.ExtractMag(ft.descURL, timeout) 623 | if err != nil { 624 | fmt.Println("An error occured while retrieving magnet.") 625 | log.WithFields(log.Fields{ 626 | "descURL": ft.descURL, 627 | "sourcesToLookup": s.sourcesToLookup, 628 | "error": err, 629 | }).Fatal("Could not retrieve magnet") 630 | } 631 | fmt.Printf("Here is your magnet link: %s%s%s", lineBreak, ft.magnet, lineBreak) 632 | if launchClient == "y" { 633 | openMagOrTorInClient(ft.magnet, torrentClient) 634 | } 635 | case "ygg": 636 | var userID string 637 | var userPass string 638 | 639 | reader := bufio.NewReader(os.Stdin) 640 | fmt.Println("You need an Ygg Torrent account to download the file.") 641 | fmt.Println("Please enter your user ID: ") 642 | for { 643 | rawUserID, err := reader.ReadString('\n') 644 | if err != nil { 645 | fmt.Println("Could not read your input, please try again:") 646 | continue 647 | } 648 | userID = strings.TrimSpace(strings.TrimSuffix(rawUserID, lineBreak)) 649 | break 650 | } 651 | fmt.Println("Please enter your user pass: ") 652 | for { 653 | // Using a special lib for password hiding during input 654 | rawUserPassBytes, err := terminal.ReadPassword(int(syscall.Stdin)) 655 | if err != nil { 656 | fmt.Println("Could not read your input, please try again:") 657 | continue 658 | } 659 | rawUserPass := string(rawUserPassBytes) 660 | fmt.Println() 661 | userPass = strings.TrimSpace(strings.TrimSuffix(rawUserPass, lineBreak)) 662 | break 663 | } 664 | getTorrentFile(userID, s.in, userPass, timeout, s.httpClient) 665 | fmt.Printf("Here is your torrent file: %s%s%s", lineBreak, ft.filePath, lineBreak) 666 | if launchClient == "y" { 667 | openMagOrTorInClient(ft.filePath, torrentClient) 668 | } 669 | } 670 | } 671 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------