subs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: facdb8dca51a4b869a8a9e2a5fdb3e080f74233bbe2bb31623fdf8936fd5140a
+  data.tar.gz: 591083900e3632a7f02baecbdec45b71a0c6591db930a3c384d4388e9d8f40c7
+SHA512:
+  metadata.gz: c51953160fc97bfe8fa880e3048b89059674723edd572b2a509c5099e19b10bc27b5f69441c4d4b5b6620eb3eae87cdf12ca930c83afd690a2db8e5112dd77a8
+  data.tar.gz: ec3192fe49b366d8c7c1657bfe36a3a1da17c7f7e43a33627b55c35e69fc2a2787fc98e623fb7a73e10dd41289f4f4fb09124a960186d54dba26f51500f8aad6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/.idea
+/.vs
+/.vscode
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at efreed09@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Gem dependencies specified in in subs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ForeverZer0
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Subs
+
+Subs aims for making fetching subtitles for all your favorite movies and television shows a few keystrokes away using a simple and intuitive command-line interface. It uses multiple search algorithms for determining the best matching subtitle for video files that it finds, including using provider hashing algorithms (preferred), filename and name, and IMDb IDs.
+
+It currently ships with two primary providers that it can utilize, [SubDB](http://thesubdb.com/) and [OpenSubtitles](https://www.opensubtitles.org), as they both are open-source, and contain some of the largest collections of subtitles available anywhere. They both also expose a public API and custom hashing algorithm to drastically increase quality of results, and are much faster and more accurate than web-scraping. More providers will likely be added in the future.
+ 
+Subs also comes with a utility for easily re-syncing existing SubRip (.srt) subtitle files if they do not match the video audio exactly. This feature is often included in video players, but this will allow for permanently saving the file with the corrected offset extremely easily.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'subs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subs
+
+## Usage
+
+Once installed, open a terminal/command window and use the following basic syntax:
+```
+subs COMMAND [ARGUMENTS] [OPTIONS]
+```
+
+Subs can run in a fully-automatic mode that will recursively search folders for video files, find matching subtitles, and download/rename them appropriately, or fully-manual one file at a time and you select the subtitle from a list, or anywhere in between, the choice is yours.
+
+You are encouraged to the view the [Wiki](https://github.com/ForeverZer0/subs/wiki) for a full explanation of each command, but to quickly see a list of available commands, use the following command:
+```
+subs --help
+```
+or...
+```
+subs --help COMMAND
+```
+...to see a brief explanation of the specified command and its options.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ForeverZer0/subs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Subs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/osdb_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/subs

@@ -0,0 +1,286 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'json'
+require_relative '../lib/subs'
+
+module Subs
+  class CLI < Thor
+
+    class_option :version, type: :boolean, desc: 'Display version string', aliases: '-v'
+    class_option :quiet, type: :boolean, desc: 'Do not show any output', aliases: '-q'
+    class_option :debug, type: :boolean, desc: 'Show more verbose output', aliases: '-d'
+
+    if Dir.exist?(File.expand_path('~/.config'))
+      CONFIG_PATH = File.expand_path('~/.config/subs.json')
+    else
+      CONFIG_PATH = File.expand_path('~/.subs')
+    end
+
+    PROVIDERS = [SubDB, OpenSubtitles]
+
+    def initialize(*args)
+      super(*args)
+
+      if options[:quiet]
+        Subs.create_log(STDOUT, :fatal)
+      elsif options[:debug]
+        Subs.create_log(STDOUT, :debug)
+      end
+
+      if options[:version] != options[:quiet]
+        say "Subs v.#{Subs::VERSION}"
+      end
+
+      begin
+        @config = JSON.parse(File.read(CONFIG_PATH), symbolize_names: true)
+        Subs.log.debug { "Configuration loaded successfully" }
+      rescue
+        Subs.log.debug { "Failed to load user configuration, using default" }
+        @config = default_config
+        File.open(CONFIG_PATH, 'wb') { |io| io.write(JSON.pretty_generate(@config)) } rescue nil
+      end
+    end
+
+    desc 'find [PATH1 [,PATH2]]... [OPTIONS]', 'Input file/directory path(s) that video files will be searched for'
+    method_option :recursive, type: :boolean, desc: 'Search directories recursively', aliases: '-r', default: false
+    method_option :clobber, type: :boolean, desc: 'Overwrite existing subtitles', aliases: '-c', default: false
+    method_option :auto, type: :boolean,  desc: 'Automatically select best match and fetch without prompt', aliases: '-a', default: true
+    method_option :method, type: :string, desc: 'Sets the search method', aliases: '-m', enum: %w(hash name any), default: 'hash'
+    method_option :provider, type: :string, desc: 'Set which subtitles provider(s) are used', aliases: '-p', enum: %w(all subdb osdb), default: 'all'
+    method_option :language, type: :string, desc: 'ISO-639 language code for desired subtitle language', aliases: '-l'
+    method_option :test, type: :boolean, desc: 'Perform a dry-run without writing anything to disk', aliases: '-t'
+    def find(*paths)
+      # Compile list of videos to process
+      paths.push(Dir.pwd) if paths.empty?
+      videos = build_video_list(*paths)
+      # Parse our arguments
+      language = get_language(options[:language] || @config[:language])
+      providers = get_providers(options[:provider])
+      Subs.log.info { "Found #{videos.size.to_s.light_blue} videos to query"}
+      # Perform search
+      results = {}
+      videos.each do |video|
+        # Skip searching for videos that already have subtitles unless --clobber flag was passed
+        if !options[:clobber] && Subs.subtitle_exist?(video, language)
+          Subs.log.info { "Skipping #{File.basename(video).yellow}" }
+          next
+        end
+        # Create instance of each provider, and apply specified search methods for each
+        results[video] = []
+        providers.each do |klass|
+          klass.new do |provider|
+            results[video] += search(provider, video, language, options[:method].to_sym)
+          end
+        end
+        Subs.log.info { "Found #{results[video].size.to_s.light_blue} results for #{File.basename(video).yellow}"}
+      end
+      process_results(results)
+    end
+
+    desc 'sync <path> [+|-]<ms>', 'Offsets SubRip subtitle timings by number of milliseconds'
+    method_option :backup, type: :boolean, desc: 'Backup original file', aliases: '-b'
+    def sync(path, ms)
+      unless File.exist?(path)
+        Subs.log.error { "Cannot resolve path '#{path}'"}
+        return
+      end
+      return if options[:backup] && !backup_file(path)
+      match = /^([+-])?(\d+)$/.match(ms)
+      unless match
+        Subs.log.error { "Invalid offset parameter #{ms}".red }
+        exit
+      end
+      offset = Integer(ms)
+      regex = /^(\d{2}):(\d{2}):(\d{2}),(\d+) --> (\d{2}):(\d{2}):(\d{2}),(\d+)$/
+      buffer = StringIO.new
+
+      begin
+        File.open(path, 'rb').each do |line|
+
+          match = regex.match(line)
+          unless match
+            buffer.write(line)
+            next
+          end
+
+          t1 = Subs::SubRipTime.new(*match[1..4].map(&:to_i)) + offset
+          t2 = Subs::SubRipTime.new(*match[5..8].map(&:to_i)) + offset
+          buffer.write("#{t1} --> #{t2}\n")
+        end
+
+        buffer.seek(0, IO::SEEK_SET)
+        File.open(path, 'wb') { |io| io.write(buffer.read) }
+      rescue
+        Subs.log.error { "Error occurred during subtilte re-sync".red }
+      end
+    end
+
+    desc 'config <name> <value>', 'Sets and stores a configuration option to persist across each run'
+    def config(name, value)
+      begin
+        key = name.to_sym
+        if value.nil? && @config.has_key?(key)
+          @config.delete(key)
+          return
+        end
+        @config[key] = value
+        File.open(CONFIG_PATH, 'wb') { |io| io.write(JSON.pretty_generate(@config)) }
+      rescue
+        Subs.log.error { 'Error occurred setting configuration option' }
+      end
+    end
+
+    no_commands do
+
+      def default_config
+        # Make half-attempt at getting the actual system language, otherwise just go with English
+        begin
+          env = ENV['LANG']
+          match = /([a-z]{2})_[A-Z][A-Z]\..+/.match(env)
+          language = Language.from_alpha2(match[1]).alpha3
+        rescue
+          language = 'eng'
+        end
+        {
+            language: language,
+            credentials: {}
+        }
+      end
+
+      def build_video_list(*paths)
+        videos = []
+        paths.each do |path|
+          if File.directory?(path)
+            videos += Subs.video_search(path, options[:recursive])
+          elsif File.exist?(path)
+            ext = File.extname(path)
+            Subs.log.warn { "Unrecognized video extension: ''#{ext}''" } unless Subs::VIDEO_EXTENSIONS.include?(ext)
+            videos << File.expand_path(path)
+          else
+            Subs.log.warn { "Unable to resolve path '#{path}', skipping" }
+          end
+        end
+        videos
+      end
+
+      def prune_list(videos)
+        # Reject videos that already have subtitles unless "clobber" option is present
+        count = videos.count
+        videos.reject! { |v| Subs.subtitle_exist?(v, *options[:lang]) }
+        if videos.count != count
+          diff = count - videos.count
+          Subs.log.info { "Existing subtitles found for #{diff.to_s.light_blue}, skipping." }
+        end
+      end
+
+      def backup_file(path)
+        unless File.exist?(path)
+          Subs.log.error { "Cannot resolve path '#{path}'"}
+          return false
+        end
+        bak = File.expand_path(path) + '.bak'
+        if File.exist?(bak)
+          Subs.log.debug { "Backup file '#{bak}' already exists" }
+          return true
+        end
+
+        begin
+          File.open(bak, 'wb') do |dest|
+            File.open(path, 'rb') { |src| dest.write(src.read) }
+          end
+          Subs.log.debug { "Back up of #{path.yellow} was successful" }
+          return true
+        rescue
+          Subs.log.error { "Error occurred during backup of '#{path}'"}
+          return false
+        end
+      end
+
+      def get_providers(name)
+        return case name
+        when 'all' then PROVIDERS
+        when 'subdb' then [SubDB]
+        when 'osdb' then [OpenSubtitles]
+        else
+          Subs.log.error { "Invalid provider: #{name}" }
+          exit
+        end
+      end
+
+      def get_language(code)
+        code = code || @config[:language]
+        iso639 = case code.size
+        when 2 then Language.from_alpha2(code)
+        when 3 then Language.from_alpha3(code)
+        else nil
+        end
+        unless iso639
+          Subs.log.error { "Unsupported language code specified: #{code}"}
+          exit
+        end
+        iso639
+      end
+
+      def search(provider, video, language, method)
+        results = []
+        # Search by hash if :hash or :any flag
+        if provider.is_a?(HashSearcher) && (method == :hash || method == :any)
+          results += provider.hash_search(video, language)
+        end
+        # Search by filename if :name flag, or :any flag and hash search failed
+        if provider.is_a?(FilenameSearcher) && (method == :name || (method == :any && results.empty?))
+          results += provider.filename_search(video, language)
+        end
+        results
+      end
+
+      def process_results(results)
+        choices = []
+        results.each_pair do |video, list|
+          # Continue if no results for video
+          next if list.empty?
+          # Pick the first result (most probable) if --auto switch is set
+          if options[:auto]
+            choices << list.first
+            next
+          end
+          say
+          say "Select subtitle for #{File.basename(video).yellow}"
+          list.each_with_index do |result, i|
+            puts "  #{(i + 1).to_s.rjust(2).light_blue}. #{result.name} (#{result.provider_name.blue})"
+          end
+          say
+          input = ask 'Input number of choice, or leave blank to skip:  '
+          i = input.chomp.strip.to_i rescue 0
+          choices << list[i - 1] if i > 0
+        end
+        # Process the pruned results
+        process_choices(choices.compact)
+      end
+
+      def process_choices(results)
+        Subs.log.info { "Processing #{results.size.to_s.light_blue} results..." }
+        # Group results by which provider they use
+        results.group_by(&:provider).each_pair do |klass, list|
+          klass.new do |provider|
+            # Instantiate the provider and process the results
+            list.each do |result|
+              name = File.basename(result.video).yellow
+              begin
+                path = Subs.build_subtitle_path(result.video, result.language)
+                File.open(path, 'wb') { |io| provider.process_result(io, result) }
+                Subs.log.info { "  Successfully processed #{name}".green }
+              rescue
+                Subs.log.error { "  Failed to process #{name}".red }
+              end
+            end
+          end
+        end
+        Subs.log.info { "Processing complete" }
+      end
+    end
+  end
+end
+
+Subs::CLI.start(ARGV)