RubyGems - brendanlim-mms2r - Versions diffs - 2.2.0 - Mend

brendanlim-mms2r 2.2.0

Files changed (170) hide show

data/.gitignore +3 -0
data/History.txt +292 -0
data/Manifest.txt +169 -0
data/README.txt +202 -0
data/Rakefile +36 -0
data/conf/1nbox.net.yml +13 -0
data/conf/aliases.yml +17 -0
data/conf/bellsouth.net.yml +2 -0
data/conf/from.yml +2 -0
data/conf/mediamessaging.o2.co.uk.yml +4 -0
data/conf/messaging.nextel.com.yml +10 -0
data/conf/mms.3ireland.ie.yml +17 -0
data/conf/mms.ae.yml +5 -0
data/conf/mms.alltel.com.yml +15 -0
data/conf/mms.att.net.yml +11 -0
data/conf/mms.dobson.net.yml +4 -0
data/conf/mms.luxgsm.lu.yml +13 -0
data/conf/mms.mobileiam.ma.yml +16 -0
data/conf/mms.mtn.co.za.yml +13 -0
data/conf/mms.mycricket.com.yml +4 -0
data/conf/mms.myhelio.com.yml +12 -0
data/conf/mms.netcom.no.yml +4 -0
data/conf/mms.o2online.de.yml +8 -0
data/conf/mms.three.co.uk.yml +15 -0
data/conf/mms.vodacom4me.co.za.yml +13 -0
data/conf/mms2r_media.yml +24 -0
data/conf/mobile.indosat.net.id.yml +14 -0
data/conf/msg.telus.com.yml +6 -0
data/conf/orangemms.net.yml +13 -0
data/conf/pm.sprint.com.yml +12 -0
data/conf/pxt.vodafone.net.nz.yml +5 -0
data/conf/rci.rogers.com.yml +18 -0
data/conf/sms.sasktel.com.yml +12 -0
data/conf/tmomail.net.yml +28 -0
data/conf/txt.bell.ca.yml +4 -0
data/conf/unicel.com.yml +6 -0
data/conf/vmpix.com.yml +11 -0
data/conf/vzwpix.com.yml +8 -0
data/conf/waw.plspictures.com.yml +15 -0
data/dev_tools/anonymizer.rb +20 -0
data/dev_tools/debug_sprint_hpricot_parsing.rb +82 -0
data/dev_tools/github.rb +8 -0
data/lib/mms2r.rb +58 -0
data/lib/mms2r/media.rb +746 -0
data/lib/mms2r/media/sprint.rb +189 -0
data/lib/tmail_ext.rb +17 -0
data/mms2r.gemspec +41 -0
data/test/fixtures/1nbox-2images-01.mail +738 -0
data/test/fixtures/1nbox-2images-02.mail +736 -0
data/test/fixtures/1nbox-2images-03.mail +736 -0
data/test/fixtures/1nbox-2images-04.mail +732 -0
data/test/fixtures/3ireland-mms-01.mail +671 -0
data/test/fixtures/alltel-image-01.mail +319 -0
data/test/fixtures/alltel-mms-01.mail +270 -0
data/test/fixtures/alltel-mms-03.mail +270 -0
data/test/fixtures/apple-double-image-01.mail +53 -0
data/test/fixtures/att-blackberry-02.mail +54 -0
data/test/fixtures/att-blackberry.mail +60 -0
data/test/fixtures/att-image-01.mail +37 -0
data/test/fixtures/att-image-02.mail +37 -0
data/test/fixtures/att-iphone-01.mail +73 -0
data/test/fixtures/att-iphone-02.mail +61 -0
data/test/fixtures/att-iphone-03.mail +61 -0
data/test/fixtures/att-text-01.mail +27 -0
data/test/fixtures/bell-canada-image-01.mail +2273 -0
data/test/fixtures/cingularme-text-01.mail +13 -0
data/test/fixtures/cingularme-text-02.mail +14 -0
data/test/fixtures/dobson-image-01.mail +64 -0
data/test/fixtures/dot.jpg +0 -0
data/test/fixtures/generic.mail +50 -0
data/test/fixtures/helio-image-01.mail +348 -0
data/test/fixtures/helio-message-01.mail +327 -0
data/test/fixtures/iconv-fr-text-01.mail +50 -0
data/test/fixtures/indosat-image-01.mail +751 -0
data/test/fixtures/indosat-image-02.mail +751 -0
data/test/fixtures/info2go-image-01.mail +43 -0
data/test/fixtures/luxgsm-image-01.mail +388 -0
data/test/fixtures/maroctelecom-france-mms-01.mail +511 -0
data/test/fixtures/mediamessaging_o2_co_uk-image-01.mail +61 -0
data/test/fixtures/mmode-image-01.mail +36 -0
data/test/fixtures/mms.ae-image-01.mail +45 -0
data/test/fixtures/mms.mycricket.com-pic-and-text.mail +87 -0
data/test/fixtures/mms.mycricket.com-pic.mail +78 -0
data/test/fixtures/mmsreply.t-mobile.co.uk-text-image-01.mail +431 -0
data/test/fixtures/mobile.mycingular.com-text-01.mail +25 -0
data/test/fixtures/mtn-southafrica-mms.mail +127 -0
data/test/fixtures/mycingular-image-01.mail +66 -0
data/test/fixtures/netcom-image-01.mail +63 -0
data/test/fixtures/nextel-image-01.mail +46 -0
data/test/fixtures/nextel-image-02.mail +43 -0
data/test/fixtures/nextel-image-03.mail +44 -0
data/test/fixtures/nextel-image-04.mail +43 -0
data/test/fixtures/o2-de-image-01.mail +134 -0
data/test/fixtures/orange-uk-image-01.mail +71 -0
data/test/fixtures/orangefrance-text-and-image.mail +68 -0
data/test/fixtures/orangepoland-text-01.mail +7 -0
data/test/fixtures/orangepoland-text-02.mail +7 -0
data/test/fixtures/pics.cingularme.com-image-01.mail +44 -0
data/test/fixtures/pxt-image-01.mail +118 -0
data/test/fixtures/rogers-canada-mms-01.mail +1029 -0
data/test/fixtures/sasktel-image-01.mail +1791 -0
data/test/fixtures/sprint-broken-image-01.mail +195 -0
data/test/fixtures/sprint-image-01.mail +211 -0
data/test/fixtures/sprint-pcs-text-01.mail +8 -0
data/test/fixtures/sprint-purged-image-01.mail +195 -0
data/test/fixtures/sprint-text-01.mail +195 -0
data/test/fixtures/sprint-two-images-01.mail +231 -0
data/test/fixtures/sprint-video-01.mail +210 -0
data/test/fixtures/sprint.mov +0 -0
data/test/fixtures/suncom-blackberry.mail +43 -0
data/test/fixtures/telus-image-01.mail +89 -0
data/test/fixtures/three-uk-image-01.mail +684 -0
data/test/fixtures/tmo.blackberry.net-image-01.mail +48 -0
data/test/fixtures/tmobile-blackberry-02.mail +50 -0
data/test/fixtures/tmobile-blackberry.mail +44 -0
data/test/fixtures/tmobile-image-01.mail +145 -0
data/test/fixtures/tmobile-image-02.mail +145 -0
data/test/fixtures/unicel-image-01.mail +60 -0
data/test/fixtures/verizon-blackberry.mail +53 -0
data/test/fixtures/verizon-image-01.mail +44 -0
data/test/fixtures/verizon-image-02.mail +50 -0
data/test/fixtures/verizon-image-03.mail +53 -0
data/test/fixtures/verizon-text-01.mail +10 -0
data/test/fixtures/verizon-video-01.mail +336 -0
data/test/fixtures/virgin-mobile-image-01.mail +73 -0
data/test/fixtures/virgin.ca-text-01.mail +21 -0
data/test/fixtures/vodacom4me-co-za-01.mail +104 -0
data/test/fixtures/vodacom4me-co-za-02.mail +108 -0
data/test/fixtures/vodacom4me-southafrica-mms-01.mail +152 -0
data/test/fixtures/vodacom4me-southafrica-mms-04.mail +655 -0
data/test/fixtures/vtext-text-01.mail +10 -0
data/test/fixtures/waw.plspictures.com-image-01.mail +1611 -0
data/test/test_1nbox_net.rb +78 -0
data/test/test_bell_canada.rb +44 -0
data/test/test_bellsouth_net.rb +22 -0
data/test/test_github.rb +12 -0
data/test/test_helper.rb +58 -0
data/test/test_mediamessaging_o2_co_uk.rb +52 -0
data/test/test_messaging_nextel_com.rb +93 -0
data/test/test_messaging_sprintpcs_com.rb +26 -0
data/test/test_mms2r_media.rb +760 -0
data/test/test_mms_3ireland_ie.rb +25 -0
data/test/test_mms_ae.rb +46 -0
data/test/test_mms_alltel_com.rb +53 -0
data/test/test_mms_att_net.rb +142 -0
data/test/test_mms_dobson_net.rb +41 -0
data/test/test_mms_luxgsm_lu.rb +58 -0
data/test/test_mms_mobileiam_ma.rb +26 -0
data/test/test_mms_mtn_co_za.rb +25 -0
data/test/test_mms_mycricket_com.rb +60 -0
data/test/test_mms_myhelio_com.rb +62 -0
data/test/test_mms_netcom_no.rb +52 -0
data/test/test_mms_o2online_de.rb +53 -0
data/test/test_mms_three_co_uk.rb +42 -0
data/test/test_mms_vodacom4me_co_za.rb +107 -0
data/test/test_mobile_indosat_net_id.rb +52 -0
data/test/test_msg_telus_com.rb +28 -0
data/test/test_orangemms_net.rb +100 -0
data/test/test_pm_sprint_com.rb +202 -0
data/test/test_pxt_vodafone_net_nz.rb +37 -0
data/test/test_rci_rogers_com.rb +28 -0
data/test/test_sms_sasktel_com.rb +28 -0
data/test/test_tmomail_net.rb +108 -0
data/test/test_unicel_com.rb +49 -0
data/test/test_vmpix_com.rb +56 -0
data/test/test_vzwpix_com.rb +131 -0
data/test/test_waw_plspictures_com.rb +27 -0
data/vendor/plugins/mms2r/lib/autotest/discover.rb +3 -0
data/vendor/plugins/mms2r/lib/autotest/mms2r.rb +38 -0
metadata +288 -0

data/conf/mms.three.co.uk.yml ADDED Viewed

@@ -0,0 +1,15 @@
+---
+transform:
+  text/plain:
+  - - /^You have received a new message$/i
+    - ""
+ignore:
+  image/jpeg:
+  - images/reb.jpg
+  - images/tpm.jpg
+  image/gif:
+  - images/vf9.gif
+  text/html:
+   - /<html><head>.*<title>MMS Message<\/title>/im
+  text/plain:
+   - /You have received an MMS message.  To see the message correctly, you will need to view this message\s+in a graphical email application./im

data/conf/mms.vodacom4me.co.za.yml ADDED Viewed

@@ -0,0 +1,13 @@
+---
+ignore:
+  text/html:
+  - /.*You have an <b>MMS<\/b> message!.*/m
+transform:
+  text/plain:
+  - - /\s*This is an MMS message brought to you by Vodacom\. Click here to view online presentation http:\/\/mms.vodacom4me.co.za\/.*$/
+    - ""
+number:
+  - from
+  - /^([^\s]+)\s.*/
+  - "\1"

data/conf/mms2r_media.yml ADDED Viewed

@@ -0,0 +1,24 @@
+---
+ignore:
+ text/plain:
+ - /^\(no subject\)$/i
+ multipart/mixed:
+ - "/^Attachment: /i"
+transform:
+  text/plain:
+  - - /\A(.*?)Sent via BlackBerry (from|by) .*$/im
+    - "\1"
+  - - /\A(.*?)Sent from my Verizon Wireless BlackBerry$/im
+    - "\1"
+  - - /\A(.*?)Sent from (my|your) iPhone.?$/im
+    - "\1"
+  - - /\A(.*?)\s+image\/jpeg$/im
+    - "\1"
+device_types:
+  headers:
+    X-Mailer:
+    - !ruby/regexp /^iPhone Mail/i
+    - :iphone
+    X-rim-org-msg-ref-id:
+    - !ruby/regexp /.+/
+    - :blackberry

data/conf/mobile.indosat.net.id.yml ADDED Viewed

@@ -0,0 +1,14 @@
+---
+ignore:
+  text/plain:
+   - /\A\.\z/im
+   - .
+  text/html:
+   - /I-Memova - Email Praktis. Cara Taktis. Powered by IM2./i
+  image/jpeg:
+   - cp__newBanner.jpg
+number:
+  - return-path
+  - /^<([^@]+)@.*/
+  - "\1"

data/conf/msg.telus.com.yml ADDED Viewed

@@ -0,0 +1,6 @@
+---
+ignore:
+  text/plain:
+   - /This is an MMS message. Please go to http/m
+  text/html:
+   - /You've received a Message from a TELUS phone./m

data/conf/orangemms.net.yml ADDED Viewed

@@ -0,0 +1,13 @@
+---
+ignore:
+  application/smil:
+  - /\A<smil><head><layout><root-layout height=/m
+  text/plain:
+  - banniere.txt
+  - /\A--\s+This Orange Multi Media Message was sent wirefree from an Orange MMS.*/mi
+transform:
+  text/plain:
+  - - /^Orange UK MMS$/i
+    - ""
+  - - /^Wiadomo\303\205\302\233\303\204\302\207 multimedialna\.$/i
+    - ""

data/conf/pm.sprint.com.yml ADDED Viewed

@@ -0,0 +1,12 @@
+---
+ignore:
+  text/html:
+  - /We're sorry, this page is not available. We apologize for the inconvenience./mi
+  text/plain:
+  - /You have new [Picture|Video] Mail!\s+Click Go\/View to see now./mi
+transform:
+  text/plain:
+  - - /^You have new Picture Mail!$/i
+    - ""
+  - - /^PictureMail$/i
+    - ""

data/conf/pxt.vodafone.net.nz.yml ADDED Viewed

@@ -0,0 +1,5 @@
+---
+transform:
+  text/plain:
+  - - /^You have a PXT from \d+$/i
+    - ""

data/conf/rci.rogers.com.yml ADDED Viewed

@@ -0,0 +1,18 @@
+---
+ignore:
+  image/gif:
+  - /^.*$/i
+  text/plain:
+  - /^Uve received a video or picture msg from .*/im
+  text/html:
+  - /Picture from your Rogers Wireless friend/im
+transform:
+  text/plain:
+  - - /^You have received a Picture Message from your Rogers Wireless.*/i
+    - ""
+number:
+  - from
+  - /^([^\/|^@]+).*/
+  - "\1"

data/conf/sms.sasktel.com.yml ADDED Viewed

@@ -0,0 +1,12 @@
+---
+ignore:
+  text/html:
+  - /.*/im
+  text/plain:
+  - /^You have received a New Message/i
+  image/gif:
+  - /.*/im
+transform:
+  text/plain:
+  - - /^A Picture\/Video Message!$/i
+    - ""

data/conf/tmomail.net.yml ADDED Viewed

@@ -0,0 +1,28 @@
+---
+ignore:
+  image/jpeg:
+  - /^masthead.jpg$/i
+  - /^logo.jpg$/i
+  image/gif:
+  - /^dottedline350.gif$/i
+  - /^dottedline600.gif$/i
+  - /^dottedLine_350.gif$/i
+  - /^dottedLine_600.gif$/i
+  - /^spacer.gif$/i
+  - /^video.gif$/i
+  - /^audio.gif$/i
+  - /^tmobilelogo.gif$/i
+  - /^tmobilespace.gif$/i
+  text/html:
+   - /<html>\s+<head>\s+<title>T-Mobile<\/title>/m
+   - /<title>MMS E-Mail<\/title>/m
+number:
+  - from
+  - /^"?([^\/|^@]+).*/
+  - "\1"
+transform:
+  text/plain:
+  - - /.*\s+Text:\s+(.*?)\s+-+\s.*/im
+    - "\1"

data/conf/txt.bell.ca.yml ADDED Viewed

@@ -0,0 +1,4 @@
+transform:
+  text/html:
+    - [/.*(<html)/im, "\1"]

data/conf/unicel.com.yml ADDED Viewed

@@ -0,0 +1,6 @@
+---
+transform:
+  text/plain:
+  - - /^Unicel$/i
+    - ""

data/conf/vmpix.com.yml ADDED Viewed

@@ -0,0 +1,11 @@
+---
+ignore:
+  text/html:
+  - /This message is from\s+a Virgin Mobile user. Enjoy./mi
+  text/plain:
+  - /^This is an MMS message\.$/i
+transform:
+  text/plain:
+  - - /(.*?)-+\s+Sent by Text Messaging from a mobile device.*/im
+    - "\1"

data/conf/vzwpix.com.yml ADDED Viewed

@@ -0,0 +1,8 @@
+---
+ignore:
+  text/plain:
+  - /\AThis message was sent using (the Picture and Video|PIX-FLIX) Messaging service from Verizon Wireless!.*/m
+transform:
+  text/plain:
+  - - /\A(.+?)\s+This message was sent using (the Picture and Video|PIX-FLIX) Messaging service from Verizon Wireless!.*/m
+    - "\1"

data/conf/waw.plspictures.com.yml ADDED Viewed

@@ -0,0 +1,15 @@
+---
+transform:
+  text/plain:
+  - - /^You have received a Multimedia Message$/i
+    - ""
+number:
+  - return-path
+  - /^<([^@]+)@.*/
+  - "\1"
+ignore:
+  text/html:
+  - /.*/m
+  text/plain:
+  - /\AA New Photo\/Video Message.\s+Click Go\/View to see now http/im

data/dev_tools/anonymizer.rb ADDED Viewed

@@ -0,0 +1,20 @@
+#! /usr/bin/env ruby
+if ARGV.size != 3
+  puts "Usage: anonymizer.rb message_file phone_number email_address"
+  exit(1)
+end
+message_file = ARGV[0]
+phone_number = ARGV[1]
+email_address = ARGV[2]
+message = File.read(message_file)
+message.gsub!(phone_number, '2068675309')
+message.gsub!(email_address, 'tommy.tutone@example.com')
+out = File.open(message_file, "w")
+out.puts message
+out.close

data/dev_tools/debug_sprint_hpricot_parsing.rb ADDED Viewed

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'hpricot'
+require 'net/http'
+require 'rubygems'
+require 'hpricot'
+require 'pp'
+if ARGV[0].nil?
+  puts "please execute with a file path to a Sprint HTML file that was extracted from a MMS"
+  puts "ruby #{$0} MYFILE"
+  exit
+end
+doc = open(ARGV[0]) { |f| Hpricot(f) }
+puts "TITLE: #{doc.at('title').inner_html}"
+#phone number is tucked away in the comment in the head
+c = doc.search("/html/head/comment//").last
+t = c.content.gsub(/\s+/m," ").strip
+number = / name=&quot;MDN&quot;&gt;(\d+)&lt;/.match(t)[1]
+puts "NUMBER: #{number}"
+#if there is a text message with the MMS its in the
+#inner html of the only pre on the page
+text = doc.search("/html/body//pre").first.inner_html
+puts "TEXT: #{text}"
+# just see what they say this MMS is it really doesn't
+# mean anything, the content is in paux image with
+# a RECIPIENT in its URI path
+trs = doc.search("/html/body//tr")
+text = trs[3].search("/td/p/font/b/")
+case text.text
+when /You have a Video Mail from/
+  puts "it claims to be a video"
+when /You have a Picture Mail from /
+  puts "it claims to be an image"
+else
+  puts "what is it? #{text.text}"
+end
+# group all the images together
+srcs = Array.new
+imgs = doc.search("/html/body//img")
+imgs.each do |i|
+  src = i.attributes['src']
+  #next unless /pictures.sprintpcs.com\/+mmps\/RECIPIENT\//.match(src)
+  #we don't want to double fetch content and we only
+  #want to fetch media from the content server, you get
+  #a clue about that as there is a RECIPIENT in the URI path
+  next unless /mmps\/RECIPIENT\//.match(src)
+  next if srcs.detect{|s| s.eql?(src)}
+  srcs << src
+end
+# now fetch the media
+puts "there are #{srcs.size} sources to fetch"
+cnt = 0
+srcs.each do |src|
+  puts "--"
+  puts "FETCHING:\n  #{src}"
+   url = URI.parse(src)
+   #res = Net::HTTP.get_response(url)
+   agent = "Mozilla/5.0 (X11; U; Minix3 i686 (x86_64); en-US; rv:1.8.1.1) Gecko/20061208 Firefox/2.0.0.1"
+   res = Net::HTTP.start(url.host, url.port) { |http|
+     req = Net::HTTP::Get.new(url.request_uri, {'User-Agent' => agent})
+     http.request(req)
+   }
+  # prep and write a file
+  base = /\/RECIPIENT\/([^\/]+)\//.match(src)[1]
+  ext = /^[^\/]+\/(.+)/.match(res.content_type)[1]
+  file_name ="#{base}.#{cnt}.#{ext}"
+  puts "writing file: #{file_name}"
+  File.open(file_name,'w'){ |f| f.write(res.body) }
+  puts "file is sized #{File.size(file_name)}"
+  cnt = cnt + 1
+end
+puts "no images or video" if srcs.size == 0

data/dev_tools/github.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# based on Trouble shooting section in http://gems.github.com/
+require 'rubygems'
+require 'rubygems/specification'
+data = File.read(File.join(File.dirname(__FILE__), "..", "mms2r.gemspec"))
+spec = nil
+result = Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+puts spec
+(!!result) ? exit(0) : exit(1)

data/lib/mms2r.rb ADDED Viewed

@@ -0,0 +1,58 @@
+#--
+# Copyright (c) 2007, 2008 by Mike Mondragon (mikemondragon@gmail.com)
+#
+# Please see the LICENSE file for licensing information.
+#++
+module MMS2R
+  ##
+  # A hash of MMS2R processors keyed by MMS carrier domain.
+  CARRIERS = {}
+  ##
+  # Registers a class as a processor for a MMS domain.  Should only be
+  # used in special cases such as MMS2R::Media::Sprint for 'pm.sprint.com'
+  def self.register(domain, processor_class)
+    MMS2R::CARRIERS[domain] = processor_class
+  end
+  ##
+  # A hash of file extensions for common mime-types
+  EXT = {
+    'text/plain' => 'text',
+    'text/plain' => 'txt',
+    'text/html' => 'html',
+    'image/png' => 'png',
+    'image/gif' => 'gif',
+    'image/jpeg' => 'jpeg',
+    'image/jpeg' => 'jpg',
+    'video/quicktime' => 'mov',
+    'video/3gpp2' => '3g2'
+  }
+  class MMS2R::Media
+    ##
+    # MMS2R library version
+    VERSION = '2.2.0'
+  end
+end
+require 'rubygems'
+require 'tmail/mail'
+require 'fileutils'
+require 'pathname'
+require 'tmpdir'
+require 'yaml'
+require File.join(File.dirname(__FILE__), 'tmail_ext')
+require File.join(File.dirname(__FILE__), 'mms2r', 'media')
+require File.join(File.dirname(__FILE__), 'mms2r', 'media', 'sprint')
+MMS2R.register('pm.sprint.com', MMS2R::Media::Sprint)

data/lib/mms2r/media.rb ADDED Viewed

@@ -0,0 +1,746 @@
+#--
+# Copyright (c) 2007, 2008 by Mike Mondragon (mikemondragon@gmail.com)
+#
+# Please see the LICENSE file for licensing information
+#++
+##
+# = Synopsis
+#
+# MMS2R is a library to collect media files from MMS messages.  MMS messages
+# are multipart emails and mobile carriers often inject branding into these
+# messages.  MMS2R strips the advertising from an MMS leaving the actual user
+# generated media.
+#
+# The Tracker for MMS2R is located at
+# http://rubyforge.org/tracker/?group_id=3065
+# Please submit bugs and feature requests using the Tracker.
+#
+# If MMS from a carrier not known by MMS2R is encountered please submit a
+# sample to the author for inclusion in this project.
+#
+# == Stand Alone Example
+#
+#  require 'rubygems'
+#  require 'mms2r'
+#  mail = TMail::Mail.parse(IO.readlines("sample-MMS.file").join)
+#  mms = MMS2R::Media.new(mail)
+#  subject = mms.subject
+#  number = mms.number
+#  file = mms.default_media
+#  mms.purge
+#
+# == Rails ActionMailer#receive w/ AttachmentFu Example
+#
+#  def receive(mail)
+#    mms = MMS2R::Media.new(mail)
+#    picture = Picture.new # picture is an attachemnt_fu model
+#    picture.title = mms.subject
+#    picture.uploaded_data = mms.default_media
+#    picture.save!
+#    mms.purge
+#  end
+#
+# == More Examples
+#
+# See the README.txt file for more examples
+#
+# == Built In Configuration
+#
+# A custom configuration can be created for processing the MMS from carriers
+# that are not currently known by MMS2R.  In the  conf/ directory create a
+# YAML file named by combining the domain name of the MMS sender plus a .yml
+# extension.  For instance the configuration of senders from AT&T's cellular
+# service with a Sender pattern of 2065551212@mms.att.net have a configuration
+# named conf/mms.att.net.yml
+#
+# The YAML configuration contains a Hash with instructions for determining what
+# is content generated by the user and what is content inserted by the carrier.
+#
+# The root hash itself has two hashes under the keys 'ignore' and 'transform',
+# and an array under the 'number' key.
+# Each hash is itself keyed by mime-type.  The value pointed to by the mime-type
+# key is an array.  The ignore arrays are first evaluated as a regular expressions
+# and if the evaluation fails as a equality for a string filename.  Ignores
+# work by filename for the multi-part of the MMS that is being inspected.  The
+# array pointed to by the 'number' key represents an alternate mail header where
+# the sender's number can be found with a regular expression and replacement
+# value for a gsub eval.
+#
+# The transform arrays are themselves an array of two element arrays.  The elements
+# are parameters for gsub and will be evaluated from within the ruby code.
+#
+# Ignore instructions are honored first then transform instructions.  In the sample,
+# masthead.jpg is ignored as a regular expression, and spacer.gif is ignored as a
+# filename comparison.  The transform has a match and a replacement, see the gsub
+# documentation for more information about match and replace.
+#
+# --
+# ignore:
+#   image/jpeg:
+#   - /^masthead.jpg$/i
+#   image/gif:
+#   - spacer.gif
+#   text/plain:
+#   - /\AThis message was sent using PIX-FLIX Messaging service from .*/m
+# transform:
+#   text/plain:
+#   - - /\A(.+?)\s+This message was sent using PIX-FLIX Messaging .*/m
+#     - "\1"
+# number:
+#   - from
+#   - /^([^\s]+)\s.*/
+#   - "\1"
+#
+# Carriers often provide their services under many different domain names.
+# The conf/aliases.yml is a YAML file with a hash that maps alternative or
+# legacy carrier names to the most common name of their service.  For example
+# in terms of MMS2R txt.att.net is an alias for mms.att.net.  Therefore when
+# an MMS with a Sender of txt.att.net is processed MMS2R will use the
+# mms.att.net configuration to process the message.
+module MMS2R
+  class MMS2R::Media
+    class << self #:nodoc:
+      # alias new so that we can use ::create to select the media processor and
+      # then initialize the new object
+      alias orig_new new
+      def new(mail, opts = {})
+        klass, carrier = MMS2R::Media.create(mail)
+        opts[:domain] = carrier
+        klass.orig_new(mail, opts)
+      end
+    end
+    ##
+    # TMail object that the media files were derived from.
+    attr_reader :mail
+    ##
+    # media returns the hash of media.  The media hash is keyed by mime-type
+    # such as 'text/plain' and the value mapped to the key is an array of
+    # media that are of that type.
+    attr_reader :media
+    ##
+    # Carrier is the domain name of the carrier.  If the carrier is not known
+    # the carrier will be set to 'mms2r.media'
+    attr_reader :carrier
+    ##
+    # Base working dir where media for a unique mms message are dropped
+    attr_reader :media_dir
+    ##
+    # Various multi-parts that are bundled into mail
+    MULTIPARTS_TO_SPLIT = [ 'multipart/related', 'multipart/alternative', 'multipart/mixed', 'multipart/appledouble' ]
+    ##
+    # Factory method that creates MMS2R::Media products based on the domain
+    # name of the carrier from which the MMS originated.  mail is a TMail
+    # object.
+    def self.create(mail)
+      d = lambda{ ['mms2r.media', MMS2R::Media] } #sets a default to detect
+      from_domain = self.domain(mail)
+      processor = MMS2R::CARRIERS.detect(d) do |domain, klass|
+        return klass, domain if from_domain == domain
+      end
+      [MMS2R::Media, from_domain]
+    end
+    ##
+    # Determine if return-path or from is going to be used to desiginate the
+    # origin carrier.  If the domain in the From header is listed in
+    # conf/from.yaml then that is the carrier domain.  Else if there is a
+    # Return-Path header its address's domain is the carrier doamin, else
+    # use From header's address domain.
+    def self.domain(mail)
+      return_path = case
+        when mail.header['return-path']
+          matched = /^<.+@([^@]+)>$/.match(mail.header['return-path'].to_s.strip)
+          matched ? matched[1] : ''
+        else
+          ''
+        end
+      from_domain = case
+        when mail.from && mail.from.first
+          mail.from.first.split('@').last
+        else
+          ''
+        end
+      f = File.join(self.conf_dir(), "from.yml")
+      from = YAML::load_file(f) rescue {}
+      ret = case
+        when from.include?(from_domain)
+          from_domain
+        when return_path.any?
+          return_path
+        else
+          from_domain
+        end
+      ret
+    end
+    ##
+    # Initialize a new MMS2R::Media comprised of a mail.
+    #
+    # Specify options to initialize with:
+    # :logger => some_logger for logging
+    # :process => :lazy, for non-greedy processing upon initialization
+    #
+    # #process will have to be called explicitly if the lazy process option
+    # is chosen.
+    def initialize(mail, opts={})
+      @mail = mail
+      @logger = opts[:logger]
+      log("#{self.class} created", :info)
+      @carrier = opts[:domain]
+      @dir_count = 0
+      @media_dir = File.join(self.tmp_dir(),
+                     self.safe_message_id(@mail.message_id))
+      @media = {}
+      @was_processed = false
+      @number = nil
+      @subject = nil
+      @body = nil
+      @default_media = nil
+      @default_text = nil
+      f = File.join(self.conf_dir(), "aliases.yml")
+      @aliases = YAML::load_file(f) rescue {}
+      conf = "#{@aliases[@carrier] || @carrier}.yml"
+      f = File.join(self.conf_dir(), conf)
+      c = YAML::load_file(f) rescue {}
+      @config = self.class.initialize_config(c)
+      lazy = (opts[:process] == :lazy) rescue false
+      self.process() unless lazy
+    end
+    ##
+    # Get the phone number associated with this MMS if it exists.  The value
+    # returned is simplistic, it is just the user name of the from address
+    # before the @ symbol.  Validation of the number is left to you.  Most
+    # carriers are using the real phone number as the username.
+    def number
+      unless @number
+        params = config['number']
+        if params && (header = mail.header[params[0]])
+          @number = header.to_s.gsub(eval(params[1]), params[2])
+        end
+      end
+      @number ||= mail.from.first.split('@').first rescue ""
+    end
+    ##
+    # Return the Subject for this message, returns "" for default carrier
+    # subject such as 'Multimedia message' for ATT&T carrier.
+    def subject
+      unless @subject
+        subject = mail.subject.strip rescue ""
+        ignores = config['ignore']['text/plain']
+        if ignores && ignores.detect{|s| s == subject}
+          @subject = ""
+        else
+          @subject = transform_text('text/plain', subject).last
+        end
+      end
+      @subject
+    end
+    # Convenience method that returns a string including all the text of the
+    # first text/plain file found.  Returns empty string if no body text
+    # is found.
+    def body
+      text_file = default_text
+      @body = text_file ? IO.readlines(text_file.path).join.strip : ""
+      @body
+    end
+    # Returns a File with the most likely candidate for the user-submitted
+    # media.  Given that most MMS messages only have one file attached, this
+    # method will try to return that file.  Singleton methods are added to
+    # the File object so it can be used in place of a CGI upload (local_path,
+    # original_filename, size, and content_type) such as in conjunction with
+    # AttachementFu.  The largest file found in terms of bytes is returned.
+    #
+    # Returns nil if there are not any video or image Files found.
+    def default_media
+      @default_media ||= attachment(['video', 'image', 'application', 'text'])
+    end
+    # Returns a File with the most likely candidate that is text, or nil
+    # otherwise.  It also adds singleton methods to the File object so it can be
+    # used in place of a CGI upload (local_path, original_filename, size, and
+    # content_type) such as in conjunction with AttachmentFu.  The largest file
+    # found in terms of bytes is returned.
+    #
+    # Returns nil if there are not any text Files found
+    def default_text
+      @default_text ||= attachment(['text/plain'])
+    end
+    ##
+    # process is a template method and collects all the media in a MMS.
+    # Override helper methods to this template to clean out advertising and/or
+    # ignore media that are advertising.  This method should not be overridden
+    # unless there is an extreme special case in processing the media of a MMS
+    # (like Sprint)
+    #
+    # Helper methods for the process template:
+    # * ignore_media? -- true if the media contained in a part should be ignored.
+    # * process_media -- retrieves media to temporary file, returns path to file.
+    # * transform_text -- called by process_media, strips out advertising.
+    # * temp_file -- creates a temporary filepath based on information from the part.
+    #
+    # Block support:
+    # Call process() with a block to automatically iterate through media.
+    # For example, to process and receive only media of video type:
+    #   mms.process do |media_type, file|
+    #     results << file if media_type =~ /video/
+    #   end
+    #
+    # note: purge must be explicitly called to remove the media files
+    #       mms2r extracts from an mms message.
+    def process() # :yields: media_type, file
+      unless @was_processed
+        log("#{self.class} processing", :info)
+        parts = mail.multipart? ? mail.parts : [mail]
+        # Double check for multipart/related, if it exists replace it with its
+        # children parts.  Do this twice as multipart/alternative can have
+        # children and we want to fold everything down
+        for i in 1..2
+          flat = []
+          parts.each do |p|
+            if MULTIPARTS_TO_SPLIT.include?(p.part_type?)
+              p.parts.each {|mp| flat << mp }
+            else
+              flat << p
+            end
+          end
+          parts = flat.dup
+        end
+        # get to work
+        parts.each do |p|
+          t = p.part_type?
+          unless ignore_media?(t,p)
+            t,f = process_media(p)
+            add_file(t,f) unless t.nil? || f.nil?
+          end
+        end
+        @was_processed = true
+      end
+      # when process acts upon a block
+      if block_given?
+        media.each do |k, v|
+          yield(k, v)
+        end
+      end
+    end
+    ##
+    # Helper for process template method to determine if media contained in a
+    # part should be ignored.  Producers should override this method to return
+    # true for media such as images that are advertising, carrier logos, etc.
+    # See the ignore section in the discussion of the built-in configuration.
+    def ignore_media?(type,part)
+      ignores = config['ignore'][type] || []
+      ignore = ignores.detect{|test| filename?(part) == test}
+      ignore ||= ignores.detect{|test| filename?(part) =~ eval(test) if test.index('/') == 0 }
+      ignore ||= ignores.detect{|test| part.body.strip =~ eval(test) if test.index('/') == 0 }
+      ignore ||= (part.body.strip.size == 0 ? true : nil)
+      ignore.nil? ? false : true
+    end
+    ##
+    # Helper for process template method to decode the part based on its type
+    # and write its content to a temporary file.  Returns path to temporary
+    # file that holds the content.  Parts with a main type of text will have
+    # their contents transformed with a call to transform_text
+    #
+    # Producers should only override this method if the parts of the MMS need
+    # special treatment besides what is expected for a normal mime part (like
+    # Sprint).
+    #
+    # Returns a tuple of content type, file path
+    def process_media(part)
+      # TMail body auto-magically decodes quoted
+      # printable for text/html type.
+      file = temp_file(part)
+      if part.main_type('text') == 'text' ||
+         part.content_type == 'application/smil'
+        type, content = transform_text_part(part)
+        mode = 'w'
+      else
+        if part.content_type == 'application/octet-stream'
+          type = type_from_filename(filename?(part))
+        else
+          type = part.content_type
+        end
+        content = part.body
+        mode = 'wb' # open with binary bit for Windows for non text
+      end
+      return type, nil if content.nil? || content.empty?
+      log("#{self.class} writing file #{file}", :info)
+      File.open(file, mode){ |f| f.write(content) }
+      return type, file
+    end
+    ##
+    # Helper for process_media template method to transform text.
+    # See the transform section in the discussion of the built-in
+    # configuration.
+    def transform_text(type, text, original_nencoding = 'ISO-8859-1')
+      return type, text unless transforms = config['transform'][type]
+      #convert to UTF-8
+      begin
+        c = Iconv.new('UTF-8', original_nencoding )
+        utf_t = c.iconv(text)
+      rescue Exception => e
+        utf_t = text
+      end
+      transforms.each do |transform|
+        next unless transform.size == 2
+        p = transform.first
+        r = transform.last
+        utf_t = utf_t.gsub(eval(p), r) rescue utf_t
+      end
+      return type, utf_t
+    end
+    ##
+    # Helper for process_media template method to transform text.
+    def transform_text_part(part)
+      type = part.part_type?
+      text = part.body.strip
+      transform_text(type, text)
+    end
+    ##
+    # Helper for process template method to name a temporary filepath based on
+    # information in the part.  This version attempts to honor the name of the
+    # media as labeled in the part header and creates a unique temporary
+    # directory for writing the file so filename collision does not occur.
+    # Consumers of this method expect the directory structure to the file
+    # exists, if the method is overridden it is mandatory that this behavior is
+    # retained.
+    def temp_file(part)
+      file_name = filename?(part)
+      File.join(msg_tmp_dir(),File.basename(file_name))
+    end
+    ##
+    # Purges the unique MMS2R::Media.media_dir directory created
+    # for this producer and all of the media that it contains.
+    def purge()
+      log("#{self.class} purging #{@media_dir} and all its contents", :info)
+      FileUtils.rm_rf(@media_dir)
+    end
+    ##
+    # Helper to add a file to the media hash.
+    def add_file(type, file)
+      media[type] = [] unless media[type]
+      media[type] << file
+    end
+    ##
+    # Helper to temp_file to create a unique temporary directory that is a
+    # child of tmp_dir  This version is based on the message_id of the mail.
+    def msg_tmp_dir()
+      @dir_count += 1
+      dir = File.join(@media_dir, "#{@dir_count}")
+      FileUtils.mkdir_p(dir)
+      dir
+    end
+    ##
+    # returns a filename declared for a part, or a default if its not defined
+    def filename?(part)
+      name = part.sub_header("content-type", "name") ||
+        part.sub_header("content-disposition", "filename") ||
+        (part['content-location'] && part['content-location'].to_s.strip)
+      if (name.nil? || name.empty?)
+        if part['content-id'] && part['content-id'].real_body.strip =~ /^<(.+)>$/
+          name = $1
+        else
+          name = "#{Time.now.to_f}.#{self.default_ext(part.part_type?)}"
+        end
+      end
+      # XXX fwiw, janky look for dot extension 1 to 4 chars long
+      name = (name =~ /\..{1,4}$/ ? name : "#{name}.#{self.default_ext(part.part_type?)}")
+      # handle excessively large filenames
+      if name.size > 255
+        ext = File.extname(name)
+        base = File.basename(name, ext)
+        name = "#{base[0, 255 - ext.size]}#{ext}"
+      end
+      name
+    end
+    def aliases
+      @aliases
+    end
+    ##
+    # Best guess of the mobile device type.  Simple heuristics thus far for
+    # :iphone :blackberry :handset :unknown .  Could be expanded for exif
+    # probing or shifting mail header schemes
+    def device_type?
+      headers = config['device_types']['headers'] rescue {}
+      headers.keys.each do |header|
+        if mail.header[header.downcase]
+          regex, type = headers[header]
+          return type if mail.header[header.downcase].to_s =~ regex
+        end
+      end
+      return :handset if File.exist?(File.join(self.conf_dir,
+                                     "#{self.aliases[self.carrier] || self.carrier}.yml"))
+      :unknown
+    end
+    ##
+    # The source of the MMS was some sort of mobile or smart phone
+    def is_mobile?
+      self.device_type? != :unknown
+    end
+    ##
+    # Get the temporary directory where media files are written to.
+    def self.tmp_dir
+      @@tmp_dir ||= File.join(Dir.tmpdir, (ENV['USER'].nil? ? '':ENV['USER']), 'mms2r')
+    end
+    ##
+    # Set the temporary directory where media files are written to.
+    def self.tmp_dir=(d)
+      @@tmp_dir=d
+    end
+    ##
+    # Get the directory where conf files are stored.
+    def self.conf_dir
+      @@conf_dir ||= File.join(File.dirname(__FILE__), '..', '..', 'conf')
+    end
+    ##
+    # Set the directory where conf files are stored.
+    def self.conf_dir=(d)
+      @@conf_dir=d
+    end
+    ##
+    # Helper to create a safe directory path element based on the mail message
+    # id.
+    def self.safe_message_id(mid)
+      mid.nil? ? "#{Time.now.to_i}" : mid.gsub(/\$|<|>|@|\./, "")
+    end
+    ##
+    # Returns a default file extension based on a content type
+    def self.default_ext(content_type)
+      if MMS2R::EXT[content_type]
+        MMS2R::EXT[content_type]
+      elsif content_type
+        content_type.split('/').last
+      end
+    end
+    ##
+    # Joins the generic mms2r configuration with the carrier specific
+    # configuration.
+    def self.initialize_config(c)
+      f = File.join(self.conf_dir(), "mms2r_media.yml")
+      conf = YAML::load_file(f) rescue {}
+      conf['ignore'] ||= {} unless conf['ignore']
+      conf['transform'] = {} unless conf['transform']
+      conf['number'] = [] unless conf['number']
+      return conf unless c
+      kinds = ['ignore', 'transform']
+      kinds.each do |kind|
+        if c[kind]
+          c[kind].each do |type,array|
+            conf[kind][type] = [] unless conf[kind][type]
+            conf[kind][type] += array
+          end
+        end
+      end
+      conf['number'] = c['number'] if c['number']
+      conf
+    end
+    def log(message, level = :info)
+      @logger.send(level, message) unless @logger.nil?
+    end
+    ##
+    # convenience accessor for self.class.conf_dir
+    def conf_dir
+      self.class.conf_dir
+    end
+    ##
+    # convenience accessor for self.class.conf_dir
+    def tmp_dir
+      self.class.tmp_dir
+    end
+    ##
+    # convenience accessor for self.class.default_ext
+    def default_ext(type)
+      self.class.default_ext(type)
+    end
+    ##
+    # convenience accessor for self.class.safe_message_id
+    def safe_message_id(message_id)
+      self.class.safe_message_id(message_id)
+    end
+    ##
+    # convenience accessor for self.class.initialize_confg
+    def initialize_config(config)
+      self.class.initialize_config(config)
+    end
+    private
+    ##
+    # accessor for the config
+    def config
+      @config
+    end
+    ##
+    # guess content type from filename
+    def type_from_filename(filename)
+      ext = filename.split('.').last
+      ent = MMS2R::EXT.detect{|k,v| v == ext}
+      ent.nil? ? nil : ent.first
+    end
+    ##
+    # used by #default_media and #text to return the biggest attachment type
+    # listed in the types array
+    def attachment(types)
+      # get all the files that are of the major types passed in
+      files = []
+      types.each do |type|
+        media.keys.find_all{|k| type.include?("/") ? k == type : k.index(type) == 0 }.each do |key|
+          files += media[key]
+        end
+      end
+      return nil if files.empty?
+      # set temp holders
+      file = nil # explicitly declare the file and size
+      size = 0
+      mime_type = nil
+      #get the largest file
+      files.each do |f|
+        if File.size(f) > size
+          size = File.size(f)
+          file = File.new(f)
+          mime_type = media.detect{|type,files| files.detect{|fl| fl == f}}[0]
+        end
+      end
+      return nil if file.nil?
+      # These singleton methods implement the interface necessary to be used
+      # as a drop-in replacement for files uploaded with CGI.rb.
+      # This helps if you want to use the files with, for example,
+      # attachment_fu.
+      def file.local_path
+        self.path
+      end
+      def file.original_filename
+        File.basename(self.path)
+      end
+      def file.size
+        File.size(self.path)
+      end
+      # this one is kind of confusing because it needs a closure.
+      class << file
+        self
+      end.send(:define_method, :content_type) { mime_type }
+      file
+    end
+  end
+end