aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/AastraIPPhoneGDImage.rb

@@ -1,185 +0,0 @@
-require 'GD'
-
-################################################################################
-# Aastra XML API Classes - Aastra XML API Classes - AastraIPPhoneGDImage
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Firmware 2.2.0 or better
-#
-# AastraIPPhoneGDImage for AastraIPPhoneImageScreen and AastraIPPhoneImageScreen.
-#
-# ruby needs ruby-gd gem installed
-# ------------------------------
-#
-# Public methods
-#
-#	drawttftext(fontsize,angle,x,y,text,colorIndex,fontfile)
-#	Writes text to the image using TrueType fonts
-#	fontsize	The font size. Depending on your version of GD, this should be specified as the pixel
-#			size (GD1) or point size (GD2)
-#	angle		The angle in degrees, with 0 degrees being left-to-right reading text. Higher values
-#			represent a counter-clockwise rotation. For example, a value of 90 would result in
-#			bottom-to-top reading text.
-#	x,y		The coordinates given by x and y will define the basepoint of the first character
-#			(roughly the lower-left corner of the character).
-#	colorIndex	0=White	1=Black
-#	fontfile	Location and name of the ttf file to use
-#
-#	drawtext(fontsize,x,y,text,colorIndex)
-#	Writes text to the image using built-in font
-#	fontsize	The font size. From 1 to 5
-#	x,y		The coordinates given by x and y will define the basepoint of the first character
-#			(roughly the lower-left corner of the character).
-#	colorIndex	0=White	1=Black
-#
-#	rectangle(x1,y1,x2,y2,colorIndex,filled)
-#	Creates a rectangle starting at the specified coordinates.
-#	x1,y1		Upper left x,y coordinate. 0,0 is the top left corner of the image.
-#	x2,y2		Bottom right x,y coordinate
-#	colorIndex	0=White	1=Black
-#	filled		Boolean, optional (default if False)
-#
-#	ellipse(cx,cy,width,height,colorIndex,filled)
-#	Draws an ellipse centered at the specified coordinates.
-#	cx,cy		x-coordinate and y-coordinate of the center
-#	width		the ellipse width
-#	height		the ellipse height
-#	colorIndex	0=White	1=Black
-#	filled		Boolean, optional (default if False)
-#
-#	line(x1,y1,x2,y2,colorIndex)
-#	Draws a line
-#	x1,y1		x,y coordinates for the first point
-#	x2,y2		x,y coordinates for the second point
-#	colorIndex	0=White	1=Black
-#
-#	setGDImage(image)
-#	Imports an externally generated GD image
-#	image		GD image to import
-#
-#	getGDImage()
-#	Exports the current GD image
-#
-#	setFontPath(fontpath)
-#	Set directory path for the fonts to use
-#	fontpath	Directory for the ttf fonts
-#	Default value
-#		Windows based platform		C:\Windows\Fonts
-#		Linux based platform			../fonts
-#   Mac OS X based platform   ../fonts
-#   Rails based platform      RAILS_ROOT/fonts
-#
-# Example 1
-#	require 'AastraIPPhoneGDImage.rb'
-#	phoneImageGD = AastraIPPhoneGDImage.new
-#	time = Time.now.strftime("%H:%M")
-#	phoneImageGD.drawttftext(30, 0, 10, 39, time, 1,'Ni7seg.ttf')
-#
-# Example 2
-#	require 'AastraIPPhoneGDImage.rb'
-#	phoneImageGD = AastraIPPhoneGDImage.new
-#	utf8text = "东丝丞丟丸"
-#	phoneImageGD.drawttftext(20, 0, 5, 35, utf8text, 1, 'arialuni.ttf')
-#
-################################################################################
-
-class AastraIPPhoneGDImage
-  @img
-  @white
-  @black
-  @blackNoAntiAliasing
-  @font
-  @fontpath
-
-  # Creates a new GD image of size 144x40 (maximum allowed on phone). Also
-  # creates black and white colors to be used and sets default font path
-  # based on whether this is running under rails or a specific
-  # operating system.
-  def initialize
-    # create image
-    @img = GD::Image.new(144, 40)
-
-    # define black and white
-    @white = @img.colorAllocate(255, 255, 255)
-    @black = @img.colorAllocate(0, 0, 0)
-
-    # black and white only so disable anti-aliasing
-    @black *= -1
-    @white *= -1
-
-    # define a default font path
-    if defined?(RAILS_ROOT) then
-      @fontpath = "#{RAILS_ROOT}/fonts"
-    else
-      os = RUBY_PLATFORM.downcase
-      @fontpath = "C:\\Windows\\Fonts" if not os.scan(/win/).nil?
-      @fontpath = "../fonts" if not os.scan(/linux$/).nil?
-      @fontpath = "../fonts" if not os.scan(/darwin\d+\.\d+$/).nil?
-    end
-    ENV['GDFONTPATH'] = @fontpath
-  end
-
-  # Set font path for GD.
-  def setFontPath(fontpath)
-    @fontpath = fontpath
-    ENV['GDFONTPATH'] = @fontpath
-  end
-
-  # Draw text on the image using a specific true type font.
-  # See GD documentation for parameters.
-  def drawttftext(size, angle, x, y, text, colorIndex, font)
-    @img.stringTTF(getColor(colorIndex), font, size, angle, x, y, text)
-  end
-
-  # Draw text on the image.
-  def drawtext(size, x, y, text, colorIndex)
-    @img.string(size, x, y, text, getColor(colorIndex))
-  end
-
-  # Set the image from an externally created GD image.
-  def setGDImage(image)
-    @img = image
-  end
-
-  # Get the GD image created.
-  def getGDImage
-    return @img
-  end
-
-  # Draw a rectangle on the image. Rectangle will be unfilled by default.
-  def rectangle(x1, y1, x2, y2, colorIndex, filled=false)
-    if filled then
-      @img.filledRectangle(x1, y1, x2, y2, getColor(colorIndex))
-    else
-      @img.rectangle(x1, y1, x2, y2, getColor(colorIndex))
-    end
-  end
-
-  # Draw an ellipse on the image. Ellipse will be unfilled by default.
-  def ellipse(cx, cy, width, height, colorIndex, filled=false)
-    if filled then
-      @img.filledEllipse(cx, cy, width, height, 0, 360, getColor(colorIndex))
-    else
-      @img.ellipse(cx, cy, width, height, 0, 360, getColor(colorIndex))
-    end
-  end
-
-  # Draw a line on the image.  Line will be solid by default.
-  def line(x1, y1, x2, y2, colorIndex, dashed=false)
-    if dashed then
-      @img.dashedLine(x1, y2, x2, y2, getColor(colorIndex))
-    else
-      @img.line(x1, y2, x2, y2, getColor(colorIndex))
-    end
-  end
-
-  # Get the GD color element based on an index.
-  # 0:: white
-  # 1:: black
-  def getColor(index)
-    return @white if index == 0
-    return @black
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneIconEntry.rb

@@ -1,27 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPIconEntry
-# Firmware 2.0 or better
-# Copyright Aastra Telecom 8007
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhone object.
-################################################################################
-
-class AastraIPPhoneIconEntry
-  @index
-  @icon
-
-  # Create new icon entry available to be referenced as index.  The icon
-  # can either be a predefined icon (i.e. Icon:PhoneOnHook) or the actual
-  # hex data (as a string) of the icon.
-  def initialize(index, icon)
-    @index = index
-    @icon = icon
-  end
-
-  # Create XML text output for this entry.
-  def render
-    return "<Icon index=\"#{@index}\">#{@icon}</Icon>\n"
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneImageMenu.rb

@@ -1,143 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneImageMenu
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneImageMenu object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setCancelAction(uri) to set the cancel parameter with the URI to be called on Cancel (optional)
-#     setBeep to enable a notification beep with the object (optional)
-#     setTimeout(timeout) to define a specific timeout for the XML object (optional)
-#     setLockIn to set the Lock-in tag to 'yes' (optional)
-#     addSoftkey(index,label,uri,icon_index) to add custom softkeys to the object (optional)
-#     setRefresh(timeout,URL) to add Refresh parameters to the object (optional)
-#
-# Specific to the object
-#     setImage(image)to define the image to be displayed
-#     setGDImage(GDImage) to use a GDImage for display, the size is forced to 40x144
-#     setAlignment(vertical,horizontal) to define image alignment
-#     setSize(height,width) to define image size
-#     setURIBase(uriBase) to define the base URI for the selections
-#     addURI(key,uri) to add a selection key with its URI
-#
-# Example
-#     require 'AastraIPPhoneImageMenu.rb'
-#     imagem = AastraIPPhoneImageMenu.new
-#     imagem.setDestroyOnExit
-#     imagem.setSize(40,144)
-#     imagem.setImage('fffffffc02fffffffee4ffffbfffc05fffe7ff7a7ffffffffeffeebd7fffffea6bcfffffe796f3feff6fa289f0a86f4866fa20df42414595dd0134f8037ed1637f0e2522b2dd003b6eb936f05fffbd4f4107bba6eb0080e93715000010b754001281271408c640252081b1b22500013c5c66201368004e04467520dc11067152b82094d418e100247205805494780105002601530020131400020a05c91088b002b08c21c0000c200000001fe800000000000000001c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020041000004008300000ff08500000000c900000000710000000000000001401400000140140000014014000001401400000140140000000000000007c0ff00000c30880000081088000008108800000c30700000062000000000003f000001e02000000330200000021000000003301e000001e0330000000021000003f033000002001e0000020000000000001e000c03fc33003c013021007c02101201f00330ff03f001e000039000003e039001e00103f003300101f8021003007c03303f003c01e000000c00001e001c03f033007802002100f002002103e000001203c401702003cc0290ff039c02902101fc02b000007c03f01a003c020039018c0ff02d03c402102703c400001203ec01e000026402b0000264029000026c029000027c01a0000338000000033800000003100000000300000000030003f00003fc03000003fc02000003fc020000030001f0000300000000030001e000030002b000030002900003fc02900003fc01a00003f00000000310030000031c01e000031f003000033f81e00003f383000001e081e000008c003000003c01e00000fc03000001f000000003d001a0000390039000039002d00003f002700000f8012000007c000000001c0000000004000000000000000000000000000')
-#     imagem.addURI('1','http://myserver.com?choice=1')
-#     imagem.addURI('2','http://myserver.com?Choice=2')
-#     imagem.addSoftkey('1', 'Label', 'http://myserver.com/script.php?action=1', '1')
-#     imagem.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#     imagem.addIcon('1', 'Icon:Envelope')
-#     imagem.addIcon('2', 'FFFF0000FFFF0000')
-#     aastra_output imagem
-#
-################################################################################
-
-class AastraIPPhoneImageMenu < AastraIPPhone
-  @image
-  @verticalAlign
-  @horizontalAlign
-  @height
-  @width
-  @uriBase
-
-  # Sets the image to be displayed.  image must be a string of hex.
-  def setImage(image)
-    @image = image
-  end
-
-  # Sets the alignment of the image.  veritcal is one of 'top',
-  # 'middle' (default), or 'bottom'.  horizontal is one of 'left',
-  # 'middle' (default), or 'right'.
-  def setAlignment(vertical=nil, horizontal=nil)
-    @verticalAlign = vertical
-    @horizontalAlign = horizontal
-  end
-
-  # Sets the size of the image to be displayed which must match the
-  # actual images height and width.
-  def setSize(height, width)
-    @height = height
-    @width = width
-  end
-
-  # Sets the base URI that is prepended to the URI for a specific key.
-  def setURIBase(uriBase)
-    @uriBase = uriBase
-  end
-
-  # Adds a URI and key pair that is associated with the given key pressed
-  # by the user.  The full URI is the one set by setURIBase followed
-  # by this uri.
-  def addURI(key, uri)
-    @entries += [AastraIPPhoneImageMenuEntry.new(key, uri)]
-  end
-
-  # Sets the image based on an externally generated GD image.  Image must
-  # be 40x144 in size and should be created using AastraIPPhoneGDImage.
-  def setGDImage(gdImage)
-    img = gdImage.getGDImage
-    byte = 0
-    i = 0
-    imageHexString = ""
-    for x in 0..143
-      for y in 0..39
-        rgb = img.getPixel(x, y)
-        byte += 2**(7-(i%8)) if rgb > 0
-        if (i%8) == 7 then
-          byteHex ="%02x" % byte
-          imageHexString += byteHex
-          byte = 0
-        end
-        i += 1
-      end
-    end
-    setImage(imageHexString)
-    setSize(40,144)
-  end
-
-  # Create XML text output.
-  def render
-    title = escape(@title)
-    out = "<AastraIPPhoneImageMenu"
-    out += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    if not @cancelAction.nil? then
-      cancelAction = escape(@cancelAction)
-      out += " cancelAction=\"#{cancelAction}\""
-    end
-    out += " Beep=\"yes\"" if @beep == "yes"
-    out += " LockIn=\"yes\"" if @locking == "yes"
-    out += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    out += ">\n"
-    out += "<Image"
-    out += " verticalAlign=\"#{@verticalAlign}\"" if not @verticalAlign.nil?
-    out += " horizontalAlign=\"#{@horizontalAlign}\"" if not @horizontalAlign.nil?
-    out += " height=\"#{@height}\"" if not @height.nil?
-    out += " width=\"#{@width}\"" if not @width.nil?
-    out += ">#{@image}</Image>\n"
-    out += "<URIList"
-    out += " base=\"#{escape(@uriBase)}\"" if not @uriBase.nil?
-    out += ">\n"
-    @entries.each { |entry| out += entry.render }
-    out += "</URIList>\n"
-    @softkeys.each { |softkey| out += softkey.render }
-    iconList = 0
-    @icons.each do |icon|
-      if iconList == 0
-        out += "<IconList>\n"
-        iconList = 1
-      end
-      out += icon.render
-    end
-    out += "</IconList>\n" if iconList != 0
-    out += "</AastraIPPhoneImageMenu>\n"
-    return out
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneImageMenuEntry.rb

@@ -1,25 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneImageMenuEntry
-# Firmware 2.0 or better
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneImageMenu object.
-################################################################################
-
-class AastraIPPhoneImageMenuEntry < AastraIPPhone
-  @key
-  @uri
-
-  # Create a new mapping for a user pressed key and a URI to call.
-  def initialize(key, uri)
-    @key = key
-    @uri = uri
-  end
-
-  # Create XML text output for this entry.
-  def render
-    return "<URI key=\"#{@key}\">#{escape(@uri)}</URI>\n"
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneImageScreen.rb

@@ -1,139 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneImageScreen
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneImageScreen object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setCancelAction(uri) to set the cancel parameter with the URI to be called on Cancel (optional)
-#     setBeep to enable a notification beep with the object (optional)
-#     setLockIn to set the Lock-in tag to 'yes' (optional)
-#     setTimeout(timeout) to define a specific timeout for the XML object (optional)
-#     addSoftkey(index,label,uri,icon_index) to add custom softkeys to the object (optional)
-#     addIcon(index,icon) to add custom icons to the object (optional)
-#     setRefresh(timeout,URL) to add Refresh parameters to the object (optional)
-#
-# Specific to the object
-#     setImage(image) to define the image to be displayed
-#     setGDImage(GDImage) to use a GDImage for display, the size is forced to 40x144
-#     setAlignment(vertical,horizontal) to define image alignment
-#     setSize(height,width) to define image size
-#     setAllowDTMF to allow DTMF passthrough on the object
-#
-# Example
-#
-#     Using a Pixel image
-#
-#     require AastraIPPhoneImageScreen.rb'
-#     images = AastraIPPhoneImageScreen.new
-#     images.setDestroyOnExit
-#     images.setSize(40, 40)
-#     images.setImage('fffffffc02fffffffee4ffffbfffc05fffe7ff7a7ffffffffeffeebd7fffffea6bcfffffe796f3feff6fa289f0a86f4866fa20df42414595dd0134f8037ed1637f0e2522b2dd003b6eb936f05fffbd4f4107bba6eb0080e93715000010b754001281271408c640252081b1b22500013c5c66201368004e04467520dc11067152b82094d418e100247205805494780105002601530020931400020ac5c91088b0f2b08c21c07d0c2006009fdfe81f80efe0107fe0fb1c3ffff8ffc3fffef8f7febffbfcf87ffbff64')
-#     images.addSoftkey('1', 'Mail', 'http://myserver.com/script.php?action=1', '1')
-#     images.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#     images.addIcon('1', 'Icon:Envelope')
-#     aastra_output images
-#
-#     Using a GD image
-#
-#    require 'AastraIPPhoneGDImage.class.php'
-#    require 'AastraIPPhoneImageScreen.class.php'
-#    phoneImageGD = AastraIPPhoneGDImage.new
-#    object = AastraIPPhoneImageScreen.new
-#    time = Time.now.strftime("%H:%M")
-#    phoneImageGD.drawttftext(30, 0, 10, 39, time, 1, 'Ni7seg.ttf');
-#    object.setGDImage(phoneImageGD)
-#    aastra_output object
-#
-################################################################################
-
-class AastraIPPhoneImageScreen < AastraIPPhone
-  @image
-  @verticalAlign
-  @horizontalAlign
-  @height
-  @width
-  @allowDTMF
-
-  # Set the image as a string of hex characters.
-  def setImage(image)
-    @image = image
-  end
-
-  # Set the alignment of the image.  vertical is one of 'top',
-  # 'middle' (default), or 'bottom'.  horizontal is one of 'left',
-  # 'middle' (default), or 'right'.
-  def setAlignment(vertical=nil, horizontal=nil)
-    @verticalAlign = vertical
-    @horizontalAlign = horizontal
-  end
-
-  # Sets the size of the image.  Must match the actual image size.
-  def setSize(height, width)
-    @height = height
-    @width = width
-  end
-
-  # Sets the image using an externally generated GD image.  This should be
-  # done with an AastraIPPhoneGDImage.
-  def setGDImage(gdImage)
-    img = gdImage.getGDImage
-    byte = 0
-    i = 0
-    imageHexString = ""
-    for x in 0..143
-      for y in 0..39
-        rgb = img.getPixel(x, y)
-        byte += 2**(7-(i%8)) if rgb > 0
-        if (i%8) == 7 then
-          byteHex ="%02x" % byte
-          imageHexString += byteHex
-          byte = 0
-        end
-        i += 1
-      end
-    end
-    setImage(imageHexString)
-    setSize(40,144)
-  end
-
-  # When set, allows the user's pressed keys to be sent as DTMF through
-  # the phone when the phone is in an active call.
-  def setAllowDTMF
-    @allowDTMF = "yes"
-  end
-
-  # Creates XML text output.
-  def render
-    out = "<AastraIPPhoneImageScreen"
-    out += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    out += " cancelAction=\"#{escape(@cancelAction)}\"" if not @cancelAction.nil?
-    out += " Beep=\"yes\"" if @beep == "yes"
-    out += " LockIn=\"yes\"" if @locking == "yes"
-    out += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    out += " allowDTMF=\"yes\"" if @allowDTMF == "yes"
-    out += ">\n"
-    out += "<Image"
-    out += " verticalAlign=\"#{@verticalAlign}\"" if not @verticalAlign.nil?
-    out += " horizontalAlign=\"#{@horizontalAlign}\"" if not @horizontalAlign.nil?
-    out += " height=\"#{@height}\"" if not @height.nil?
-    out += " width=\"#{@width}\"" if not @width.nil?
-    out += ">#{@image}</Image>\n"
-    @softkeys.each { |softkey| out += softkey.render }
-    iconList = 0
-    @icons.each do |icon|
-      if iconList == 0 then
-        out += "<IconList>\n"
-        iconList = 1
-      end
-      out += icon.render
-    end
-    out += "</IconList>\n" if iconList != 0
-    out += "</AastraIPPhoneImageScreen>\n"
-    return out
-  end
-  end