aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/phone_icon_entry.rb

@@ -0,0 +1,29 @@
+################################################################################
+# Aastra XML API Classes - IconEntry
+# Firmware 2.0 or better
+# Copyright Aastra Telecom 8007
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for Phone object.
+################################################################################
+
+module AastraXmlApi
+  class PhoneIconEntry
+    @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
+end

data/lib/aastra_xml_api/phone_image_menu.rb

@@ -0,0 +1,145 @@
+################################################################################
+# Aastra XML API Classes - PhoneImageMenu
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneImageMenu object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     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 'PhoneImageMenu.rb'
+#     imagem = PhoneImageMenu.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
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneImageMenu < Phone
+    @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 += [PhoneImageMenuEntry.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 PhoneGDImage.
+    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 = "<PhoneImageMenu"
+      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 += "</PhoneImageMenu>\n"
+      return out
+    end
+  end
+end

data/lib/aastra_xml_api/phone_image_menu_entry.rb

@@ -0,0 +1,27 @@
+################################################################################
+# Aastra XML API Classes - PhoneImageMenuEntry
+# Firmware 2.0 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for PhoneImageMenu object.
+################################################################################
+
+module AastraXmlApi
+  class PhoneImageMenuEntry < Phone
+    @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
+end

data/lib/aastra_xml_api/phone_image_screen.rb

@@ -0,0 +1,141 @@
+################################################################################
+# Aastra XML API Classes - PhoneImageScreen
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneImageScreen object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     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 PhoneImageScreen.rb'
+#     images = PhoneImageScreen.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 'PhoneGDImage.class.php'
+#    require 'PhoneImageScreen.class.php'
+#    phoneImageGD = PhoneGDImage.new
+#    object = PhoneImageScreen.new
+#    time = Time.now.strftime("%H:%M")
+#    phoneImageGD.drawttftext(30, 0, 10, 39, time, 1, 'Ni7seg.ttf');
+#    object.setGDImage(phoneImageGD)
+#    aastra_output object
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneImageScreen < Phone
+    @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 PhoneGDImage.
+    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 = "<PhoneImageScreen"
+      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 += "</PhoneImageScreen>\n"
+      return out
+    end
+  end
+end

data/lib/aastra_xml_api/phone_input_screen.rb

@@ -0,0 +1,251 @@
+################################################################################
+# Aastra XML API Classes - PhoneInputScreen
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneInputScreen object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     setTitle(Title) to setup the title of an object (optional)
+#     setTitleWrap to set the title to be wrapped on 2 lines (optional)
+#     setDestroyOnExit to set DestroyonExit parameter to 'yes', 'no' by default (optional)
+#     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)
+#     setAllowAnswer to set the allowAnswer 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)
+#
+# Specific to the object - Single Input
+#     setURL(url) to set the URL to called after the input
+#     setType(type) to set type of input ('IP', 'string', 'number', 'dateUS'...), 'string' by default
+#     setDefault(default) to set default value for the input (optional)
+#     setParameter(param) to set the parameter name to be parsed after the input
+#     setInputLanguage(language) to set the language of the input (optional)
+#     setPassword to set the Password parameter to 'yes', 'no' by default (optional)
+#     setNotEditable to set the editable parameter to 'no', 'yes' by default (optional)
+#     setEditable is now replaced by setNotEditable but kept for compatibility reasons (optional)
+#     setPrompt(prompt) to set the prompt to be displayed for the input.
+#
+# Specific to the object - Multiple Inputs
+#     setURL(url) to set the URL to called after the input
+#     setType(type) to set the default type of input ('IP', 'string', 'number', 'dateUS'...), 'string' by default
+#     setDefault(default) to set default default value for the input (optional)
+#     setParameter(param) to set the default parameter name to be parsed after the input
+#     setPassword to set the default Password parameter to 'yes', 'no' by default (optional)
+#     setNotEditable to set the default editable parameter to 'no', 'yes' by default (optional)
+#     setEditable is now replaced by setNotEditable but kept for compatibility reasons (optional)
+#     setPrompt(prompt) to set the default prompt to be displayed for the input.
+#     setDefaultIndex(index) to define the field index the object will use to start (optional) default is 1
+#     setDisplayMode(display) to define the aspect of the display, normal/condensed (optional) default is normal.
+#     setInputLanguage(language) to set the language of the input (optional)
+#     addField(type) to add an input field and setting its type (IP, string, number, dateUS, timeUS,dateInt, timeInt or empty) if the type is an empty string then the type is inherited from the main object.
+#     setFieldPassword(password) to set the password mode for the input field ('yes', no'), overrides the value set by setPassword for the field
+#     setFieldEditable(editable) to set the input field editable mode ('yes', no'), overrides the value set by setEditable or setNotEditable for the field
+#     setFieldParameter(parameter) to set the parameter name to be parsed after the global input, overrides the value set by setParameter for the field
+#     setFieldPrompt(prompt)to set the prompt to be displayed for the input field, overrides the value set by setPrompt for the field
+#     setFieldSelection(selection) to set the Selection tag for the field
+#     setFieldDefault(default) to set default value for the input field, overrides the value set by setDefault for the field
+#     addFieldSoftkey(index,label,uri,icon) to add custom softkeys to the input field, overrides the softkeys set by addSoftkey.
+#
+# Example 1 - Single Input
+#     require 'PhoneInputScreen.rb'
+#     input = PhoneInputScreen.new
+#     input.setTitle('Title')
+#     input.setPrompt('Enter your password')
+#     input.setParameter('param')
+#     input.setType('string')
+#     input.setURL('http://myserver.com/script.php')
+#     input.setPassword
+#     input.setDestroyOnExit
+#     input.setDefault('Default')
+#     aastra_output input
+#
+# Example 2 - Multiple Inputs
+#     require 'PhoneInputScreen.rb'
+#     input = PhoneInputScreen.new
+#     input.setTitle('Example 2')
+#     input.setDisplayMode('condensed')
+#     input.setURL('http://myserver.com/script.php')
+#     input.setDestroyOnExit
+#     input.addSoftkey('5', 'Done', 'SoftKey:Submit')
+#     input.addField('string')
+#     input.setFieldPrompt('Username:')
+#     input.setFieldParameter('user')
+#     input.addFieldSoftkey('3', 'ABC', 'SoftKey:ChangeMode')
+#     input.addField('number')
+#     input.setFieldPassword('yes')
+#     input.setFieldPrompt('Pass:')
+#     input.setFieldParameter('passwd')
+#     aastra_output input
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneInputScreen < Phone
+    @url
+    @type
+    @parameter
+    @prompt
+    @editable
+    @default
+    @password
+    @defaultindex
+    @displaymode
+    @inputlanguage
+
+    # Set URL to be called (html post) when the input is submitted.
+    def setURL(url)
+      @url = url
+    end
+
+    # Sets the type of all fields (see addField for values) unless overriden
+    # by setFieldType.
+    def setType(type)
+      @type = type
+    end
+
+    # Sets all fields are editable. Kept only for compatibility.
+    def setEditable
+      @editable = "yes"
+    end
+
+    # Sets all fields as read only if not overriden by setFieldEditable.
+    def setNotEditable
+      @editable = "no"
+    end
+
+    # Set default value for all fields if not overriden by setFieldDefault.
+    def setDefault(default)
+      @default = default
+    end
+
+    # Set parameter name for all fields if not overriden by setFieldParameter.
+    def setParameter(parameter)
+      @parameter = parameter
+    end
+
+    # Set password input for all fields, masked by "*" characters if not
+    # overriden by setFieldPassword.
+    def setPassword
+      @password = "yes"
+    end
+
+    # Prompt for all input fields, if not overriden by setFieldPrompt.
+    def setPrompt(prompt)
+      @prompt = prompt
+    end
+
+    # Defines which field 1 (default) through 6 the user will start input on.
+    def setDefaultIndex(index)
+      @defaultindex = index
+    end
+
+    # Can be one of normal (default) or condensed.
+    def setDisplayMode(display)
+      @displaymode = display
+    end
+
+    # Defines the language character set used for input.
+    def setInputLanguage(input)
+      @inputlanguage = input
+    end
+
+    # Add a new field to get input for.  The type can be one of IP,
+    # string (default), number, timeUS, timeInt, dateUS, or dateInt.
+    def addField(type=nil)
+      @entries += [PhoneInputScreenEntry.new(type)]
+    end
+
+    # Sets the type (see addField for values) of the most recently added
+    # field.
+    def setFieldType(type)
+      @entries[@entries.size-1].setType(type)
+    end
+
+    # Set the most recently added field as a password field and mask input
+    # by "*" characters.
+    def setFieldPassword
+      @entries[@entries.size-1].setPassword
+    end
+
+    # Set the most recently added field as editable.  This is the default.
+    def setFieldEditable
+      @entries[@entries.size-1].setEditable
+    end
+
+    # Set the most recently added field's parameter name in the form post
+    # when submitted.
+    def setFieldParameter(parameter)
+      @entries[@entries.size-1].setParameter(parameter)
+    end
+
+    # Set the most recently added field's prompt text.
+    def setFieldPrompt(prompt)
+      @entries[@entries.size-1].setPrompt(prompt)
+    end
+
+    # Set the most recently added field's default value.This is what is
+    # displayed when first shown.
+    def setFieldDefault(default)
+      @entries[@entries.size-1].setDefault(default)
+    end
+
+    # Sets the most recently added field's selection tag which is added
+    # to the request when the submit button is pressed while editing this
+    # field.
+    def setFieldSelection(selection)
+      @entries[@entries.size-1].setSelection(selection)
+    end
+
+    # Adds a softkey to be displayed when the most recently added field
+    # is highlighted.
+    def addFieldSoftkey(index, label, uri, icon=nil)
+      @entries[@entries.size-1].addSoftkey(index, label, uri, icon)
+    end
+
+    # Create XML text output.
+    def render
+      @type = 'string' if @type.nil?
+      xml = "<PhoneInputScreen type=\"#{@type}\""
+      xml += " password=\"yes\"" if @password == "yes"
+      xml += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
+      xml += " cancelAction=\"#{escape(@cancelAction)}\"" if not @cancelAction.nil?
+      xml += " editable=\"no\"" if @editable == "no"
+      xml += " Beep=\"yes\"" if @beep == "yes"
+      xml += " defaultIndex=\"#{@defaultindex}\"" if not @defaultindex.nil?
+      xml += " inputLanguage=\"#{@inputlanguage}\"" if not @inputlanguage.nil?
+      xml += " displayMode=\"#{@displaymode}\"" if not @displaymode.nil?
+      xml += " LockIn=\"yes\"" if @lockin == "yes"
+      xml += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
+      xml += " Timeout=\"#{@timeout}\"" if @timeout != 0
+      xml += ">\n"
+      if not @title.nil? then
+        xml += "<Title"
+        out += " wrap=\"yes\"" if @title_wrap == "yes"
+        xml += ">#{escape(@title)}</Title>\n"
+      end
+      xml += "<Prompt>#{escape(@prompt)}</Prompt>\n" if not @prompt.nil?
+      xml += "<URL>#{escape(@url)}</URL>\n"
+      xml += "<Parameter>#{@parameter}</Parameter>\n" if not @parameter.nil?
+      xml += "<Default>#{@default}</Default>\n"
+      @entries.each { |entry| xml += entry.render }
+      @softkeys.each { |softkey| xml += softkey.render }
+      iconList = 0
+      @icons.each do |icon|
+        if iconList == 0 then
+          xml += "<IconList>\n"
+          iconList = 1
+        end
+        xml += icon.render
+      end
+      xml += "</IconList>\n" if iconList != 0
+      xml += "</PhoneInputScreen>\n"
+      return xml
+    end
+  end
+end