multimedia_paradise 1.1.314

data/lib/multimedia_paradise/sinatra/app.rb

@@ -0,0 +1,311 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::Sinatra
+# =========================================================================== #
+# require 'multimedia_paradise/sinatra/app.rb'
+# MultimediaParadise.start_sinatra
+# MultimediaParadise.run_app
+# =========================================================================== #
+module MultimediaParadise
+
+require 'sinatra'
+
+class Sinatra < ::Sinatra::Base
+
+  require 'multimedia_paradise/constants/encodings.rb'
+  require 'multimedia_paradise/toplevel_methods/files_and_directories.rb'
+  require 'multimedia_paradise/toplevel_methods/n_local_videos.rb'
+  require 'multimedia_paradise/toplevel_methods/output_directory.rb'
+  require 'multimedia_paradise/toplevel_methods/return_all_video_files.rb'
+
+  begin
+    require 'beautiful_url'
+  rescue LoadError; end
+
+  begin
+    require 'open-uri'
+  rescue LoadError; end
+
+  begin
+    require 'json'
+  rescue LoadError; end
+
+  include Colours::E
+  include Colours
+  require 'multimedia_paradise/sinatra/embeddable_interface.rb'
+  include MultimediaParadise::EmbeddableInterface
+
+  # require 'sinatra/reloader'
+  # register ::Sinatra::Reloader
+
+  configure do
+    mime_type :avi, 'video/avi'
+  end
+
+  set :public_folder, BASE_DIR_TO_THE_REALVIDS
+  # available_simpsons_directories = Dir['/home/x/video/Cartoons/*'].select {|entry|
+  #   File.directory?(entry)
+  # }.map {|inner_entry| "#{inner_entry}/".squeeze('/') }
+
+  # @random_simpsons_directory = available_simpsons_directories.sample
+  # Sinatra does not allow for multiple public folder directories.
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-03/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-04/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-05/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-06/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-08/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-09/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-11/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-12/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-13/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-14/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-15/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-16/'
+  # set :public_folder, '/home/x/video/Cartoons/Simpsons-18/'
+  # set :public_folder, @random_simpsons_directory
+  # ^^^ Unfortunately the above does not work - sinatra wants only
+  #     one public directory.
+
+  # ========================================================================= #
+  # === MultimediaParadise::Sinatra.simpsons_directory?
+  # ========================================================================= #
+  def self.simpsons_directory?
+    @random_simpsons_directory
+  end
+
+  set :port, USE_THIS_PORT
+
+  # ========================================================================= #
+  # Try to enable sessions:
+  # ========================================================================= #
+  enable :sessions
+
+  # ========================================================================= #
+  # === before                                                     (before tag)
+  # ========================================================================= #
+  before {
+    content_type(:html, 'charset' => USE_THIS_ENCODING )
+  }
+
+  # ========================================================================= #
+  # === IS_ROEBE
+  # ========================================================================= #
+  IS_ROEBE = true
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+    reset
+    if File.directory? ::MultimediaParadise.log_dir?
+      MultimediaParadise.cd(::MultimediaParadise.log_dir?)
+    end
+    if IS_ROEBE
+      require 'open'
+      # ===================================================================== #
+      # Tell us which port will be used:
+      # ===================================================================== #
+      target = "http://localhost:#{USE_THIS_PORT}/"
+      e sfancy(target)
+      Thread.new {
+        sleep 1.0
+        Open.in_browser(target)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === /view                                                     (view tag)
+  #
+  # http://localhost:5580/view
+  # ========================================================================= #
+  get('/view') {
+    return_view
+  }
+
+  # ========================================================================= #
+  # === /n_local_videos
+  #
+  # http://localhost:5580/n_local_videos
+  # ========================================================================= #
+  get('/n_local_videos') {
+    return_n_local_videos
+  }
+
+  # ========================================================================= #
+  # === /view                                                      (view tag)
+  #
+  # http://localhost:5580/view/php
+  # ========================================================================= #
+  get('/view/*'){
+    # use_these_params = params[:splat]
+    # if params.has_key?('user_input')
+    #   use_these_params = params.fetch('user_input')
+    # end
+    result = ''.dup
+    result << html_and_body_start
+    result << 'Hello world!'
+    result
+  }
+
+  # ========================================================================= #
+  # === file exists
+  #
+  # This one must come last, so that the earlier APIs continue to work.
+  # If the file exists as-is then this is not necessary, though. But
+  # we want to allow something like "027" or "27" as well.
+  # Actually, it does not have to come last AT ALL. http://localhost:5580/027_StarTrekII.mp4
+  #
+  # The <video> element allows us to embed video files into an HTML, very
+  # similar to the way images are embedded.
+  #
+  # Usage examples:
+  #
+  #   http://localhost:5580/file_exists/252
+  #   http://localhost:5580/file_exists/229_Ronal_the_Barbarian.mp4
+  #
+  # ========================================================================= #
+  get('/file_exists/*') {
+    _ = params[:splat]
+    _ = _.join(' ').strip if _.is_a? Array
+    result = ''.dup
+    result << html_and_body_start
+    if _ =~ /^\d+/i # If it is a number.
+      dataset = YAML.load_file(MultimediaParadise.file_video_collection)
+      result = MultimediaParadise.return_filename_of_this_video_file(_.to_i) # => "024_Convoy"
+      if result
+        file_location = Dir["*#{result}*"]
+        file_location = file_location.first if file_location.is_a? Array
+      end
+      _ = _.to_i
+      if dataset.has_key?(_)
+        result << p('Is this available: yes')
+        result << p('Does the file at <b>'+file_location.to_s+
+                    '</b> exist: '+File.exist?(file_location).to_s)
+        result << '<video controls autoplay><source src="'+File.basename(file_location)+'"></video>'
+      else
+        result << p('Is this available: no')
+      end
+    end
+    result << return_to_root_link
+    result
+  }
+
+  # ========================================================================= #
+  # === / Entry point
+  #
+  # This is the root of our web-application.
+  # ========================================================================= #
+  get('/') {
+    return_main_index
+  }
+
+  # ========================================================================= #
+  # === /available_simpsons_files
+  #
+  # http://localhost:5580/available_simpsons_files
+  # ========================================================================= #
+  get('/available_simpsons_files') {
+    return_available_simpsons_files
+  }
+
+  # ========================================================================= #
+  # === /available_video_files
+  #
+  # http://localhost:5580/available_video_files
+  # ========================================================================= #
+  get('/available_video_files') {
+    return_available_video_files
+  }
+
+  Dir[BASE_DIR_TO_THE_REALVIDS+'*'].each {|this_route|
+    get('/'+File.basename(this_route)) {
+      result = ''.dup
+      result << html_and_body_start
+      send_file(this_route)
+    }
+  }
+
+  # ========================================================================= #
+  # === /listing
+  #
+  # This is definitely shorter than the other more verbose variant.
+  #
+  # http://localhost:5580/listing
+  # ========================================================================= #
+  get('/listing') {
+    return_listing
+  }
+
+  # ========================================================================= #
+  # === /random_video
+  # ========================================================================= #
+  get('/random_video') {
+    return_random_video
+  }
+
+  # ========================================================================= #
+  # === /play
+  # ========================================================================= #
+  get('/play') {
+    return_play_splat
+  }
+
+  # ========================================================================= #
+  # === /play/*                                                    (play tag)
+  #
+  # http://localhost:5580/play
+  # http://localhost:5580/play/003
+  # http://localhost:5580/play/228_Apocalypto.mp4
+  # ========================================================================= #
+  get('/play/*') {
+    return_play_splat
+  }
+
+  require 'multimedia_paradise/toplevel_methods/to_mp4.rb'
+  # ========================================================================= #
+  # === /to_mp4/*                                                 (play tag)
+  #
+  # Usage example:
+  #
+  #   http://localhost:5580/to_mp4/223_Conan_the_Barbarian.avi
+  #
+  # ========================================================================= #
+  get('/to_mp4/*') {
+    _ = params[:splat]
+    _ = _.join(' ').strip if _.is_a? Array
+    target = BASE_DIR_TO_THE_REALVIDS+_
+    result = MultimediaParadise.to_mp4(target)
+    if File.exist? result
+      Cyberweb::HtmlTemplate[
+        title: result,
+        body: 'The file is now available at: '+result,
+        body_css_style: 'font-size: 1.2em;',
+        css_classes: 'darkblue'
+      ].to_s
+    end
+  }
+
+end
+
+# =========================================================================== #
+# === MultimediaParadise.run_app
+# =========================================================================== #
+def self.run_app
+  MultimediaParadise::Sinatra.run!
+end; self.instance_eval { alias start_sinatra run_app } # === MultimediaParadise.start_sinatra
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  MultimediaParadise.run_app
+end # multimedia_paradise_run_app

data/lib/multimedia_paradise/sinatra/embeddable_interface.rb

@@ -0,0 +1,379 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === MultimediaParadise::EmbeddableInterface
+#
+# The code in this file can be used to "embed" the functionality of
+# MultimediaParadise in web-applications, in particular in sinatra.
+#
+# This depends on the cyberweb project.
+# =========================================================================== #
+# require 'multimedia_paradise/sinatra/embeddable_interface.rb'
+# include MultimediaParadise::EmbeddableInterface
+# =========================================================================== #
+module MultimediaParadise
+
+module EmbeddableInterface # === MultimediaParadise::EmbeddableInterface
+
+  begin
+    require 'cyberweb/requires/require_the_html_template.rb'
+  rescue LoadError; end
+
+  begin
+    require 'html_tags'
+    include HtmlTags::BaseModule
+  rescue LoadError; end
+
+  begin
+    require 'cyberweb/sinatra/custom_extensions.rb'
+    include Cyberweb::Sinatra::CustomExtensions
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'MultimediaParadise Web-API'
+
+  # ========================================================================= #
+  # === TITLE_TAG
+  # ========================================================================= #
+  TITLE_TAG = '<title>'+TITLE+'</title>'
+
+  # ========================================================================= #
+  # === USE_THIS_PORT
+  # ========================================================================= #
+  USE_THIS_PORT = '5580'
+
+  # ========================================================================= #
+  # === USE_THIS_ENCODING
+  # ========================================================================= #
+  USE_THIS_ENCODING = MultimediaParadise::USE_THIS_ENCODING
+
+  # ========================================================================= #
+  # === BASE_DIR_TO_THE_REALVIDS
+  # ========================================================================= #
+  BASE_DIR_TO_THE_REALVIDS = '/home/x/video/Realvids/'
+
+  # ========================================================================= #
+  # === @route_name
+  # ========================================================================= #
+  @route_name = ''.dup
+
+  # ========================================================================= #
+  # === MultimediaParadise::EmbeddableInterface.set_route_name
+  # ========================================================================= #
+  def self.set_route_name(i)
+    @route_name = i
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::EmbeddableInterface.route_name?
+  # ========================================================================= #
+  def self.route_name?
+    @route_name
+  end
+
+  # ========================================================================= #
+  # === route_name?
+  # ========================================================================= #
+  def route_name?
+    ::MultimediaParadise::EmbeddableInterface.route_name?
+  end
+
+  # ========================================================================= #
+  # === sub_routes?
+  # ========================================================================= #
+  def sub_routes?
+    ::MultimediaParadise::EmbeddableInterface.sub_routes?
+  end
+
+  # ========================================================================= #
+  # === return_root_string
+  # ========================================================================= #
+  def return_root_string
+    _ = ''.dup
+    MultimediaParadise::EmbeddableInterface.sub_routes?.each_pair {|key, value|
+      _ << abr(value)
+    }
+    html {
+      '<title>Multimedia Paradise Embeddable Interface</title>'+
+      '<body>'+
+      p(_,'','',
+        'font-size: 1.6em'
+      )+'</body>'
+    }
+  end
+
+  # ========================================================================= #
+  # === return_view
+  # ========================================================================= #
+  def return_view
+    route_to_this_action = sub_routes?[:view]
+    result = html_and_body_start+
+             p('View the following package:')
+    result = result.dup if result.frozen?
+    result << div(css_style: 'padding: 0.2em') {
+      p(
+        '<b>Search for a local video file:</b>',
+        css_style: 'padding:0.75em'
+      )+
+      '<form id="view" style="margin-left:2em; margin-top:2px" action="'+route_to_this_action+'">
+      <input type="text" name="user_input" style="border:3px solid slateblue; padding: 4px"><br>
+      <input type="submit" name="user_input_submit" value="Display" style="2px dotted royalblue; '\
+      'color: white; background-color: olive; font-size: 1.40em; margin:2px; padding: 4px">
+      </form>'+
+      return_to_root_link
+    }
+    result
+  end
+
+  # ========================================================================= #
+  # === return_to_root_link
+  # ========================================================================= #
+  def return_to_root_link
+    p {
+      a('/', content: 'Home')
+    }
+  end
+
+  # ========================================================================= #
+  # === return_available_simpsons_files
+  # ========================================================================= #
+  def return_available_simpsons_files(
+      simpsons_files = Dir['/home/x/video/Cartoons/Simpsons**/**']
+    )
+    result = ''.dup
+    result << html_and_body_start
+    result << p('The following simpsons files are available locally:')
+    result << '<div style="padding: 0.7em">'
+    simpsons_files.each.each {|entry|
+      _ = entry
+      entry_embedded_as_a_href = '<a href="'+_.to_s+'">'+entry+'</a>'
+      result << "<b style=\"margin-left:3em\">#{entry_embedded_as_a_href}</b> "\
+                " ("+
+                "<a href=\"#{File.basename(entry)}\">Play local file here)</a>"+
+                "<br>\n"
+    }
+    result << '</div>'
+    result << 'The current public directory is: '+
+              MultimediaParadise::Sinatra.simpsons_directory?.to_s
+    result << return_to_root_link
+    result
+  end
+
+  # ========================================================================= #
+  # === return_html_head_and_title_and_body
+  # ========================================================================= #
+  def return_html_head_and_title_and_body
+    '<html><head>'+TITLE_TAG+'</head><body>'
+  end
+
+  # ========================================================================= #
+  # === MultimediaParadise::EmbeddableInterface.sub_routes?
+  #
+  # Define all sub-routes here.
+  # ========================================================================= #
+  def self.sub_routes?
+    {
+      view:                     route_name?+'/view',
+      n_local_videos:           route_name?+'/n_local_videos',
+      available_video_files:    route_name?+'/available_video_files',
+      available_simpsons_files: route_name?+'/available_simpsons_files',
+      listing:                  route_name?+'/listing',
+      play:                     route_name?+'/play',
+      random_video:             route_name?+'/random_video'
+    }
+  end
+
+  # ========================================================================= #
+  # === return_random_video
+  # ========================================================================= #
+  def return_random_video
+    this_video = Dir[BASE_DIR_TO_THE_REALVIDS+'*'].sample
+    abr(
+      '/'+File.basename(this_video),
+      content: this_video
+    )+
+    br+
+    abr(
+      '/',
+      content: 'Back to the main index'
+    )
+  end
+
+  # ========================================================================= #
+  # === html_and_body_start
+  # ========================================================================= #
+  def html_and_body_start
+    '<html>'+TITLE_TAG+
+    '<body style="font-size: 1.3em">'
+  end
+
+  # ========================================================================= #
+  # === title?
+  # ========================================================================= #
+  def title?
+    TITLE
+  end
+
+  # ========================================================================= #
+  # === return_main_index                                        (main index)
+  # ========================================================================= #
+  def return_main_index
+    '<html>'+TITLE_TAG+
+    '<body style="font-size: larger">This is the <b>www-interface</b> '\
+    'for the sinatra interface of the <b>MultimediaParadise</b> project. '\
+    'The encoding that will be used is: <b>'+USE_THIS_ENCODING.to_s+'</b>'+
+    return_available_actions+
+    '<body></html>'
+  end
+
+  # ========================================================================= #
+  # === return_n_local_videos
+  #
+  # This method will show how many local videos are available.
+  # ========================================================================= #
+  def return_n_local_videos
+    html_and_body_start+
+    p('There are <b>'+MultimediaParadise.n_local_videos?.to_s+
+      '</b> local videos available.')+
+    return_to_root_link
+  end
+
+  # ========================================================================= #
+  # === return_available_video_files
+  # ========================================================================= #
+  def return_available_video_files(
+      i = MultimediaParadise.available_video_files
+    )
+    dataset = YAML.load_file(MultimediaParadise.file_video_collection)
+    # ======================================================================= #
+    # The 'imdb' entry is relevant here, such as:
+    #   "imdb"=>"https://www.imdb.com/title/tt0074285/"
+    # As key we need the number.
+    # ======================================================================= #
+    result = ''.dup
+    result << html_and_body_start
+    result << p('The following video files are available locally:')
+    result << '<div style="padding: 0.7em">'
+    i.each {|entry|
+      # ===================================================================== #
+      # duration = MultimediaParadise.duration_of?(entry)
+      # ===================================================================== #
+      number = File.basename(entry)[0,4].to_i # Must be an integer.
+      if dataset[number]
+        _ = dataset[number]['imdb']
+        entry_embedded_as_a_href = '<a href="'+_.to_s+'">'+entry+'</a>'
+        result << "<b style=\"margin-left:3em\">#{entry_embedded_as_a_href}</b> "\
+                  " ("+
+                  "<a href=\"/#{File.basename(entry)}\">Play local file here)</a>"+
+                  "<br>\n"
+      end
+    }
+    result << '</div>'
+    result << return_to_root_link
+    result
+  end
+
+  # ========================================================================= #
+  # === return_available_actions                                 (main index)
+  #
+  # This method provides an overview, as HTML string, over the available
+  # actions.
+  # ========================================================================= #
+  def return_available_actions
+    hash = MultimediaParadise::EmbeddableInterface.sub_routes?
+    html_and_body_start+
+    p(
+      'The following entry points are available so far:'
+    )+
+    p(css_style: 'padding:10px; margin-left: 2em') {
+      abr(hash[:view],                     content: '/view',                     css_style: :bold)+ # /view
+      abr(hash[:n_local_videos],           content: '/n_local_videos',           css_style: :bold)+ # /n_local_videos
+      abr(hash[:available_video_files],    content: '/available_video_files',    css_style: :bold)+ # /available_video_files
+      abr(hash[:available_simpsons_files], content: '/available_simpsons_files', css_style: :bold)+ # /available_simpsons_files
+      abr(hash[:listing],                  content: '/listing',                  css_style: :bold)+ # /listing
+      abr(hash[:play],                     content: '/play',                     css_style: :bold)+ # /play
+      abr(hash[:random_video],             content: '/random_video',             css_style: :bold)  # /random_video
+    }
+  end
+
+  # ========================================================================= #
+  # === return_listing
+  #
+  # This is accessible via:
+  #
+  #   http://localhost:5580/listing
+  #
+  # ========================================================================= #
+  def return_listing
+    result = ''.dup
+    result << html_and_body_start
+    result << p('The following video files are available locally:')
+    result << '<div style="font-size: 0.8em; padding: 0.1em">'
+    MultimediaParadise.available_video_files.each {|entry|
+      result << "<b style=\"margin-left:1em\">#{File.basename(entry)}</b> "\
+                "<br>"
+    }
+    result << '</div>'
+    result << return_to_root_link
+    result
+  end
+
+  # ========================================================================= #
+  # === return_play_splat
+  # ========================================================================= #
+  def return_play_splat
+    _ = params[:splat]
+    _ = _.first if _.is_a? Array
+    result = ''.dup
+    if _.nil?
+      # ===================================================================== #
+      # In this case the user did not supply any argument, e. g. no video
+      # file to play.
+      # ===================================================================== #
+      result << p('This API lets you play video files (if they are available locally).')
+      result << p('Simply pass the name of the video file to the URL.')
+    else
+      result << p("The following video files are available locally:\n")
+      unless File.exist?(_)
+        target = BASE_DIR_TO_THE_REALVIDS+_+'*'
+        globbed = Dir[target]
+        unless globbed.empty?
+          globbed = globbed.sort_by {|entry| entry[0,1] }.reverse # This will sort .mp4 before .avi.
+          _ = globbed.first.to_s
+        end
+      end
+      relative_target = '../' * (_.count('/')+1)
+      result << '<div class="darkblue" style="font-size: 0.8em; padding: 0.1em">'
+      result << '<video controls width="1024" autoplay><source src="'+relative_target+File.basename(_)+'"></video>'
+      # result << '<video controls autoplay><source src="'+
+      #            BASE_DIR_TO_THE_REALVIDS+
+      #            File.basename(_)+'"></video>'
+      result << '</div>'
+    end
+    result << return_to_root_link
+    Cyberweb::HtmlTemplate[
+      title: title?,
+      body: result,
+      body_css_style: 'font-size: 1.2em;',
+      css_classes: 'darkblue'
+    ].to_s
+  end
+
+end
+
+# =========================================================================== #
+# === MultimediaParadise.embeddable_interface
+#
+# This method can be used to "embed" a fake-object that implements the
+# module defined above.
+# =========================================================================== #
+def self.embeddable_interface
+  object = Object.new
+  object.extend(MultimediaParadise::EmbeddableInterface)
+  return object
+end
+
+end