crabgrass_media 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d09be8b214809ae6616a5126df305f329876c7ad
+  data.tar.gz: ce7bc5c445c29e015eccde25093b94d5d5c3a419
+SHA512:
+  metadata.gz: d87316cc0f0719e2f2f7ab0cd222b13e2dad38c38962aa104bf433c957e5b9f1102011a6e2569000cb170f3199c16dc3a67b998a1e521b3f07f1868a8ade3b28
+  data.tar.gz: 5aa9cfe9a207f706eb78fcf88963c8340e30f8693acb4f99317286eeb0e8f6d1c81749e6d785f0af1de6380d1436a6b9cbf937d428cd5f1c82335361c809534c

data/README.md

@@ -0,0 +1,29 @@
+Crabgrass::Media is the Media engine of Crabgrass.
+
+Crabgrass is a web application designed for activist groups to be better able to collaborate online. Mostly, it is a glorified wiki with fine-grain control over access rights.
+
+Crabgrass::Media is a rails engine to do media transformations.
+
+You can add new media transformations by subclassing Transmogrifier.
+
+Example usage:
+
+```ruby
+  transmog = Media.transmogrifier(:input_file => 'myfile.odt', :output_file => 'myfile.jpg')
+  status = transmog.run do |progress|
+    puts progress
+  end
+```
+
+Requirements:
+
+
+Strongly suggested:
+
+```sh
+  gem install mime-types
+```
+
+Crabgrass and Crabgrass::Media are based on Ruby on Rails and MySQL.
+They are released under the AGPL license, version 3.
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Media'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/config/initializers/paths.rb

@@ -0,0 +1,9 @@
+unless defined?(Media::TMP_PATH)
+  if defined?(Rails)
+    Media::TMP_PATH = File.join(Rails.root, 'tmp', 'media')
+  else
+    Media::TMP_PATH = File.join('', 'tmp', 'media')
+  end
+end
+
+FileUtils.mkdir_p(Media::TempFile.tempfile_path) unless File.exist?(Media::TempFile.tempfile_path)

data/lib/media.rb

@@ -0,0 +1,64 @@
+require 'media/mime_type'
+require 'media/temp_file'
+require 'media/transmogrifier'
+require 'media/transmogrifiers/graphicsmagick'
+require 'media/transmogrifiers/inkscape'
+require 'media/transmogrifiers/libremagick'
+require 'media/transmogrifiers/libreoffice'
+
+module Media
+
+  #
+  # creates a new instance of transmogrifier suitable for turning
+  # input into output.
+  #
+  def self.transmogrifier(options)
+    if options[:input_type]
+      input_type = Media::MimeType.simple options[:input_type]
+    elsif options[:input_file]
+      input_type = Media::MimeType.mime_type_from_extension options[:input_file]
+    else
+      raise ArgumentError.new
+    end
+
+    if options[:output_type]
+      output_type = Media::MimeType.simple options[:output_type]
+    elsif options[:output_file]
+      output_type = Media::MimeType.mime_type_from_extension options[:output_file]
+    else
+      raise ArgumentError.new
+    end
+
+    unless input_type and output_type
+      raise ArgumentError.new("Both input and output types are required (given %s -> %s)." % [input_type||'nil', output_type||'nil'])
+    end
+
+    transmog_class = Transmogrifier.find_class(input_type, output_type)
+    if transmog_class
+      transmog_class.new(options)
+    end
+  end
+
+  def self.may_produce?(src_type, dst_type)
+    Transmogrifier.find_class(src_type, dst_type)
+  end
+
+  #
+  # special graphicsmagick hooks.
+  # we use graphicsmagick in order to parse the dimensions of image files.
+  #
+
+  def self.has_dimensions?(mime_type)
+    if Transmogrifier.list["Media::GraphicsMagickTransmogrifier"]
+      Transmogrifier.list["Media::GraphicsMagickTransmogrifier"].input_types.include? mime_type
+    end
+  end
+
+  def self.dimensions(filepath)
+    if Transmogrifier.list["Media::GraphicsMagickTransmogrifier"]
+      Transmogrifier.list["Media::GraphicsMagickTransmogrifier"].dimensions filepath
+    end
+  end
+
+end
+

data/lib/media/mime_type.rb

@@ -0,0 +1,272 @@
+begin
+  require 'mime/types'
+rescue LoadError => exc
+  puts "WARNING! no mime-types gem installed"
+  puts "you should really do 'gem install mime-types'"
+end
+
+
+module Media
+  module MimeType
+
+    def self.mime_group(mime_type)
+      mime_type.sub(/\/.*$/,'/') if mime_type     # remove everything after /
+    end
+
+    def self.simple(mime_type)
+      mime_type.to_s.sub(/\/x\-/,'/') if mime_type # remove x-
+    end
+
+    def self.lookup(mime_type,field)
+      (MIME_TYPES[simple(mime_type)]||[])[field]
+    end
+
+#    def self.group_from_mime_type(mime_type)
+#      lookup(mime_type,GROUP) || lookup(mime_group(mime_type),GROUP)
+#    end
+
+    def self.icon_for(mtype)
+      lookup(mtype,ICON) || lookup(mime_group(mtype),ICON) || lookup('default',ICON)
+    end
+
+    def self.asset_class_from_mime_type(mime_type)
+      asset_symbol_from_mime_type(mime_type).to_s.classify
+    end
+
+    def self.asset_symbol_from_mime_type(mime_type)
+      lookup(mime_type,ASSET_CLASS) || lookup(mime_group(mime_type),ASSET_CLASS) || lookup('default',ASSET_CLASS)
+    end
+
+    def self.extension_from_mime_type(mime_type)
+      lookup(mime_type,EXT)
+    end
+
+    def self.mime_type_from_extension(ext)
+      ext = ext.to_s
+      ext = File.extname(ext).gsub('.','') if ext =~ /\./
+      mimetype = EXTENSIONS[ext]
+      if defined?(MIME::Types)
+        unless MIME::Types.type_for('.'+ext).empty?
+          mimetype ||= MIME::Types.type_for('.'+ext).first.content_type
+        end
+      end
+      mimetype ||= 'application/octet-stream'
+      return mimetype
+    end
+
+    #
+    # perhaps use http://code.google.com/p/mimetype-fu/
+    # for all this?
+    def self.type_for(filename)
+      self.mime_type_from_extension(filename)
+      # todo: add type_from_file_command if ext doesn't pan out.
+    end
+
+    #def type_from_file_command(filename)
+    #  #  On BSDs, `file` doesn't give a result code of 1 if the file doesn't exist.
+    #  type = (filename.match(/\.(\w+)$/)[1] rescue "octet-stream").downcase
+    #  mime_type = (Paperclip.run("file", "-b --mime-type :file", :file => filename).split(':').last.strip rescue "application/x-#{type}")
+    #  mime_type = "application/x-#{type}" if mime_type.match(/\(.*?\)/)
+    #  mime_type
+    #end
+
+    def self.description_from_mime_type(mime_type)
+      lookup(mime_type,DESCRIPTION) || lookup(mime_group(mime_type),DESCRIPTION) || lookup('default',DESCRIPTION)
+    end
+
+    def self.compatible_types?(type1, type2)
+      (TYPE_ALIASES[type1] || []).include?(type2)
+    end
+
+    EXT = 0; ICON = 1; ASSET_CLASS = 2; DESCRIPTION = 3;
+    MIME_TYPES = {
+      # mime_type       => [file_extension, icon, asset_class, description]
+      'default'         => [nil,'default',:asset,'Unknown'],
+
+      'text/'           => [:txt,:html,:text_asset, 'Text'],
+      'text/plain'      => [:txt,:html,:text_asset, 'Text'],
+      'text/html'       => [:html,:html,:text_asset, 'Webpage'],
+      'application/rtf' => [:rtf,:rtf,:text_asset, 'Rich Text'],
+      'text/rtf'        => [:rtf,:rtf,:text_asset, 'Rich Text'],
+      'text/sgml'       => [:sgml,:xml,nil,'XML'],
+      'text/xml'        => [:xml,:xml,nil,'XML'],
+      'text/csv'        => [:csv,:spreadsheet,:doc_asset, 'Comma Separated Values'],
+      'text/comma-separated-values' => [:csv,:spreadsheet,:doc_asset, 'Comma Separated Values'],
+
+      'application/pdf'   => [:pdf,:pdf,:image_asset, 'Portable Document Format'],
+      'application/bzpdf' => [:pdf,:pdf,:image_asset, 'Portable Document Format'],
+      'application/gzpdf' => [:pdf,:pdf,:image_asset, 'Portable Document Format'],
+      'application/postscript' => [:ps,:pdf,:image_asset,'Postscript'],
+
+      'text/spreadsheet'     => [:txt,:spreadsheet,:doc_asset,'Spreadsheet'],
+      'application/gnumeric' => [:gnumeric,:spreadsheet,:doc_asset,'Gnumeric'],
+      'application/kspread'  => [:kspread,:spreadsheet,:doc_asset,'KSpread'],
+
+      'application/scribus' => [:scribus,:doc,nil,'Scribus'],
+      'application/abiword' => [:abw,:doc,:doc_asset,'Abiword'],
+      'application/kword'   => [:kwd,:doc,:doc_asset,'KWord'],
+
+
+      'application/msword'     => [:doc,:msword,:text_asset,'MS Word'],
+      'application/mswrite'    => [:doc,:msword,:text_asset,'MS Write'],
+      'application/powerpoint' => [:ppt,:mspowerpoint,:doc_asset,'MS Powerpoint'],
+      'application/excel'      => [:xls,:msexcel,:spreadsheet_asset,'MS Excel'],
+      'application/access'     => [nil, :msaccess, :doc_asset,'MS Access'],
+      'application/vnd.ms-msword'     => [:doc,:msword,:text_asset,'MS Word'],
+      'application/vnd.ms-mswrite'    => [:doc,:msword,:text_asset,'MS Write'],
+      'application/vnd.ms-powerpoint' => [:ppt,:mspowerpoint,:doc_asset,'MS Powerpoint'],
+      'application/vnd.ms-excel'      => [:xls,:msexcel,:spreadsheet_asset,'MS Excel'],
+      'application/vnd.ms-access'     => [nil, :msaccess, :doc_asset,'MS Access'],
+      'application/msword-template'     => [:dot,:msword,:text_asset,'MS Word Template'],
+      'application/excel-template'      => [:xlt,:msexcel,:spreadsheet_asset,'MS Excel Template'],
+      'application/powerpoint-template' => [:pot,:mspowerpoint,:doc_asset,'MS Powerpoint Template'],
+
+      'application/vnd.openxmlformats-officedocument.presentationml.presentation' =>
+        [:pptx, :mspowerpoint,:doc_asset,'MS Powerpoint'],
+      'application/vnd.openxmlformats-officedocument.presentationml.presentation' =>
+        [:pptm, :mspowerpoint,:doc_asset,'MS Powerpoint'],
+      'application/vnd.openxmlformats-officedocument.presentationml.template' =>
+        [:potx,:mspowerpoint,:doc_asset,'MS Powerpoint Template'],
+
+      'application/vnd.openxmlformats-officedocument.wordprocessingml.document' =>
+        [:docm,:msword,:text_asset,'MS Word'],
+      'application/vnd.openxmlformats-officedocument.wordprocessingml.document' =>
+        [:docx,:msword,:text_asset,'MS Word'],
+      'application/vnd.openxmlformats-officedocument.wordprocessingml.template' =>
+        [:dotx,:msword,:text_asset,'MS Word Template'],
+
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' =>
+        [:xlsm,:msexcel,:spreadsheet_asset,'MS Excel'],
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' =>
+        [:xlsx,:msexcel,:spreadsheet_asset,'MS Excel'],
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.template' =>
+        [:xltx,:msexcel,:spreadsheet_asset,'MS Excel Template'],
+
+      'application/executable'        => [nil,:binary,nil,'Program'],
+      'application/ms-dos-executable' => [nil,:binary,nil,'Program'],
+      'application/octet-stream'      => [nil,:binary,nil],
+
+      'application/shellscript' => [:sh,:shell,nil,'Script'],
+      'application/ruby'        => [:rb,:ruby,nil,'Script'],
+
+      'application/vnd.oasis.opendocument.spreadsheet'  =>
+        [:ods,:oo_spreadsheet,:spreadsheet_asset, 'OpenDocument Spreadsheet'],
+      'application/vnd.oasis.opendocument.formula'      =>
+        [nil,:oo_spreadsheet,:spreadsheet_asset, 'OpenDocument Formula'],
+      'application/vnd.oasis.opendocument.chart'        =>
+        [nil,:oo_spreadsheet,:spreadsheet_asset, 'OpenDocument Chart'],
+      'application/vnd.oasis.opendocument.image'        =>
+        [nil,:oo_graphics, :doc_asset, 'OpenDocument Image'],
+      'application/vnd.oasis.opendocument.graphics'     =>
+        [:odg,:oo_graphics, :doc_asset, 'OpenDocument Graphics'],
+      'application/vnd.oasis.opendocument.presentation' =>
+        [:odp,:oo_presentation,:doc_asset, 'OpenDocument Presentation'],
+      'application/vnd.oasis.opendocument.database'     =>
+        [:odf,:oo_database,:doc_asset, 'OpenDocument Database'],
+      'application/vnd.oasis.opendocument.text-web'     =>
+        [:html,:oo_html,:doc_asset, 'OpenDocument Webpage'],
+      'application/vnd.oasis.opendocument.text'         =>
+        [:odt,:oo_document,:doc_asset, 'OpenDocument Text'],
+      'application/vnd.oasis.opendocument.text-master'  =>
+        [:odm,:oo_document,:doc_asset, 'OpenDocument Master'],
+
+      'application/vnd.oasis.opendocument.presentation-template' =>
+        [:otp,:oo_presentation,:doc_asset, 'OpenDocument Presentation'],
+      'application/vnd.oasis.opendocument.graphics-template'     =>
+        [:otg,:oo_graphics,:doc_asset, 'OpenDocument Graphics'],
+      'application/vnd.oasis.opendocument.spreadsheet-template'  =>
+        [:ots,:oo_spreadsheet,:spreadsheet_asset, 'OpenDocument Spreadsheet'],
+      'application/vnd.oasis.opendocument.text-template'         =>
+        [:ott,:oo_document,:doc_asset, 'OpenDocument Text'],
+
+      'packages/'        => [nil,:archive,nil,'Archive'],
+      'multipart/zip'    => [:zip,:archive,nil,'Archive'],
+      'multipart/gzip'   => [:gzip,:archive,nil,'Archive'],
+      'multipart/tar'    => [:tar,:archive,nil,'Archive'],
+      'application/zip'  => [:gzip,:archive,nil,'Archive'],
+      'application/gzip' => [:gzip,:archive,nil,'Archive'],
+      'application/rar'  => [:rar,:archive,nil,'Archive'],
+      'application/deb'  => [:deb,:archive,nil,'Archive'],
+      'application/tar'  => [:tar,:archive,nil,'Archive'],
+      'application/stuffit'        => [:sit,:archive,nil,'Archive'],
+      'application/compress'       => [nil,:archive,nil,'Archive'],
+      'application/zip-compressed' => [:zip,:archive,nil,'Archive'],
+
+      'video/' => [nil,:video,nil,'Video'],
+
+      'audio/' => [nil,:audio,:audio_asset,'Audio'],
+
+      'image/'                   => [nil,:image,:image_asset,'Image'],
+      'image/jpeg'               => [:jpg,:image,:image_asset, 'JPEG Image'],
+      'image/jpg'                => [:jpg,:image,:image_asset, 'JPEG Image'],
+      'image/png'                => [:png,:image,:png_asset, 'PNG Image'],
+      'image/gif'                => [:png,:image,:gif_asset, 'GIF Image'],
+
+      'image/svg+xml'            => [:svg,:vector,:svg_asset,'Vector Graphic'],
+      'image/svg+xml-compressed' => [:svg,:vector,:svg_asset,'Vector Graphic'],
+      'application/illustrator'  => [:ai,:vector,:image_asset,'Vector Graphic'],
+      'image/bzeps'              => [:bzeps,:vector,:image_asset,'Vector Graphic'],
+      'image/eps'                => [:eps,:vector,:image_asset,'Vector Graphic'],
+      'image/gzeps'              => [:gzeps,:vector,:image_asset,'Vector Graphic'],
+
+      'application/pgp-encrypted' => [nil,:lock,nil,'Crypt'],
+      'application/pgp-signature' => [nil,:lock,nil,'Crypt'],
+      'application/pgp-keys'      => [nil,:lock,nil,'Crypt']
+    }.freeze
+
+    #
+    # This extension mapping is used to force certain mime types.
+    # Usually, firefox does pretty good at reporting the correct mime-type,
+    # but IE always fails (firefox fails on ogg). So, we use the MIME::Types
+    # gem to try to get the correct mime from the extension. Sometimes, however,
+    # even this doesn't work. This able will force certain types when
+    # MIME::Types fails or is ambiguous
+    #
+    EXTENSIONS = {
+      'jpg' => 'image/jpeg',
+      'png' => 'image/png',
+      'txt' => 'text/plain',
+      'flv' => 'video/flv',
+      'ogg' => 'audio/ogg',
+      'oga' => 'audio/ogg',
+      'ogv' => 'video/ogg',
+      'pdf' => 'application/pdf',
+
+      'doc' => 'application/msword',
+      'xsl' => 'application/excel',
+      'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+      'pptm' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+      'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template',
+      'docm' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
+      'xlsm' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+      'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+      'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
+
+      'odt' => 'application/vnd.oasis.opendocument.text',
+      'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
+      'odp' => 'application/vnd.oasis.opendocument.presentation',
+      'svg' => 'image/svg+xml',
+      'mod' => 'video/mpeg',
+
+      'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+      'pptm' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+      'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template',
+      'docm' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
+      'xlsm' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+      'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+      'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template'
+    }.freeze
+
+    #
+    # some types can have multiple names
+    #
+    TYPE_ALIASES = {
+      'image/jpg' => ['image/jpeg'],
+      'image/jpeg' => ['image/jpg']
+    }
+  end
+end

data/lib/media/temp_file.rb

@@ -0,0 +1,152 @@
+require 'tempfile'
+require 'fileutils'
+require 'pathname'
+
+#
+# media processing requires a different type of tempfile... because we use command
+# line tools to process our temp files, these files can't be open and closed by ruby.
+#
+# instead, Media::TempFile is used to generate closed files from binary data (for files
+# to be fed to command line tools), or to generate empty tmp files (for output filenames
+# to be fed to command line tools).
+#
+# We use the Tempfile class for generating these files, but then we always close them
+# right away. By doing this, we ensure that the temp file will eventually get removed
+# when the Tempfile gets garbage collected.
+#
+
+module Media
+  class TempFile
+
+    def self.tempfile_path
+      ::Media::TMP_PATH
+    end
+
+    ##
+    ## INSTANCE METHODS
+    ##
+
+    public
+
+    #
+    # data may be one of:
+    #
+    #  - FileUpload object: like the kind returned in multibyte encoded file upload forms.
+    #  - Pathname object: then load data from the file pointed to by the pathname.
+    #  - IO object: read the contents of the io object, copy to tmp file.
+    #  - otherwise, dump the contents of the data to the tmp file.
+    #
+    # if data is empty, we generate an empty one.
+    #
+    def initialize(data, content_type=nil)
+      if data.nil?
+        @tmpfile = TempFile.create_from_content_type(content_type)
+      elsif data.respond_to?(:path)
+        # we are dealing with an uploaded file object
+        @tmpfile = TempFile.create_from_file(data.path, content_type, {mode: :move})
+      elsif data.is_a?(StringIO)
+        data.rewind
+        @tmpfile = TempFile.create_from_data(data.read, content_type)
+      elsif data.instance_of?(Pathname)
+        @tmpfile = TempFile.create_from_file(data.to_s, content_type)
+      else
+        @tmpfile = TempFile.create_from_data(data, content_type)
+      end
+    end
+
+    #
+    # like initialize, but if given a block, then it yields the TempFile
+    # and also unlinks the file at the end of the block.
+    #
+    def self.open(data, content_type=nil)
+      tmp = TempFile.new(data, content_type)
+      if block_given?
+        begin
+          yield tmp
+        ensure
+          tmp.clear
+        end
+        nil
+      else
+        tmp
+      end
+    end
+
+    def clear
+      # this is not really needed, because the tmp files are deleted as soon as
+      # @tmpfile gets garbage collected.
+      # @tmpfile.unlink
+    end
+
+    def any?
+      @tmpfile.any?
+    end
+
+    def path
+      @tmpfile.path
+    end
+
+    def to_s
+      @tmpfile.path
+    end
+
+    ##
+    ## CLASS METHODS
+    ##
+
+    private
+
+    #
+    # creates a tempfile filled with the given binary data
+    #
+    def self.create_from_data(data, content_type=nil)
+      tf = new_for_content_type(content_type)
+      tf.binmode
+      tf.write(data)
+      tf.close
+      tf
+    end
+
+    #
+    # create an empty temp file with an extension to match the content_type
+    #
+    def self.create_from_content_type(content_type)
+      tf = new_for_content_type(content_type)
+      tf.close
+      tf
+    end
+
+    #
+    # create a tmp file that is a copy of another file.
+    #
+    def self.create_from_file(filepath, content_type, options = {})
+      tf = new_for_content_type(content_type)
+      tf.close
+      if options[:mode] == :move
+        FileUtils.mv filepath, tf.path
+      else
+        FileUtils.cp filepath, tf.path
+      end
+      tf
+    end
+
+    def self.new_for_content_type(content_type)
+      Tempfile.new content_type_basename(content_type),
+        tempfile_path,
+        mode: 022
+    end
+
+    #
+    # create a filename with a file extension from the content_type
+    #
+    def self.content_type_basename(content_type)
+      if content_type
+        extension = Media::MimeType.extension_from_mime_type(content_type) || :bin
+        ['media_temp_file', ".#{extension}"]
+      else
+        'media_temp_file'
+      end
+    end
+
+  end
+end