aspera-cli 4.4.0 → 4.7.0

data/lib/aspera/preview/generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'open3'
 require 'aspera/preview/options'
 require 'aspera/preview/utils'
@@ -60,18 +61,18 @@ module Aspera
 
       # create preview as specified in constructor
       def generate
-        raise "could not detect type of file" if @conversion_type.nil?
+        raise 'could not detect type of file' if @conversion_type.nil?
         method_symb=processing_method_symb
         Log.log.info("#{@source_file_path}->#{@destination_file_path} (#{method_symb})")
         begin
-          self.send(method_symb)
+          send(method_symb)
           # check that generated size does not exceed maximum
           result_size=File.size(@destination_file_path)
           if result_size > @options.max_size
             Log.log.warn("preview size exceeds maximum #{result_size} > #{@options.max_size}")
           end
-        rescue => e
-          Log.log.error("#{e.message}")
+        rescue StandardError => e
+          Log.log.error("Ignoging: #{e.message.to_s}")
           Log.log.debug(e.backtrace.join("\n").red)
           FileUtils.cp(File.expand_path(@preview_format_symb.eql?(:mp4)?'video_error.png':'image_error.png',File.dirname(__FILE__)),@destination_file_path)
         ensure
@@ -93,10 +94,11 @@ module Aspera
       # @param total_count of parts
       # @param index of part (start at 1)
       def get_offset(duration, start_offset, total_count, index)
-        return start_offset + (index-1)*(1.0*duration - start_offset) / total_count
+        raise 'duration must be Float' unless duration.is_a?(Float)
+        return start_offset + ((index-1)*(duration - start_offset) / total_count)
       end
 
-      def convert_video_to_mp4_using_blend()
+      def convert_video_to_mp4_using_blend
         p_duration = Utils.video_get_duration(@source_file_path)
         p_start_offset = @options.video_start_sec.to_i
         p_keyframecount = @options.blend_keyframes.to_i
@@ -124,13 +126,13 @@ module Aspera
       end
 
       # generate n clips starting at offset
-      def convert_video_to_mp4_using_clips()
+      def convert_video_to_mp4_using_clips
         p_duration = Utils.video_get_duration(@source_file_path)
         filelist = File.join(this_tmpdir,'clip_files.txt')
         File.open(filelist, 'w+') do |f|
           1.upto(@options.clips_count.to_i) do |i|
             offset_seconds=get_offset(p_duration,@options.video_start_sec.to_i,@options.clips_count.to_i,i)
-            tmpfilename=sprintf("clip%04d.mp4",i)
+            tmpfilename=format('clip%04d.mp4',i)
             Utils.ffmpeg(
             in_f: @source_file_path,
             in_p: ['-ss',0.9*offset_seconds],
@@ -152,7 +154,7 @@ module Aspera
       end
 
       # do a simple reencoding
-      def convert_video_to_mp4_using_reencode()
+      def convert_video_to_mp4_using_reencode
         Utils.ffmpeg(
         in_f: @source_file_path,
         out_f: @destination_file_path,
@@ -173,7 +175,7 @@ module Aspera
           '-movflags','faststart'])
       end
 
-      def convert_video_to_png_using_fixed()
+      def convert_video_to_png_using_fixed
         Utils.video_dump_frame(
         @source_file_path,
         Utils.video_get_duration(@source_file_path)*@options.thumb_vid_fraction,
@@ -185,12 +187,12 @@ module Aspera
       # ffmpeg -h muxer=apng
       # thumb is 32x32
       # ffmpeg  output.png
-      def convert_video_to_png_using_animated()
+      def convert_video_to_png_using_animated
         Utils.ffmpeg(
         in_f: @source_file_path,
         in_p: [
           '-ss',10, # seek to input position
-          '-t',20, # max seconds
+          '-t',20 # max seconds
         ],
         out_f: @destination_file_path,
         out_p: [
@@ -200,7 +202,7 @@ module Aspera
         ])
       end
 
-      def convert_office_to_png()
+      def convert_office_to_png
         tmp_pdf_file=File.join(this_tmpdir,File.basename(@source_file_path,File.extname(@source_file_path))+'.pdf')
         Utils.external_command(:unoconv,[
           '-f','pdf',
@@ -219,7 +221,7 @@ module Aspera
           @destination_file_path])
       end
 
-      def convert_image_to_png()
+      def convert_image_to_png
         Utils.external_command(:convert,[
           '-auto-orient',
           '-thumbnail',"#{@options.thumb_img_size}x#{@options.thumb_img_size}>",
@@ -232,23 +234,22 @@ module Aspera
       end
 
       # text to png
-      def convert_plaintext_to_png()
+      def convert_plaintext_to_png
         # get 100 first lines of text file
-        first_lines=File.open(@source_file_path){|f|100.times.map{f.readline rescue ''}}.join
+        first_lines=File.open(@source_file_path){|f|100.times.map{f.readline rescue ''}.join}
         Utils.external_command(:convert,[
           '-size',"#{@options.thumb_img_size}x#{@options.thumb_img_size}",
-          'xc:white',
-          '-font','Courier',
+          'xc:white', # define canvas with background color (xc, or canvas) of preceding size
+          '-font',@options.thumb_text_font,
           '-pointsize',12,
-          '-fill','black',
-          '-annotate','+15+15',first_lines,
-          '-trim',
-          '-bordercolor','#FFF',
-          '-border',10,
+          '-fill','black', # font color
+          '-annotate','+0+0',first_lines,
+          '-trim', # avoid large blank regions
+          '-bordercolor','white',
+          '-border',8,
           '+repage',
           @destination_file_path])
       end
-
     end # Generator
   end # Preview
 end # Aspera

data/lib/aspera/preview/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Aspera
   module Preview
     # generator options. Used as parameter to preview generator object.
@@ -11,20 +12,21 @@ module Aspera
       # iw/ih : input width or height
       # -x : keep aspect ratio, having value a multiple of x
       DESCRIPTIONS = [
-        { name: :max_size,             default: 1<<24,              description: "maximum size (in bytes) of preview file" },
-        { name: :thumb_vid_scale,      default: "-1:'min(ih,100)'", description: "png: video: size (ffmpeg scale argument)" },
-        { name: :thumb_vid_fraction,   default: 0.1,                description: "png: video: position of snapshot" },
-        { name: :thumb_img_size,       default: 800,                description: "png: non-video: height (and width)" },
-        { name: :video_conversion,     default: :reencode,          description: "mp4: method for preview generation", :values => VIDEO_CONVERSION_METHODS },
-        { name: :video_png_conv,       default: :fixed,             description: "mp4: method for thumbnail generation", :values => VIDEO_THUMBNAIL_METHODS },
-        { name: :video_start_sec,      default: 10,                 description: "mp4: start offset (seconds) of video preview" },
-        { name: :video_scale,          default: "'min(iw,360)':-2", description: "mp4: video scale (ffmpeg)" },
-        { name: :blend_keyframes,      default: 30,                 description: "mp4: blend: # key frames" },
-        { name: :blend_pauseframes,    default: 3,                  description: "mp4: blend: # pause frames" },
-        { name: :blend_transframes,    default: 5,                  description: "mp4: blend: # transition blend frames" },
-        { name: :blend_fps,            default: 15,                 description: "mp4: blend: frame per second" },
-        { name: :clips_count,          default: 5,                  description: "mp4: clips: number of clips" },
-        { name: :clips_length,         default: 5,                  description: "mp4: clips: length in seconds of each clips" },
+        { name: :max_size,             default: 1<<24,              description: 'maximum size (in bytes) of preview file' },
+        { name: :thumb_vid_scale,      default: "-1:'min(ih,100)'", description: 'png: video: size (ffmpeg scale argument)' },
+        { name: :thumb_vid_fraction,   default: 0.1,                description: 'png: video: position of snapshot' },
+        { name: :thumb_img_size,       default: 800,                description: 'png: non-video: height (and width)' },
+        { name: :thumb_text_font,      default: 'Courier',          description: 'png: plaintext: font to render text with image magick convert, list with: identify -list font' },
+        { name: :video_conversion,     default: :reencode,          description: 'mp4: method for preview generation', values: VIDEO_CONVERSION_METHODS },
+        { name: :video_png_conv,       default: :fixed,             description: 'mp4: method for thumbnail generation', values: VIDEO_THUMBNAIL_METHODS },
+        { name: :video_start_sec,      default: 10,                 description: 'mp4: start offset (seconds) of video preview' },
+        { name: :video_scale,          default: "'min(iw,360)':-2", description: 'mp4: video scale (ffmpeg)' },
+        { name: :blend_keyframes,      default: 30,                 description: 'mp4: blend: # key frames' },
+        { name: :blend_pauseframes,    default: 3,                  description: 'mp4: blend: # pause frames' },
+        { name: :blend_transframes,    default: 5,                  description: 'mp4: blend: # transition blend frames' },
+        { name: :blend_fps,            default: 15,                 description: 'mp4: blend: frame per second' },
+        { name: :clips_count,          default: 5,                  description: 'mp4: clips: number of clips' },
+        { name: :clips_length,         default: 5,                  description: 'mp4: clips: length in seconds of each clips' }
       ]
       # add accessors
       DESCRIPTIONS.each do |opt|

data/lib/aspera/preview/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+require 'English'
 require 'tmpdir'
 require 'fileutils'
 require 'aspera/log'
@@ -12,119 +14,117 @@ module Aspera
       BASH_EXIT_NOT_FOUND=127
       # external binaries used
       EXPERNAL_TOOLS=[:ffmpeg,:ffprobe,:convert,:composite,:optipng,:unoconv]
-      private_constant :BASH_SPECIAL_CHARACTERS,:BASH_EXIT_NOT_FOUND,:EXPERNAL_TOOLS
-
-      # returns string with single quotes suitable for bash if there is any bash metacharacter
-      def self.shell_quote(argument)
-        return argument unless argument.split('').any?{|c|BASH_SPECIAL_CHARACTERS.include?(c)}
-        return "'"+argument.gsub(/'/){|s| "'\"'\"'"}+"'"
-      end
+      TMPFMT='img%04d.jpg'
+      private_constant :BASH_SPECIAL_CHARACTERS,:BASH_EXIT_NOT_FOUND,:EXPERNAL_TOOLS,:TMPFMT
 
-      # check that external tools can be executed
-      def self.check_tools(skip_types=[])
-        EXPERNAL_TOOLS.delete(:unoconv) if skip_types.include?(:office)
-        # Check for binaries
-        EXPERNAL_TOOLS.map{|i|i.to_s}.each do |bin|
-          `#{bin} -h 2>&1`
-          raise "Error: #{bin} is not in the PATH" if $?.exitstatus.eql?(BASH_EXIT_NOT_FOUND)
+      class<<self
+        # returns string with single quotes suitable for bash if there is any bash metacharacter
+        def shell_quote(argument)
+          return argument unless argument.chars.any?{|c|BASH_SPECIAL_CHARACTERS.include?(c)}
+          return "'"+argument.gsub(/'/){|_s| "'\"'\"'"}+"'"
         end
-      end
 
-      # execute external command
-      # one could use "system", but we would need to redirect stdout/err
-      # @return true if su
-      def self.external_command(command_symb,command_args,stdout_return=nil)
-        raise "unexpected command #{command_symb}" unless EXPERNAL_TOOLS.include?(command_symb)
-        # build command line, and quote special characters
-        command=command_args.clone.unshift(command_symb).map{|i| shell_quote(i.to_s)}.join(' ')
-        Log.log.debug("cmd=#{command}".blue)
-        # capture3: only in ruby2+
-        if Open3.respond_to?('capture3') then
-          stdout, stderr, exit_status = Open3.capture3(command)
-        else
-          stderr='<merged with stdout>'
-          stdout=%x[#{command} 2>&1]
-          exit_status=$?
-        end
-        if BASH_EXIT_NOT_FOUND.eql?(exit_status)
-          raise "Error: #{bin} is not in the PATH"
-        end
-        unless exit_status.success?
-          Log.log.error("commandline: #{command}")
-          Log.log.error("Error code: #{exit_status}")
-          Log.log.error("stdout: #{stdout}")
-          Log.log.error("stderr: #{stderr}")
-          raise "command returned error"
+        # check that external tools can be executed
+        def check_tools(skip_types=[])
+          EXPERNAL_TOOLS.delete(:unoconv) if skip_types.include?(:office)
+          # Check for binaries
+          EXPERNAL_TOOLS.each do |command_symb|
+            external_command(command_symb,['-h'])
+          end
         end
-        stdout_return.replace(stdout) unless stdout_return.nil?
-        return exit_status.success?
-      end
 
-      def self.ffmpeg(a)
-        raise "error: hash expected" unless a.is_a?(Hash)
-        #input_file,input_args,output_file,output_args
-        a[:gl_p]||=[
-          '-y', # overwrite output without asking
-          '-loglevel','error', # show only errors and up]
-        ]
-        a[:in_p]||=[]
-        a[:out_p]||=[]
-        raise "wrong params (#{a.keys.sort})" unless [:gl_p, :in_f, :in_p, :out_f, :out_p].eql?(a.keys.sort)
-        external_command(:ffmpeg,[a[:gl_p],a[:in_p],'-i',a[:in_f],a[:out_p],a[:out_f]].flatten)
-      end
+        # execute external command
+        # one could use "system", but we would need to redirect stdout/err
+        # @return true if su
+        def external_command(command_symb,command_args)
+          raise "unexpected command #{command_symb}" unless EXPERNAL_TOOLS.include?(command_symb)
+          # build command line, and quote special characters
+          command=command_args.clone.unshift(command_symb).map{|i| shell_quote(i.to_s)}.join(' ')
+          Log.log.debug("cmd=#{command}".blue)
+          # capture3: only in ruby2+
+          if Open3.respond_to?('capture3')
+            stdout, stderr, exit_status = Open3.capture3(command)
+          else
+            stderr='<merged with stdout>'
+            stdout=%x(#{command} 2>&1)
+            exit_status=$CHILD_STATUS
+          end
+          if BASH_EXIT_NOT_FOUND.eql?(exit_status)
+            raise "Error: #{command_symb} is not in the PATH"
+          end
+          unless exit_status.success?
+            Log.log.error("commandline: #{command}")
+            Log.log.error("Error code: #{exit_status}")
+            Log.log.error("stdout: #{stdout}")
+            Log.log.error("stderr: #{stderr}")
+            raise "#{command_symb} error #{exit_status}"
+          end
+          return {status: exit_status, stdout: stdout}
+        end
 
-      def self.video_get_duration(input_file)
-        result = String.new
-        external_command(:ffprobe,[
-          '-loglevel','error',
-          '-show_entries','format=duration',
-          '-print_format','default=noprint_wrappers=1:nokey=1',
-          input_file],result)
-        result.to_f
-      end
+        def ffmpeg(a)
+          raise 'error: hash expected' unless a.is_a?(Hash)
+          #input_file,input_args,output_file,output_args
+          a[:gl_p]||=[
+            '-y', # overwrite output without asking
+            '-loglevel','error' # show only errors and up]
+          ]
+          a[:in_p]||=[]
+          a[:out_p]||=[]
+          raise "wrong params (#{a.keys.sort})" unless [:gl_p, :in_f, :in_p, :out_f, :out_p].eql?(a.keys.sort)
+          external_command(:ffmpeg,[a[:gl_p],a[:in_p],'-i',a[:in_f],a[:out_p],a[:out_f]].flatten)
+        end
 
-      TMPFMT='img%04d.jpg'
+        # @return Float in seconds
+        def video_get_duration(input_file)
+          result=external_command(:ffprobe,[
+            '-loglevel','error',
+            '-show_entries','format=duration',
+            '-print_format','default=noprint_wrappers=1:nokey=1',
+            input_file])
+          return result[:stdout].to_f
+        end
 
-      def self.ffmpeg_fmt(temp_folder)
-        return File.join(temp_folder,TMPFMT)
-      end
+        def ffmpeg_fmt(temp_folder)
+          return File.join(temp_folder,TMPFMT)
+        end
 
-      def self.get_tmp_num_filepath(temp_folder, file_number)
-        return File.join(temp_folder,sprintf(TMPFMT,file_number))
-      end
+        def get_tmp_num_filepath(temp_folder, file_number)
+          return File.join(temp_folder,format(TMPFMT,file_number))
+        end
 
-      def self.video_dupe_frame(temp_folder, index, count)
-        input_file=get_tmp_num_filepath(temp_folder,index)
-        1.upto(count) do |i|
-          FileUtils.ln_s(input_file,get_tmp_num_filepath(temp_folder,index+i))
+        def video_dupe_frame(temp_folder, index, count)
+          input_file=get_tmp_num_filepath(temp_folder,index)
+          1.upto(count) do |i|
+            FileUtils.ln_s(input_file,get_tmp_num_filepath(temp_folder,index+i))
+          end
         end
-      end
 
-      def self.video_blend_frames(temp_folder, index1, index2)
-        img1=get_tmp_num_filepath(temp_folder,index1)
-        img2=get_tmp_num_filepath(temp_folder,index2)
-        count=index2-index1-1
-        1.upto(count) do |i|
-          percent = 100 * i / (count + 1)
-          filename = get_tmp_num_filepath(temp_folder, index1 + i)
-          external_command(:composite,['-blend',percent,img2,img1,filename])
+        def video_blend_frames(temp_folder, index1, index2)
+          img1=get_tmp_num_filepath(temp_folder,index1)
+          img2=get_tmp_num_filepath(temp_folder,index2)
+          count=index2-index1-1
+          1.upto(count) do |i|
+            percent = 100 * i / (count + 1)
+            filename = get_tmp_num_filepath(temp_folder, index1 + i)
+            external_command(:composite,['-blend',percent,img2,img1,filename])
+          end
         end
-      end
 
-      def self.video_dump_frame(input_file, offset_seconds, scale, output_file, index=nil)
-        output_file=get_tmp_num_filepath(output_file,index) unless index.nil?
-        ffmpeg(
-        in_f: input_file,
-        in_p: ['-ss',offset_seconds],
-        out_f: output_file,
-        out_p: ['-frames:v',1,'-filter:v',"scale=#{scale}"])
-        return output_file
-      end
+        def video_dump_frame(input_file, offset_seconds, scale, output_file, index=nil)
+          output_file=get_tmp_num_filepath(output_file,index) unless index.nil?
+          ffmpeg(
+          in_f: input_file,
+          in_p: ['-ss',offset_seconds],
+          out_f: output_file,
+          out_p: ['-frames:v',1,'-filter:v',"scale=#{scale}"])
+          return output_file
+        end
 
-      def message_to_png(message)
-        # convert -size 400x  -background '#666666' -fill '#ffffff'  -interword-spacing 10 -kerning 4 -pointsize 10 -gravity West -size x22 label:"Lorem dolor sit amet" -flatten xxx.png
-        external_command(:convert,[
-        ])
+        def unused_message_to_png(_message)
+          # convert -size 400x  -background '#666666' -fill '#ffffff'  -interword-spacing 10 -kerning 4 -pointsize 10 -gravity West -size x22 label:"Lorem dolor sit amet" -flatten xxx.png
+          external_command(:convert,[])
+        end
       end
     end # Options
   end # Preview

data/lib/aspera/{proxy_auto_config.erb.js → proxy_auto_config.js}

@@ -1,16 +1,8 @@
 // inspired by PACSuppport.js, 2003-2004 by Apple Computer, Inc., all rights reserved
-function dnsResolve(host) {
-	if (host == '<%=context_host%>' || host == '<%=context_ip%>')
-		return '<%=context_ip%>';
-	throw 'only DNS for initial host, not '+host;  
-}
-function myIpAddress() {
-	return '<%=context_self%>';
-}
 function isPlainHostName(host) {
 	return (host.indexOf('.') == -1 ? true : false);
 }
-function dnsDomainIs(host, domain) {    
+function dnsDomainIs(host, domain) {
 	var h = host.toLowerCase();
 	var d = domain.toLowerCase();
 	var sub = h.substring(h.length - d.length, h.length);
@@ -35,7 +27,7 @@ function isInNet(host, pattern, mask) {
 		var a = ip.split('.');
 		if ((p.length == m.length) && (m.length == a.length)) {
 			for (i = 0; i < p.length; i++) {
-				if ((p[i]& m[i]) != (m[i]& a[i]))
+				if ((p[i] & m[i]) != (m[i] & a[i]))
 					return false;
 			}
 			return true;
@@ -108,7 +100,7 @@ function dateRange() {
 	var today = new Date();
 	var num = arguments.length;
 	var gmt = arguments[num - 1];
-	if (typeof gmt !=  "string")
+	if (typeof gmt != "string")
 		gmt = false;
 	else {
 		gmt = gmt.toUpperCase();
@@ -137,8 +129,7 @@ function dateRange() {
 					y2 = arg;
 				else
 					return false;
-			}
-			else if (!arg)
+			} else if (!arg)
 				return false;
 			else if (!d1)
 				d1 = arg;
@@ -146,13 +137,12 @@ function dateRange() {
 				d2 = arg;
 			else
 				return false;
-		}
-		else if (typeof arg == "string") {
+		} else if (typeof arg == "string") {
 			var months = "JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC";
 			arg = arg.toUpperCase();
 			arg = months.indexOf(arg);
 			if (arg == -1)
-				return false;            
+				return false;
 			arg /= 3;
 			arg += 1;
 			if (!m1)
@@ -161,23 +151,27 @@ function dateRange() {
 				m2 = arg;
 			else
 				return false;
-		}
-		else
+		} else
 			return false;
 	}
-	if (!y1) y1 = gmt ? today.getUTCFullYear() : today.getFullYear();
-	if (!y2) y2 = y1;
-	if (!m1) m1 = (gmt ? today.getUTCMonth() : today.getMonth()) + 1;
-	if (!m2) m2 = m1;
-	if (!d1) d1 = gmt ? today.getUTCDate() : today.getDate();
-	if (!d2) d2 = d1;
+	if (!y1)
+		y1 = gmt ? today.getUTCFullYear() : today.getFullYear();
+	if (!y2)
+		y2 = y1;
+	if (!m1)
+		m1 = (gmt ? today.getUTCMonth() : today.getMonth()) + 1;
+	if (!m2)
+		m2 = m1;
+	if (!d1)
+		d1 = gmt ? today.getUTCDate() : today.getDate();
+	if (!d2)
+		d2 = d1;
 	var date1;
 	var date2;
 	if (gmt) {
 		date1 = Date.UTC(y1, m1 - 1, d1, 0, 0, 0, 0);
 		date2 = Date.UTC(y2, m2 - 1, d2, 23, 59, 59, 999);
-	}
-	else {
+	} else {
 		date1 = (Date(y1, m1 - 1, d1, 0, 0, 0, 0)).valueOf();
 		date2 = (Date(y2, m2 - 1, d2, 23, 59, 59, 999)).valueOf();
 	}
@@ -190,7 +184,7 @@ function timeRange() {
 	var date2 = new Date();
 	var num = arguments.length;
 	var gmt = arguments[num - 1];
-	if (typeof gmt !=  "string")
+	if (typeof gmt != "string")
 		gmt = false;
 	else {
 		gmt = gmt.toUpperCase();
@@ -226,8 +220,7 @@ function timeRange() {
 				date2.setUTCSeconds(arg);
 				break;
 			}
-		}
-		else {
+		} else {
 			switch (i) {
 			case 0:
 				date1.setHours(arg);
@@ -262,8 +255,7 @@ function timeRange() {
 					date2.setUTCSeconds(arg);
 					break;
 				}
-			}
-			else {
+			} else {
 				switch (i) {
 				case 0:
 					date2.setHours(arg);