orion6_rep 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5395b094d49fd9ba05205ee1601a2423a0404de0
+  data.tar.gz: 8bd4bc765a14e7bc65b8d36661c9b79a56df12d1
+SHA512:
+  metadata.gz: 7c1e613984f180b00ac2e3560efe239e87effa0e3bccf04c22beb5d63053bf285caa6f01f76e1fbd48f68e82dd03606b6e5d3708100bccefa1eca6e2fdbb9ea9
+  data.tar.gz: cb38f0d09d6e2eb820515b96dc5a071ef4ba0bef04201217ba0da8caf51c724f2a065349ca0b827ce7df0918d037a9dd1e34fc0961cad00e39ac305ed8c6156a

data/lib/orion6_rep/change_ip.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require 'socket'
+require 'ipaddr'
+require 'orion6_rep/interface'
+
+module Orion6Rep
+  class ChangeIp
+    UDP_PORT = 65535
+
+    def initialize(interface, new_ip, rep_data)
+      @broadcast_address = Orion6Rep::Interface.broadcast_address(interface)
+      raise "Network interface '#{interface}' not found or doesn't have a broadcast address" if @broadcast_address.nil?
+
+      @new_ip = IPAddr.new(new_ip)
+      # TODO: find what the REP data actually is
+      @rep_data = rep_data
+      @payload = prepare_payload_data
+      @socket = UDPSocket.new
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+    end
+
+    def execute
+      @socket.send(@payload, 0, @broadcast_address, UDP_PORT)
+      responses = IO.select([@socket], nil, nil, 1)
+      raw_data, socket_data = responses.first.first.recvfrom(1)
+      rep_current_ip = IPAddr.new(socket_data.last)
+      return (rep_current_ip == @new_ip ? true : execute)
+    end
+
+    private
+    def prepare_payload_data
+      @rep_data + "//" + @new_ip.to_s
+    end
+  end
+end

data/lib/orion6_rep/clock_time/get.rb

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/clock_time"
+
+module Orion6Rep
+  class ClockTime::Get < ClockTime
+    def initialize(equipment_number, host_address, tcp_port = 3000)
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = 12
+    end
+
+    private
+    GET_TIME_COMMAND = 146
+    GET_TIME_FIELD_QUANTITY = 0
+
+    def get_command
+      GET_TIME_COMMAND
+    end
+
+    def get_field_quantity
+      GET_TIME_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      []
+    end
+
+    def get_data_from_response(payload)
+      # the time comes in a array of unsigned integers, using the following
+      # format. The purpose of the last byte is unknown, but it is probably
+      # some form of data check.
+      #
+      # Example:
+      # |   current time   | DST Start |  DST End  |
+      # [yy, mm, dd, hh, mm, yy, mm, dd, yy, mm, dd]
+      # [11,  1, 21, 15, 17, 10, 10, 17, 11,  2, 20]
+      #
+      # These would be:
+      # - Current Time: 21/01/2011 15:17
+      # - DST Start:    17/10/2010
+      # - DST Start:    20/02/2011
+
+      time_payload = payload.unpack("C5")
+      dst_start_payload = payload[5..-1].unpack("C3")
+      dst_end_payload = payload[8..-1].unpack("C3")
+
+      time = parse_time(time_payload)
+
+      isDstOn = dst_start_payload.any?{|d| d > 0}
+
+      if isDstOn
+        start_dst = parse_date(dst_start_payload)
+        end_dst   = parse_date(dst_end_payload)
+      end
+      [time, start_dst, end_dst]
+    end
+
+    def parse_date(date_array)
+      year = defineCentury(date_array[0].ord)
+      month = date_array[1].ord
+      day = date_array[2].ord
+      Date.civil(year,month,day)
+    end
+
+    def parse_time(date_array)
+      year = defineCentury(date_array[0].ord)
+      month = date_array[1].ord
+      day = date_array[2].ord
+      hour = date_array[3].ord
+      minute = date_array[4].ord
+      Time.local(year,month,day,hour,minute)
+    end
+
+    def defineCentury(year)
+      year > 79 ? year + 1900 : year + 2000
+    end
+  end
+end

data/lib/orion6_rep/clock_time/set.rb

@@ -0,0 +1,96 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/clock_time"
+
+module Orion6Rep
+  class ClockTime::Set < ClockTime
+    def initialize(time, start_dst, end_dst, equipment_number, host_address, tcp_port = 3000)
+      if (start_dst.nil? and end_dst.is_a?(Date) or
+          start_dst.is_a?(Date) and end_dst.nil?)
+        raise "Both start and end DST dates must be dates or nil"
+      end
+
+      @time = time
+      @start_dst = start_dst
+      @end_dst = end_dst
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = 0
+    end
+
+    private
+    SET_TIME_COMMAND = 130
+    SET_TIME_FIELD_QUANTITY = 1
+
+    def get_time
+      @time
+    end
+
+    def get_start_dst
+      @start_dst
+    end
+
+    def get_end_dst
+      @end_dst
+    end
+
+    def get_command
+      SET_TIME_COMMAND
+    end
+
+    def get_field_quantity
+      SET_TIME_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      data = get_time_as_data_param(get_time)
+
+      start_dst = get_start_dst
+      end_dst = get_end_dst
+      if start_dst and end_dst
+        data += get_date_as_data_param(start_dst)
+        data += get_date_as_data_param(end_dst)
+      else
+        data += [0, 0, 0, 0, 0, 0] # if no DST is specified just send zeros
+      end
+      data << crc_check(data)
+      data
+    end
+
+    def get_date_as_data_param(date)
+      year   = date.year % 100 # years must be of 2 digits in the clock
+      month  = date.month
+      day    = date.day
+      [year, month, day]
+    end
+
+    def get_time_as_data_param(time)
+      data = get_date_as_data_param(time)
+      data << time.hour
+      data << time.min
+      data
+    end
+
+    def get_data_from_response(payload)
+      true
+    end
+  end
+end

data/lib/orion6_rep/clock_time.rb

@@ -0,0 +1,31 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/command"
+
+module Orion6Rep
+  class ClockTime < Command
+    private
+    TIME_FIELD_SIZE  = 11
+
+    def get_field_size
+      TIME_FIELD_SIZE
+    end
+  end
+end

data/lib/orion6_rep/command.rb

@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/communication"
+
+module Orion6Rep
+  class Command
+    def execute
+      # first set the header:
+      command_data = generate_header
+
+      # now comes the data:
+      command_data += generate_command_data
+
+      # now send it!
+      response = Communication.communicate(get_host_address, get_tcp_port, command_data, get_expected_response_size, get_timeout_time, get_max_attempts)
+
+      # check everything:
+      check_response_header(response)
+      check_response_payload(response)
+
+      # and then get and process the response payload:
+      payload = get_response_payload(response)
+      return get_data_from_response(payload)
+    end
+
+    private
+    # TODO: find what is this constant. It's the size of something, perhaps?
+    UNKNOWN_CONSTANT = 113
+
+    HEADER_SIZE = 8
+    @reponse_size = 0
+
+    def get_timeout_time
+      3
+    end
+
+    def get_max_attempts
+      3
+    end
+
+    def get_expected_response_size
+      HEADER_SIZE + @reponse_size
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_equipment_number
+      @equipment_number
+    end
+
+    def get_host_address
+      @host_address
+    end
+
+    def get_tcp_port
+      @tcp_port
+    end
+
+    def check_response_header(response)
+      crc_check(response[0..6]) == response[7].ord
+    end
+
+    def check_response_payload(response)
+      crc_check(response[8..-2]) == response[-1].ord
+    end
+
+    def get_response_payload(response)
+      # TODO: other payloads might be different
+      response[8..-2]
+    end
+
+    def convert_to_integer_as_little_endian(integer_array)
+      self.class.convert_to_integer_as_little_endian(integer_array)
+    end
+
+    def convert_to_integer_as_big_endian(integer_array)
+      self.class.convert_to_integer_as_big_endian(integer_array)
+    end
+
+    def crc_size
+      1
+    end
+
+    def generate_header
+      field_quantity = get_field_quantity
+
+      header = [get_equipment_number^255] # TODO: find why this is needed
+      header << get_command
+      header << get_unknown_constant
+      header << divide_by_256(get_field_size)
+      header << (get_field_size & 255)
+      header << field_quantity
+      header << divide_by_256(field_quantity)
+      header << crc_check(header) # TODO: find why this is needed; maybe a data check?
+      header
+    end
+
+    def get_command
+      raise_not_implemented_error
+    end
+
+    def get_field_size
+      raise_not_implemented_error
+    end
+
+    def get_field_quantity
+      raise_not_implemented_error
+    end
+
+    def generate_command_data
+      raise_not_implemented_error
+    end
+
+    def get_data_from_response(payload)
+      raise_not_implemented_error
+    end
+
+    def crc_check(data)
+      self.class.xor(data)
+    end
+
+    def divide_by_256(value)
+      return (value >> 8 & 255)
+    end
+
+    class << self
+      def xor(data)
+        value = 0;
+        data = data.unpack("C*") if data.is_a?(String)
+        data.each do |integer|
+          value ^= integer
+        end
+        value
+      end
+
+      def convert_to_integer_as_little_endian(integer_array)
+        value = 0
+        integer_array.each_with_index do |byte, index|
+          value += (byte.to_i << 8*index)
+        end
+        value
+      end
+
+      # This method is the same of the little-endian one above, just with the
+      # input data reversed.
+      def convert_to_integer_as_big_endian(integer_array)
+        convert_to_integer_as_little_endian(integer_array.reverse)
+      end
+    end
+
+    private
+    def raise_not_implemented_error
+      raise NotImplementedError.new "This method should be overriden by the subclass #{self.class.to_s}"
+    end
+  end
+end

data/lib/orion6_rep/communication.rb

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require 'socket'
+require 'timeout'
+
+module Orion6Rep
+  module Communication
+    include Timeout
+
+    class << self
+      def communicate(host_address, port, payload, expected_response_size, timeout_time=60, max_attempts = 3)
+        attempt = 0
+
+        while attempt < max_attempts do
+          socket = nil
+          begin
+            timeout(timeout_time) {
+              socket = TCPSocket.open(host_address, port)
+            }
+          rescue Timeout::Error => e
+            socket = nil
+          end
+
+          received_data = nil
+
+          if socket
+            begin
+              received_data = send_receive_data(socket, payload, expected_response_size, timeout_time)
+            rescue Timeout::Error => e
+              socket.close
+            end
+          end
+
+          break unless received_data.nil?
+          attempt += 1
+        end
+
+        raise "Timeout error" if attempt >= max_attempts
+        received_data
+      end
+
+      private
+      def send_receive_data(socket, data_to_send, expected_response_size, timeout_time)
+        socket.write(data_to_send.pack("C*"))
+        socket.flush
+        data_to_receive = ""
+
+        # expected_response_size can be a Fixnum, for fixed responses sizes, or
+        # a proc, where the response size comes inside the response itself.
+        if expected_response_size.is_a?(Proc)
+          expected_size = expected_response_size.call(data_to_receive)
+        else
+          expected_size = expected_response_size
+        end
+
+        while data_to_receive.size < expected_size
+          bytes_to_be_read = expected_size - data_to_receive.size
+          bytes_to_be_read = 100 if bytes_to_be_read > 100
+
+          timeout(timeout_time) {
+            data_to_receive += socket.readpartial( bytes_to_be_read )
+          }
+          if expected_response_size.is_a?(Proc)
+            expected_size = expected_response_size.call(data_to_receive)
+          end
+        end
+        data_to_receive
+      end
+    end
+  end
+end

data/lib/orion6_rep/detect_reps.rb

@@ -0,0 +1,86 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require 'socket'
+require 'orion6_rep/interface'
+
+module Orion6Rep
+  class DetectReps
+    UDP_DETECTION_PORT = 65535
+    UDP_DETECTION_DATA = [0x58].pack("C")
+
+    def initialize
+      ifaces_names = Orion6Rep::Interface.get_active_interfaces_names
+      # it's useless to try to detect REPs in the localhost
+      ifaces_names.delete("lo")
+
+      @interfaces = {}
+      @responses = {}
+      ifaces_names.each do |name|
+        broadcast_address = Orion6Rep::Interface.broadcast_address(name)
+        @interfaces[name] = {}
+        @interfaces[name][:broadcast_addr] = broadcast_address
+      end
+      raise "No active network interfaces found" if @interfaces.empty?
+
+      @interfaces.each_key do |name|
+        socket = UDPSocket.new
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+        @interfaces[name][:socket] = socket
+      end
+    end
+
+    def execute
+      @interfaces.each do |_, data|
+        data[:socket].send(UDP_DETECTION_DATA, 0, data[:broadcast_addr], UDP_DETECTION_PORT)
+      end
+    end
+
+    def pool
+      rep_responses = IO.select(get_sockets, nil, nil, 1)
+
+      unless rep_responses.nil? or rep_responses.empty?
+        rep_responses.first.each do |socket|
+          raw_data, socket_data = socket.recvfrom(33)
+          rep_data, tcp_port = raw_data.unpack("a18a4")
+          ip = socket_data.last
+          interface = get_assossiated_interface(socket)
+          @responses[interface] = {} if @responses[interface].nil?
+          @responses[interface][ip] = {:port => tcp_port.to_i, :rep_data => rep_data}
+        end
+      end
+
+      return @responses
+    end
+
+    def stop
+      get_sockets.each{|socket| socket.close}
+      true
+    end
+
+    private
+    def get_sockets
+      @interfaces.collect{|_, data| data[:socket]}
+    end
+
+    def get_assossiated_interface(socket)
+      @interfaces.each{|interface, data| return interface if data[:socket] == socket}
+    end
+  end
+end