cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/video.rb

@@ -0,0 +1,352 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Video specific things will be bundled into this file here.
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/video.rb'
+# Cyberweb.embed_youtube_video
+# =========================================================================== #
+module Cyberweb
+
+  begin
+    require 'multimedia_paradise/videos/youtube_embedder.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # Constants specific to Video things go into this file as well.
+  # ========================================================================= #
+  DEFAULT_VIDEO_WIDTH  = '380'
+  DEFAULT_VIDEO_HEIGHT = '260'
+
+  # ========================================================================= #
+  # === imdb                                                       (imdb tag)
+  #
+  # Makes a link towards the "Internet Movie Database".
+  # ========================================================================= #
+  def imdb(
+      title, where_precisely
+    )
+    base_url = 'http://www.imdb.com/title/'
+    string_link(
+      base_url+where_precisely,
+      title
+    )
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.embed_youtube_video                            (youtube tag)
+  #
+  # A note about "autoplay" - this means that it will play the
+  # video as soon as you load the page.
+  #
+  # If the first argument, src, contains a ' ' then we will assume that
+  # we actually wish to pass an Array. In that case, we will split on
+  # every ' ' that we find.
+  #
+  # Usage examples:
+  #
+  #   youtube 'http://www.youtube.com/watch?v=Y6bWezKAlZ0'
+  #   youtube 'XuKjBIBBAL8'
+  #
+  # ========================================================================= #
+  def self.embed_youtube_video(
+      src    = 'gexazLr6pSY',
+      width  = '640',
+      height = '385'
+    )
+    _ = ''.dup
+    src = src.strip if src.is_a? String # We have no use for leading and trailing ' '.
+    if src.is_a? Array
+      src.each {|s| div { embed_youtube_video(s, width, height) } }
+    elsif src.include? ' '
+      src.split(' ').each {|s| div { embed_youtube_video(s) } }
+    else
+      # ===================================================================== #
+      # Prepend proper youtube link:
+      # ===================================================================== #
+      unless src.include?('youtube.com') or src.include?('/')
+        src[0,0] = 'http://www.youtube.com/v/'
+      end
+      if src.include? 'watch'
+        src.gsub!(/watch\?v\=/, 'v/')
+      end
+      _ << '<object class="pad1em mar2em">'+N
+      _ << '<param name="movie" value="'+src+'" />'+N
+      _ << '<param name="wmode" value="transparent" />'+N
+      _ << '<param name="allowFullScreen" value="true" />'+N # Allow fullscreen.
+      _ << '<param name="allowscriptaccess" value="always" />'+N
+      _ << '<embed src="'+src+';autoplay=0" type="application/x-shockwave-flash" width="'+width.to_s+'" height="'+height.to_s+'"></embed>'+N
+      _ << '</object>'
+    end
+    return _
+  end; self.instance_eval { alias eyv              embed_youtube_video } # === Cyberweb.eyv
+       self.instance_eval { alias youtube          embed_youtube_video } # === Cyberweb.youtube
+       self.instance_eval { alias youtube_links    embed_youtube_video } # === Cyberweb.youtube_links
+       self.instance_eval { alias youtube_video    embed_youtube_video } # === Cyberweb.youtube_video
+       self.instance_eval { alias embed_video_file embed_youtube_video } # === Cyberweb.embed_video_file
+       self.instance_eval { alias embed_video      embed_youtube_video } # === Cyberweb.embed_video
+       self.instance_eval { alias embed_videos     embed_youtube_video } # === Cyberweb.embed_videos
+
+  # ========================================================================= #
+  # === imdb_form
+  #
+  # Use this is if you want to display a imdb form.
+  # ========================================================================= #
+  def imdb_form(
+      css_class = ''
+    )
+    result = '<form class="'+css_class+'" method="get" action="http://www.imdb.com/find">'.dup
+    result << '<select name="s">
+    <option selected="on" value="all">All</option>
+    </select>
+    <input name="q" size="28" accesskey="y">'
+    input :submit, :id => 'nb15go', :value => 'Suche',
+      :accesskey => 'x', css_class => 'bblack1 BG_White Black'
+    cform
+    return result
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.video                                           (video tag)
+  #
+  # To show a video in HTML5, this is all you need to do:
+  #
+  #    <video src="movie.ogg" controls="controls">
+  #    </video>
+  #
+  # The most important target is src="", which has to point to a
+  # local, existing video.
+  #
+  # The controls="controls" part can be simplified to just controls,
+  # or so it seems.
+  #
+  # Please note that this <video> element allows multiple source
+  # elements. Source elements can link to different video files.
+  # The browser will use the first recognized format. For some
+  # reason this won't work on localhost with Apache when you
+  # use shortcuts.
+  #
+  # A full example for these multiple source elements would be:
+  #
+  #     <video width="320" height="240" controls="controls">
+  #
+  #       <source src="movie.ogg" type="video/ogg" />
+  #       <source src="movie.mp4" type="video/mp4" />
+  #       <source src="movie.webm" type="video/webm" />
+  #       Your browser does not support the video tag.
+  #
+  #     </video>
+  #
+  # A much shorter example, but still working, should be the following:
+  #
+  #   <video controls src="bunny.mp4"></video>
+  #
+  # Usage examples for this method:
+  #
+  #   video(1)
+  #   video('test.mp4')
+  #   video('foobar.mp4') { :infer_type }
+  #
+  # ========================================================================= #
+  def self.video(
+      url, # ← The first argument should specify where the video file is.
+      optional_width     = :omit_by_default,
+      optional_height    = :omit_by_default, 
+      optional_css_class = '',
+      optional_id        = '',
+      optional_css_style = ''
+    )
+    if url.is_a? Array
+      url.each {|the_url|
+        video(the_url, optional_width, optional_height,
+          optional_css_class, optional_id, optional_css_style)
+      }
+    else
+      # Display the filename next:
+      h4 'Filename: <b>'+url+'</b>'
+      case optional_width
+      when :default
+        optional_width = :omit_by_default
+      end
+      case optional_height
+      when :default
+        optional_height = :omit_by_default
+      end
+      url = url.to_s
+      case url
+      when '1'
+        url = '/home/x/video/Realvids/268_ThePrestige.mp4'
+      when '2'
+        url = '/Depot/Audio/POP_Qualtinger_DialektischeMaterialismusRock.ogg'
+      end
+      if !url.include? '.'
+        url
+      end
+      optional_width  = DEFAULT_VIDEO_WIDTH  if optional_width == :default
+      optional_height = DEFAULT_VIDEO_HEIGHT if optional_height == :default
+      _ = '<video'.dup
+      _ << ' controls' # Use controls.
+      if optional_width and !(optional_width == :omit_by_default)
+        _ << ' width="'+optional_width+'"'
+      end
+      if optional_height and !(optional_height == :omit_by_default)
+        _ << ' height="'+optional_height+'"'
+      end
+      _ << ' css="'+optional_css_class+'"' unless optional_css_class.empty?
+      _ << ' id="'+optional_id+'"' unless optional_id.empty?
+      _ << ' style="'+optional_css_style+'"' unless optional_css_style.empty?
+      # _ << ' controls="controls"'
+      # _ << ' autoplay="autoplay"' # Autoplay.
+      # ===================================================================== #
+      # === Handle blocks next
+      # ===================================================================== #
+      if block_given?
+        yielded = yield
+        case yielded
+        # =================================================================== #
+        # === :infer_type
+        # =================================================================== #
+        when :infer_type
+          _ << 'type="video/"'
+          _ << File.extname(url).delete('.')
+        end
+      end
+      _ << '>' # close the tag here.
+      _ << "\n" # And add a newline as well.
+      ee _
+      # ===================================================================== #
+      # We can re-use _ next:
+      # ===================================================================== #
+      use_this_regex = /#{File.extname(url)}$/
+      url_without_the_file_extension = url.sub(use_this_regex, '')
+      _ =  '  <source src="'+url_without_the_file_extension+
+           File.extname(url)+'" type="video/'+
+           File.extname(url).delete('.')+'" />'+N
+      _ << '  <source src="'+url_without_the_file_extension+'.ogg" type="video/ogg" />'+N
+      _ << '  <source src="'+url_without_the_file_extension+'.webm" type="video/webm" />'+N
+      ee _ # Display it here.
+      ee 'Your browser does not support '+
+         'the video tag.' # display when this tag is not available.
+      c :video
+    end
+  end
+
+  # ========================================================================= #
+  # === video
+  # ========================================================================= #
+  def video(
+      a,
+      b = :omit_by_default,
+      c = :omit_by_default, 
+      d = '',
+      e = '',
+      f = ''
+    )
+    ::Cyberweb.video(a,b,c,d,e,f)
+  end
+
+  # ========================================================================= #
+  # === play_avi_file
+  #
+  # play_avi_file 'foo.avi'
+  # ========================================================================= #
+  def play_avi_file(
+      src = 'data/test.avi'
+    )
+    ee '<object data="'+src+'" type="video/x-msvideo" width="320" height="255">'
+    ee '<param name="src" value="'+src+'">'
+    ee '<param name="autoStart" value="0">'
+    c :object
+  end
+
+  # ========================================================================= #
+  # === embed_flash
+  # ========================================================================= #
+  def embed_flash(src = 'somefilename.swf')
+    ee ' <object width="550" height="400">'
+    ee ' <param name="movie" value="'+src+'">'
+    ee ' <embed src="'+src+'" width="550" height="400">'
+    c :embed
+    c :object
+  end
+
+  # ========================================================================= #
+  # === youtube_embedder
+  #
+  # Make use of Videtools project here, by delegating towards the
+  # YoutubeEmbedder class.
+  #
+  # Usage example:
+  #
+  #    width: 550
+  #
+  # ========================================================================= #
+  def youtube_embedder(
+      url             = 'https://www.youtube.com/watch?v=7L6uEstbd9Y',
+      width_of_video  = DEFAULT_VIDEO_WIDTH,
+      height_of_video = DEFAULT_VIDEO_HEIGHT
+    )
+    if url.is_a? Array
+      url.each {|entry|
+        youtube_embedder(entry, width_of_video, height_of_video)
+      }
+    else
+      url = url.to_s
+      unless url.include? '/'
+        url[0,0] = 'http://www.youtube.com/watch?'
+      end
+      if Object.const_defined? :MultimediaParadise
+        _ = MultimediaParadise::YoutubeEmbedder.new(url, :dont_run_yet)
+        _.set_width  width_of_video  
+        _.set_height height_of_video
+        _.run
+        ee _.embedded_string? # Return the generated string here.
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === play_local_video_file
+  #
+  # This method is used strictly for playing local video files.
+  # ========================================================================= #
+  def play_local_video_file(path_to_the_video_file)
+    # ======================================================================= #
+    # First, try HTML5 playback. If serving as XML, expand `controls`
+    # to `controls="controls"` and autoplay likewise.
+    # ======================================================================= #
+    _ = ''.dup
+    _ << '<video width="640" height="360" controls>'
+    # _ << '<source src="'+path_to_the_video_file+'" type="video/mp4" />'
+    _ << '<source src="'+path_to_the_video_file+'"/>'
+    _ << '<source src="__VIDEO__.OGV" type="video/ogg" />'
+    # ======================================================================= #
+    # Next, fallback to Flash:
+    # ======================================================================= #
+    _ << '<object width="640" height="360" type="application/x-shockwave-flash" data="__FLASH__.SWF">'
+    # ======================================================================= #
+    # Firefox uses the `data` attribute above, IE/Safari uses the param below
+    # ======================================================================= #
+    _ << '<param name="movie" value="__FLASH__.SWF" />
+    <param name="flashvars" value="controlbar=over&amp;image=__POSTER__.JPG&amp;file='+path_to_the_video_file+'" />'
+    # ======================================================================= #
+    # Fallback image. Note the title field below, put the title of
+    # the video there.
+    # ======================================================================= #
+    _ << '<img src="__VIDEO__.JPG" width="640" height="360" alt="__TITLE__"
+       title="No video playback capabilities, please download the video below" />
+    </object>'
+    _ << '</video>'
+    # ======================================================================= #
+    # You *must* offer a download link as they may be able to play the
+    # file locally. Customize this part all you want.
+    # ======================================================================= #
+    _ << '<p> <strong>Download Video:</strong><br>
+    Closed Format: <a href="__VIDEO__.MP4">"MP4"</a><br>
+    Open Format:   <a href="__VIDEO__.OGV">"Ogg"</a>
+    </p>'
+    ee _
+  end
+
+end

data/lib/cyberweb/toplevel_methods/view_source.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/view_source.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.view_source
+  #
+  # Use this method to have a little formular with a button to view the
+  # source code on a webpage.
+  #
+  # Note that since as of July 2011 a new convention is used here - you
+  # can use the input class "view_source" to modify the CSS within
+  # the input html.
+  #
+  # Usage example:
+  #
+  #   div { view_source }
+  #
+  # ========================================================================= #
+  def self.view_source(
+      css_class          = 'wid25',
+      optional_id        = 'view_source',
+      optional_css_style = ''
+    )
+    button_css = 'view_source BG_White Black pad2px'
+    if css_class.is_a? Hash
+      css_class = css_class.delete :css_class
+    end
+    form '', '', '', optional_id, optional_css_style
+      ee '<input class="'+button_css+' '+css_class+'" type="button" value="View Source" '
+      ee 'onClick=\'window.location = "view-source:"+window.location.href\'>'
+    cform
+  end; self.instance_eval { alias vsource view_source } # === Cyberweb.vsource
+
+  # ========================================================================= #
+  # === view_source
+  # ========================================================================= #
+  def view_source(
+      a = 'wid25',
+      b = 'view_source',
+      c = ''
+    )
+    ::Cyberweb.view_source(a,b,c)
+  end; alias vsource view_source # === vsource
+
+end

data/lib/cyberweb/toplevel_methods/web_object.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/web_object.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @web_object
+  #
+  # We initialize a new "instance" of @web_object to nil, at startup.
+  # ========================================================================= #
+  @web_object = nil
+
+  # ========================================================================= #
+  # === Cyberweb.set_web_object
+  #
+  # Only a setter - it is not allowed to do anything else but assign to
+  # the @web_object instance variable.
+  #
+  # Consistently use this method if you wish to modify the @web_object
+  # variable.
+  # ========================================================================= #
+  def self.set_web_object(i)
+    @web_object = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.web_object?
+  #
+  # Keep a reference to the main web_object in use.
+  #
+  # It will be stored in the variable @web_object.
+  # ========================================================================= #
+  def self.web_object?
+    @web_object
+  end; self.instance_eval { alias web_object web_object? } # === Cyberweb.web_object
+       self.instance_eval { alias webobject? web_object? } # === Cyberweb.webobject?
+       self.instance_eval { alias w?         web_object? } # === Cyberweb.w?
+
+end

data/lib/cyberweb/toplevel_methods/write_what_into.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/write_what_into.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.write_what_into
+  # ========================================================================= #
+  def self.write_what_into(
+      what, # The content to write.
+      into  # The file into which this method will write.
+    )
+    begin
+      File.open(into, 'w+') {|file|
+        file.write(what) # Write the new file here.
+      }
+    rescue Errno::EACCES => error # Need to rescue permission errors.
+      pp error
+      pp `whoami`
+      exit
+    end
+  end
+
+end

data/lib/cyberweb/utility_scripts/README.md

@@ -0,0 +1,4 @@
+This directory collects classes that normally are not a necessary
+part of the Cyberweb project. For example, a class that can
+download the baloon-widget is such an example for a "utility
+script".

data/lib/cyberweb/utility_scripts/create_coloured_tags.rb

@@ -0,0 +1,172 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::CreateColouredTags
+#
+# This class can generate the file coloured_tags.rb.
+#
+# That generated file will have entries such as "def aliceblue", so
+# we basically have colours made available in said file.
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class CreateColouredTags < Base # === Cyberweb::CreateColouredTags
+
+  begin
+    require 'convert_global_env'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === STORE_WHERE
+  #
+  # Designate where to store the coloured_tags.rb file.
+  # ========================================================================= #
+  STORE_WHERE = ConvertGlobalEnv.convert(
+    '$CYBERWEB/coloured_tags/coloured_tags.rb' # hardcoded path.
+  ).to_s
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    set_commandline_mode
+    # First, determine where we shall store the file coloured_tags.rb actually.
+    if ENV['CYBERWEB']
+      @store_where = ENV['CYBERWEB'].to_s+'/coloured_tags/coloured_tags.rb'
+    else
+      @store_where = STORE_WHERE
+    end
+    @array_aliases_for_colours = []
+    @_ = ''.dup # This is the main string that will be generated.
+  end
+
+  # ========================================================================= #
+  # === consider_removing_main_file
+  # ========================================================================= #
+  def consider_removing_main_file
+    remove_file(store_where?)
+  end
+
+  # ========================================================================= #
+  # === store_where?
+  # ========================================================================= #
+  def store_where?
+    @store_where
+  end
+
+  # ========================================================================= #
+  # === _
+  # ========================================================================= #
+  def _(i)
+    @_ << i
+  end
+
+  # ========================================================================= #
+  # === populate_main_string_with_data
+  #
+  # This is the method that will generate the code.
+  # ========================================================================= #
+  def populate_main_string_with_data
+    _ '#!/usr/bin/ruby -w'+N
+    _ '# Encoding: UTF-8'+N
+    _ '# frozen_string_literal: true'+N
+    _  return_header
+    _ '# Automatically generated at '+return_date+' from the file'+N
+    _ '# create_coloured_tags.rb'+N
+    _  return_header # This will already append a newline, hence we don't add another one.
+    _ "# require 'cyberweb/coloured_tags/coloured_tags.rb'"+N
+    _  return_header
+    _ 'module Cyberweb'+N+N
+    all_html_colours.each { |colour|
+      _ return_header
+      _ '# === Cyberweb.'+colour+N
+      _ return_header
+      _ "def self.return_"+colour+"(text = '', css_class = '', the_id = '', css_style = '')"+N
+      _ "  ::Cyberweb.string_s(text, 'span', css_class+' "+colour+"', the_id, css_style)"+N
+      _ 'end'+N+N
+      _ return_header
+      _ '# === Cyberweb.'+colour+N
+      _ return_header
+      _ "def self."+colour+"(text = '', css_class = '', the_id = '', css_style = '')"+N
+      _ "  e(text, css_class+' "+colour+"', the_id, css_style)"+N
+      _ 'end'+N+N
+      _ return_header
+      _ '# === '+colour+N
+      _ return_header
+      _ "def "+colour+"(text = '', css_class = '', the_id = '', css_style = '')"+N
+      _ "  ::Cyberweb."+colour+"(text, css_class, the_id, css_style)"+N
+      _ 'end'
+      # ===================================================================== #
+      # Next, we could create an alias for this colour, but only
+      # when we have not already defined such an alias before.
+      # ===================================================================== #
+      the_alias = colour[0,4]
+      unless @array_aliases_for_colours.include? the_alias
+        unless colour == the_alias
+          _ "; alias #{the_alias} #{colour}" if colour.size > 3 # Add an alias here.
+        end
+      end
+      @array_aliases_for_colours << the_alias
+      _ N+N
+    }
+    _ 'end'
+  end
+
+  # ========================================================================= #
+  # === store_data
+  # ========================================================================= #
+  def store_data
+    opnn; e 'Storing into'
+    e
+    e "  #{sfile(store_where?)}"
+    e
+    write_what_into(@_, store_where?)
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    super(NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === return_header
+  # ========================================================================= #
+  def return_header
+    "# =========================================================================== ##{N}"
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    consider_removing_main_file
+    populate_main_string_with_data
+    store_data
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::CreateColouredTags.new
+end # ctags