ruby-macrodroid 0.8.11 → 0.9.3

data/lib/ruby-macrodroid/macro.rb

@@ -3,6 +3,10 @@
 
 # This file contains the following classes:
 #  
+#  ## Nlp classes
+#  
+#  TriggersNlp ActionsNlp ConstraintsNlp
+#     
 #  ## Macro class
 #  
 #  Macro
@@ -12,11 +16,372 @@
 VAR_TYPES = {
   String: [2, :string_value], 
   TrueClass: [0, :boolean_value], 
-  TrueClass: [0, :boolean_value],
+  FalseClass: [0, :boolean_value],
   Integer: [1, :int_value],
   Float: [3, :decimal_value]
 }
 
+class TriggersNlp
+  include AppRoutes
+
+  def initialize(macro=nil)
+
+    super()
+    params = {macro: macro}
+    triggers(params)
+
+  end
+
+  def triggers(params) 
+    
+    # e.g. at 7:30pm daily
+    get /^(?:at )?(\d+:\d+(?:[ap]m)?) daily/i do |time, days|
+      [TimerTrigger, {time: time, 
+                      days: %w(Mon Tue Wed Thu Fri Sat Sun).join(', ')}]
+    end       
+
+    get /^(?:at )?(\d+:\d+(?:[ap]m)?) (?:on )?(.*)/i do |time, days|
+      [TimerTrigger, {time: time, days: days}]
+    end
+
+    # time.is? 'at 18:30pm on Mon or Tue'
+    get /^time.is\? ['"](?:at )?(\d+:\d+(?:[ap]m)?) (?:on )?(.*)['"]/i do |time, days|      
+      [TimerTrigger, {time: time, days: days.gsub(' or ',', ')}]
+    end     
+    
+    get /^shake[ _]device\??$/i do 
+      [ShakeDeviceTrigger, {}]
+    end
+    
+    get /^Flip Device (.*)$/i do |motion|
+       facedown = motion =~ /Face Up (?:->|to) Face Down/i
+      [FlipDeviceTrigger, {face_down: facedown }]
+    end
+    
+    get /^flip_device_down\?$/i do
+      [FlipDeviceTrigger, {face_down: true }]
+    end
+
+    get /^flip_device_up\?$/i do
+      [FlipDeviceTrigger, {face_down: false }]
+    end        
+    
+    get /^Failed Login Attempt$/i do
+      [FailedLoginTrigger, {}]
+    end
+    
+    get /^failed_login?$/i do
+      [FailedLoginTrigger, {}]
+    end         
+
+    get /^Geofence (Entry|Exit) \(([^\)]+)/i do |direction, name|
+      enter_area = direction.downcase.to_sym == :entry
+      [GeofenceTrigger, {name: name, enter_area: enter_area}]
+    end     
+    
+    get /^location (entered|exited) \(([^\)]+)/i do |direction, name|
+      enter_area = direction.downcase.to_sym == :entered
+      [GeofenceTrigger, {name: name, enter_area: enter_area}]
+    end
+    
+    # eg. Proximity Sensor (Near)
+    #
+    get /^Proximity Sensor \(([^\)]+)\)/i do |distance|
+      
+      [ProximityTrigger, {distance: distance}]
+    end    
+    
+    # eg. Proximity near
+    #
+    get /^Proximity (near|far|slow wave|fast wave)/i do |distance|
+      
+      [ProximityTrigger, {distance: distance}]
+    end       
+    
+    get /^WebHook \(Url\)/i do       
+      [WebHookTrigger, params]
+    end      
+
+    get /^WebHook/i do       
+      [WebHookTrigger, params]
+    end
+    
+    get /^wh/i do       
+      [WebHookTrigger, params]
+    end          
+
+    #  MacroDroid specific ---------------------------------------------------------------
+
+    get /^EmptyTrigger$/i do       
+      [EmptyTrigger, params]
+    end          
+    
+  end
+
+  alias find_trigger run_route
+
+  def to_s(colour: false)
+    'TriggersNlp ' + @h.inspect
+  end
+
+  alias to_summary to_s
+end
+
+class ActionsNlp
+  include AppRoutes
+
+  def initialize(macro=nil)
+
+    super()
+    params = {macro: macro}
+    actions(params)
+
+  end
+
+  def actions(params) 
+
+    # e.g. message popup: hello world!
+    get /^message popup: (.*)/i do |msg|
+      [ToastAction, {msg: msg}]
+    end
+
+    # e.g. Popup Message 'hello world!'
+    get /^Popup[ _]Message ['"]([^'"]+)/i do |msg|
+      [ToastAction, {msg: msg}]
+    end
+    
+    # e.g. Popup Message\n  hello world!
+    get /^Popup Message\n\s+(.*)/im do |msg|
+      [ToastAction, {msg: msg}]
+    end    
+            
+    # e.g. Popup Message
+    get /^Popup Message$/i do
+      [ToastAction, {}]
+    end    
+    
+    # e.g. say current time
+    get /^say current[ _]time/i do
+      [SayTimeAction, {}]
+    end    
+    
+    get /^Torch :?(.*)/i do |onoffstate|
+      state = %w(on off toggle).index onoffstate.downcase
+      [CameraFlashLightAction, {state: state}]
+    end    
+    
+    get /^Take Picture/i do
+      [TakePictureAction, {}]
+    end
+    
+    get /^take_picture/i do
+      [TakePictureAction, {}]
+    end           
+    
+    # -- DEVICE ACTIONS ------------------------------------------------------
+    
+    get /^Speak text \(([^\)]+)\)/i do |text|
+      [SpeakTextAction, {text: text}]
+    end           
+    
+    get /^Speak text ['"]([^'"]+)/i do |text|
+      [SpeakTextAction, {text: text}]
+    end         
+    
+    get /^Speak text$/i do |text|
+      [SpeakTextAction, {}]
+    end     
+    
+    get /^Vibrate \(([^\)]+)/i do |pattern|
+      [VibrateAction, {pattern: pattern}]
+    end     
+    
+    # e.g. Display Notification: Hi there: This is the body of the message
+    get /^Display Notification: ([^:]+): [^$]+$/i do |subject, text|
+      [NotificationAction, {subject: subject, text: text}]
+    end           
+    
+    
+    # e.g. Enable Wifi
+    get /^(Enable|Disable) Wifi$/i do |raw_state|
+      
+      state = raw_state.downcase.to_sym == :enable ? 0 : 1
+      [SetWifiAction, {state: state}]
+      
+    end    
+    
+    # e.g. Play: Altair
+    get /^Play: (.*)$/i do |name|
+
+      [PlaySoundAction, {file_path: name}]
+      
+    end     
+    
+    # e.g. Launch Settings
+    get /^Launch (.*)$/i do |application|
+
+      h = {
+        application_name: application,
+        package_to_launch: 'com.android.' + application.downcase
+      }
+      [LaunchActivityAction, h]
+      
+    end
+    
+    # e.g. HTTP GET http://someurl.com/something
+    get /^HTTP GET ([^$]+)$/i do |url|
+
+      [OpenWebPageAction, url_to_open: url]
+      
+    end
+        
+    get /^HTTP GET$/i do
+
+      [OpenWebPageAction, {}]
+      
+    end    
+    
+    # e.g. webhook entered_kitchen
+    #
+    get /(?:webhook|HTTP GET) ([^$]+)$/i do |s|
+      key = s =~ /^http/ ? :url_to_open : :identifier      
+      [OpenWebPageAction, {key => s}]
+    end
+    
+    #
+    get /^WebHook \(Url\)/i do
+      [OpenWebPageAction, params]
+    end
+    
+    # e.g. webhook entered_kitchen
+    #
+    get /^webhook$/i do
+      [OpenWebPageAction, params]
+    end
+    
+    # -- Location ---------------------------------------------------------
+    
+    get /^Force Location Update$/i do
+      [ForceLocationUpdateAction, params]
+    end    
+    
+    get /^Share Location$/i do
+      [ShareLocationAction, params]
+    end    
+    
+    #a: Keep Device Awake Screen On Until Disabled
+    #
+    get /Keep Device Awake Screen On Until Disabled/i do
+      [KeepAwakeAction, {enabled: true, permanent: true, screen_option: 0}]
+    end
+    
+    
+    #a: Keep Device Awake Screen On 1h 1m 1s
+    #
+    get /Keep Device Awake Screen On ([^$]+)/i do |duration|
+      
+      a = duration.split.map(&:to_i)
+      secs = Subunit.new(units={minutes:60, hours:60, seconds: 60}, a).to_i
+      
+      h = {
+        permanent: true, screen_option: 0, seconds_to_stay_awake_for: secs
+      }
+      [KeepAwakeAction, h]
+    end
+    
+    get /Keep Device Awake$/i do
+      [KeepAwakeAction, params]
+    end    
+    
+    #a: Disable Keep Awake
+    #
+    get /Disable Keep Awake/i do
+      [KeepAwakeAction, {enabled: false, screen_option: 0}]
+    end    
+
+    #e.g a: if Airplane mode enabled
+    #
+    get /if (.*)/i do
+      [IfConditionAction, {}]
+    end
+    
+    get /End If/i do
+      [EndIfAction, {}]
+    end          
+    
+    # -- MacroDroid Specific ------------------------------------------------
+    #
+    get /^Set Variable$/i do
+      [SetVariableAction, {}]
+    end        
+
+  end
+
+  alias find_action run_route
+
+
+end
+
+class ConstraintsNlp
+  include AppRoutes
+
+  def initialize()
+
+    super()
+    params = {}
+    constraints(params)
+
+  end
+
+  def constraints(params) 
+    
+    # Device State        
+    
+    get /^Device (locked|unlocked)/i do |state|
+      [DeviceLockedConstraint, {locked: state.downcase == 'locked'}]
+    end
+
+    get /^airplane mode (.*)/i do |state|
+      [AirplaneModeConstraint, {enabled: (state =~ /^enabled|on$/i) == 0}]
+    end
+    
+    # 
+    
+    # -- Sensors -----------------------------------
+    #
+    get /^Light Sensor (Less|Greater) than (50.0)lx/i do |operator, val|
+
+      level, option = operator.downcase == 'less' ? [-1,0] : [1,1]
+      
+      h = {
+        light_level: level,
+        light_level_float: val,
+        option: option
+      }
+      
+      [LightLevelConstraint, h]
+    end
+    
+    get /^Proximity Sensor: (Near|Far)/i do |distance|      
+      [ProximitySensorConstraint, {near: distance.downcase == 'near'}]
+    end
+    
+    
+    # -- Screen and Speaker ---------------------------
+    #
+    get /^Screen (On|Off)/i do |state|      
+      [ScreenOnOffConstraint, {screen_on: state.downcase == 'on'}]
+    end    
+
+  end
+
+  alias find_constraint run_route
+
+end
+
+
+class MacroError < Exception
+end
 
 class Macro
   using ColouredText
@@ -24,15 +389,17 @@ class Macro
 
   attr_reader :local_variables, :triggers, :actions, :constraints, 
       :guid, :deviceid
-  attr_accessor :title, :description
+  attr_accessor :title, :description, :remote_url
 
-  def initialize(name=nil, geofences: nil, deviceid: nil, debug: false)
+  def initialize(name=nil, geofences: nil, deviceid: nil, remote_url: nil, 
+                 debug: false)
 
     @title, @geofences, @deviceid, @debug = name, geofences, deviceid, debug
+    @remote_url = remote_url
     
     puts 'inside Macro#initialize' if @debug    
           
-    @local_variables, @triggers, @actions, @constraints = [], [], [], []
+    @local_variables, @triggers, @actions, @constraints = {}, [], [], []
     @h = {}
     
   end
@@ -59,9 +426,13 @@ class Macro
   end
 
   def to_h()
+    
+    a = @local_variables.map do |k,v|
+      varify(k,v).to_camelcase.map{|key,value| ['m_' + key, value]}.to_h
+    end
 
     h = {
-      local_variables: varify(@local_variables),
+      local_variables: a,
       m_trigger_list: @triggers.map(&:to_h),
       m_action_list: @actions.map(&:to_h),
       m_category: @category,
@@ -71,7 +442,7 @@ class Macro
       m_excludeLog: false,
       m_GUID: guid(),
       m_isOrCondition: false,
-      m_enabled: false,
+      m_enabled: true,
       m_descriptionOpen: false,
       m_headingColor: 0
     }
@@ -96,7 +467,7 @@ class Macro
     if h[:local_variables].any? and h[:local_variables].first.any? then
       
       @local_variables = h[:local_variables].map do |var|
-              
+
         val = case var[:type]
         when 0 # boolean
           var[:boolean_value]
@@ -115,7 +486,7 @@ class Macro
     
     # fetch the triggers
     @triggers = h[:trigger_list].map do |trigger|
-      puts 'trigger: ' + trigger.inspect
+      puts 'trigger: ' + trigger.inspect if @debug
       #exit      
       object(trigger.to_snake_case)
 
@@ -194,31 +565,103 @@ class Macro
       
       @title = node.text('macro') || node.attributes[:name]
       
-      @local_variables = node.xpath('variable').map do |e|
-        e.text.split(/: +/,2)
+      d = node.element('description')
+      
+      if d then
+        
+        desc = []
+        desc << d.text.strip
+        
+        if d.element('item/description') then
+          desc <<  d.text('item/description').strip
+        end
+        
+        @description = desc.join("\n")
+
       end
       
+      node.xpath('variable').each {|e| set_var(*e.text.to_s.split(/: */,2)) }
+      
       #@description = node.attributes[:description]      
       
       tp = TriggersNlp.new(self)      
       
-      @triggers = node.xpath('trigger').map do |e|
+      @triggers = node.xpath('trigger').flat_map do |e|
         
         r = tp.find_trigger e.text
         
         puts 'found trigger ' + r.inspect if @debug
         
-        if r then
-          if r[0] == GeofenceTrigger then
-            GeofenceTrigger.new(r[1], geofences: @geofences)
+        item = e.element('item')
+        if item then
+          
+          if item.element('description') then
+            
+            item.xpath('description').map do |description|
+              
+              inner_lines = description.text.to_s.strip.lines
+              puts 'inner_lines: ' + inner_lines.inspect if @debug
+              
+              trigger = if e.text.to_s.strip.empty? then
+                inner_lines.shift.strip
+              else
+                e.text.strip
+              end
+              
+              puts 'trigger: ' + trigger.inspect if @debug
+              
+              r = tp.find_trigger trigger          
+              puts 'r: ' + r.inspect if @debug
+              #o = r[0].new([description, self]) if r
+              o = object_create(r[0], [description, self]) if r                            
+              puts 'after o' if @debug
+              o
+              
+            end
+            
+          else
+            
+            trigger = e.text.strip
+            r = tp.find_trigger trigger
+
+            a = e.xpath('item/*')
+
+            h = if a.any? then
+              a.map {|node| [node.name.to_sym, node.text.to_s]}.to_h
+            else
+              {}
+            end
+
+            r = tp.find_trigger trigger          
+            #r[0].new(h) if r
+            if r then
+              object_create(r[0], h)
+            else
+              raise MacroError, 'App-routes: Trigger "' + trigger + '" not found' 
+            end
+            
+          end
+          
+        else
+          
+          trigger = e.text.strip
+          r = tp.find_trigger trigger
+          #r[0].new(r[1]) if r
+          
+          if r then
+            object_create(r[0],r[1])
           else
-            r[0].new(r[1])
+            raise MacroError, 'App-routes: Trigger "' + trigger + '" not found' 
           end
+          
         end
         
+        
       end
+    
+
       
-      ap = ActionsNlp.new      
+      ap = ActionsNlp.new self    
       
       @actions = node.xpath('action').flat_map do |e|
         
@@ -245,8 +688,10 @@ class Macro
               
               r = ap.find_action action          
               puts 'r: ' + r.inspect if @debug
-              o = r[0].new(description) if r              
-              puts 'after o'
+              puts 'description: ' + description.xml.inspect if @debug
+              #o = r[0].new([description, self]) if r
+              o = object_create(r[0],[description, self]) if r
+              puts 'after o' if @debug
               o
               
             end
@@ -254,6 +699,7 @@ class Macro
           else
             
             action = e.text.strip
+            puts 'action: ' + action.inspect if @debug
             r = ap.find_action action
 
             a = e.xpath('item/*')
@@ -263,9 +709,11 @@ class Macro
             else
               {}
             end
+            puts 'h: ' + h.inspect if @debug
 
-            r = ap.find_action action          
-            r[0].new(h) if r
+            #r = ap.find_action action          
+            #r[0].new(h.merge(macro: self)) if r
+            object_create(r[0], h.merge(macro: self)) if r
             
           end
           
@@ -273,7 +721,8 @@ class Macro
           
           action = e.text.strip
           r = ap.find_action action          
-          r[0].new(r[1]) if r
+          #r[0].new(r[1]) if r
+          object_create(r[0],r[1]) if r
           
         end
 
@@ -286,9 +735,7 @@ class Macro
         r = cp.find_constraint e.text
         puts 'found constraint ' + r.inspect if @debug
         
-        if r then
-          r[0].new(r[1])
-        end
+        object_create(r[0], r[1]) if r
         
       end                                   
       
@@ -333,6 +780,27 @@ class Macro
   def set_env()
     @triggers.each(&:set_env)
   end
+  
+  def set_var(label, v='')
+        
+    value = if v.to_f.to_s == v
+      v.to_f
+    elsif v.downcase == 'true'
+      true
+    elsif v.downcase == 'false' 
+      false
+    elsif v.to_i.to_s == v
+      v.to_i
+    else
+      v
+    end
+
+    if not @local_variables.has_key? label.to_sym then
+      @local_variables.merge!({label.to_sym => value}) 
+    end
+
+    varify(label, value)
+  end
 
   def to_pc()
     
@@ -378,13 +846,21 @@ EOF
     puts 'before triggers' if @debug
     
     a << @triggers.map do |x|
+      
+      puts 'x: ' + x.inspect if @debug
+      raise 'Macro#to_s trigger cannot be nil' if x.nil?
+      
       s =-x.to_s(colour: colour)
+      puts 's: ' + s.inspect if @debug
       
       s2 = if s.lines.length > 1 then        
         "\n" + s.lines.map {|x| x.prepend ('  ' * (indent+1)) }.join
       else
         ' ' + s
       end         
+      
+      puts 's2: ' + s2.inspect if @debug
+      
       #s.lines > 1 ? "\n" + x : x
       (colour ? "t".bg_red.gray.bold : 't') + ":" + s2
     end.join("\n")
@@ -519,42 +995,47 @@ EOF
 
     puts ('inside object h:'  + h.inspect).debug if @debug  
     klass = Object.const_get h[:class_type]
-    puts klass.inspect.highlight if $debug
+    puts klass.inspect.highlight if @debug
     
     if klass == GeofenceTrigger then
-      puts 'GeofenceTrigger found'.highlight if $debug
+      puts 'GeofenceTrigger found'.highlight if @debug
       GeofenceTrigger.new(h, geofences: @geofences)
     else
-      puts 'before klass'
+      puts 'before klass' if @debug
       h2 = h.merge( macro: self)
-      puts 'h2: ' + h2.inspect      
+      puts 'h2: ' + h2.inspect if @debug      
       r = klass.new h2 
-      puts 'r:' + r.inspect
+      puts 'r:' + r.inspect if @debug
       r
       
     end
     
   end
   
-  def varify(local_variables)
-    
-        
-    local_variables.map do |key, value|
-      
-      
-      type = VAR_TYPES[value.class.to_s.to_sym]
-      
-      h = {
-        boolean_value: false,
-        decimal_value: 0.0,
-        int_value: 0,
-        name: key,
-        string_value: '',
-        type: type[0]
-      }
-      h[type[1]] = value
-      h
+  def object_create(klass, *args)
+
+    begin
+      klass.new(*args)
+    rescue
+      raise MacroError, klass.to_s + ': ' + ($!).to_s
     end
+  end
+  
+  def varify(label, value='')
+                        
+
+    type = VAR_TYPES[value.class.to_s.to_sym]
+
+    h = {
+      boolean_value: false,
+      decimal_value: 0.0,
+      int_value: 0,
+      name: label,
+      string_value: '',
+      type: type[0]
+    }
+    h[type[1]] = value
+    h
     
   end