s41c 0.0.2 → 0.0.4

data/README.md

@@ -16,21 +16,29 @@ TCP-socket-сервер и клиент для платформы "1С:Пред
 
 ### Пример использования
 
-Запустить сервер для 1C:Предприятия 7.7 (сетевая версия) на localhost:1421
+#### Сервер
+
+Запустить сервер для 1C:Предприятия 7.7 (сетевая версия) на localhost:1421 
+и использовать базу "C:\Base\"
 
     require 's41c'
 
     server = S41C::Server.new
+    server.db('C:\Base\\')
     server.start
 
 Или чуть сложнее: запустить сервер для 1С:Предприятия (локальная версия) на
-127.0.0.1:2000, писать лог в c:\server.log  и записать время остановки 
-сервера в файл
+127.0.0.1:2000, использовать базу "C:\Base\", при подключении требовать логин 
+"username" и пароль "password", писать лог в c:\server.log  и записать время 
+остановки сервера в файл
 
     require 's41c'
 
     server = S41C::Server.new('127.0.0.1', 2000, 'c:\server.log')
-    server.ole_object = 'V77L.Application'
+    server.ole_name = 'V77L.Application'
+    server.db('C:\Base\\')
+
+    server.login('username', 'password')
 
     server.at_exit do
       File.open('c:\server_stoped_at.txt', 'w') { |f| f.puts Time.now }
@@ -38,38 +46,56 @@ TCP-socket-сервер и клиент для платформы "1С:Пред
 
     server.start
 
-После запуска с сервером можно общаться по telnet. Комманды, содержащие  не-ASCII
-символы, должны быть utf8-строками переведенными в бинарный формат. В руби это 
-можно сделать с помощью метода [String#force_encoding](http://ruby-doc.org/core-1.9.3/String.html#method-i-force_encoding):
+#### Клиент
+
+При подключении можно указать хост и порт сервера (если не указаны, будут
+использоваться localhost:1421), а также данные для авторизации. После
+подключения на сервер передаётся руби-код в виде строки, который и выполняет все,
+что нам нужно
+
+    require 's41c'
+
+    client = S41C::Client.new('127.0.0.1', 2000)
+    client.login('username', 'password')
+
+    response = client.eval %{
 
-    "utf8-строка".force_encoding("BINARY")
-    => "utf8-\xD1\x81\xD1\x82\xD1\x80\xD0\xBE\xD0\xBA\xD0\xB0"
+      spr = @ole.CreateObject('Справочник.Товары')
 
-Отвечает сервер в том же формате, т.е. на стороне клиента ответ нужно
-преобразовать в utf-строку:
+      if spr.invoke('НайтиПоНаименованию', 'Название товара') == 1.0
+        item = spr.invoke('ТекущийЭлемент')
+        item_id = get_1c_id(item)
+        expr = 'КакаяНибудьФункция(ЗначениеИзСтрокиВнутр(' + item_id + '))'
+        result = @ole.EvalExpr(expr)
+      end
 
-    "utf8-\xD1\x81\xD1\x82\xD1\x80\xD0\xBE\xD0\xBA\xD0\xB0".force_encoding("UTF-8")
-    => "utf8-строка"
+      to_utf8(result)
 
-Список команд:
+    }
 
-* 'connect|параметры_подключения' - подключиться к базе, например:
-    
-    'connect|/d c:\1c\\'
+    puts response
+    client.disconnect
 
-* 'eval_expr|команда' - выполнить команду
-    
-    'eval_expr|ОсновнойЯзык()'
+Внутри кода доступен объект @ole, который и является инстансом 1С. У него есть
+3 метода
 
-* 'create|Название.Объекта' - создать объект
+* CreateObject - создает объект агрегатного типа данных 1С:Предприятия и 
+  возвращает ссылку на него.
 
-    'create|Справочник.Товары'
+* EvalExpr - вычислияет выражение системы 1С:Предприятие и возвращает результат
+  вычисления
 
-* 'invoke|НазваниеМетода|параметры|метода' - выполнить процедуру/функцию для объекта
+* ExecuteBatch - выполняет последовательность операторов системы
+  1С:Предприятие и возвращает статус выполнения (true/false)
 
-    'invoke|НайтиПоНаименованию|Шляпа с полями'
+Вызов функций и процедур созданных объектов осуществляется с помощью метода
+'invoke', которому в качестве первого аргумента передаётся название
+функции/процедуры, а последующих - параметры.
 
-* 'disconnect' - отключиться от 1С
-* 'shutdown' - остановить сервер
+Также достпен ряд вспомогательных функций
 
+* to_bin - переводит utf-строку в бинарный формат
+* to_utf8 - переводит бинарную или строку из 1С в utf-8
+* get_1c_id - обертка над 1С-функцией 'ЗначениеВСтрокуВнутр', возращает
+  строковый идентификатор объекта.
 

data/lib/s41c/client.rb

@@ -4,6 +4,8 @@ module S41C
 
   class Client
 
+    include S41C::Utils
+
     def initialize(host='localhost', port=1421)
       require 'net/telnet'
 
@@ -16,6 +18,8 @@ module S41C
     def login(username, password = nil)
       @login = username.nil? || username.empty? ? nil : username
       @password = password
+
+      self
     end # login
 
     def errors
@@ -23,25 +27,13 @@ module S41C
     end # errors
 
     def connect(options)
-      cmd "connect|#{options}"
+      cmd "connect\0#{options}"
     end # connect
 
     def ping
       cmd "ping"
     end # ping
 
-    def eval_expr(expr)
-      cmd "eval_expr|#{expr}"
-    end # eval_expr
-
-    def create(obj_name)
-      cmd "create|#{obj_name}"
-    end # create
-
-    def invoke(method_name, *args)
-      cmd "invoke|#{method_name}|#{args.join('|')}"
-    end # invoke
-
     def disconnect
       cmd "disconnect"
     end # disconnect
@@ -50,6 +42,10 @@ module S41C
       cmd "shutdown"
     end # shutdown
 
+    def eval(code)
+      cmd "eval\0\n#{code}\nend_of_code"
+    end
+
     private
 
     def conn
@@ -77,21 +73,14 @@ module S41C
 
     def cmd(str)
       return @errors unless conn
-      parse @client.cmd(S41C::Utils.to_bin(str))
+      parse @client.cmd(to_bin(str))
     end # cmd
 
     def parse(response)
-      resp = S41C::Utils.to_utf8(response)
-      res = []
-
-      resp.each_line do |line|
-        res << line.chomp unless line[@prompt]
-      end # each_line
-
-      res.count > 1 ? res : res.first
+      resp = to_utf8(response)
+      resp.lines.first.chomp
     end # parse
 
   end # Client
 
 end # S41C
-

data/lib/s41c/sandbox.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module S41C
+
+  class Sandbox
+
+    include S41C::Utils
+
+    def initialize(ole, code)
+      @ole = ole
+      code.untaint
+      @code = proc {
+        $SAFE = 3
+        instance_eval code, __FILE__, __LINE__
+      }
+    end
+
+    def eval_code
+      begin
+        @code.call
+      rescue WIN32OLERuntimeError => e
+        "Error: #{to_utf8(e.message)}"
+      rescue Exception => e
+        "Error: #{e.message}"
+      rescue => e
+        "Error: #{e.message} from #{__FILE__}:#{__LINE__}"
+      end
+    end
+
+  end
+
+end # S41C

data/lib/s41c/server.rb

@@ -4,27 +4,45 @@ module S41C
 
   class Server
 
+    include S41C::Utils
+
     def initialize(host='localhost', port=1421, log_file=nil)
+      require 'socket'
       require 'win32ole'
 
       @host, @port = host, port
       @logger = log_file ? ::STDOUT.reopen(log_file, 'a') : ::STDOUT
-      @ole_object = 'V77.Application'
+      @ole_name = 'V77.Application'
+
     end # initialize
 
-    def set_login(username, password)
+    def login(username, password)
       @login = username
       @password = password
-    end # login_info
 
-    def ole_object=(name)
-      @ole_object = name
-    end # ole_object
+      self
+    end # login
+
+    def db(database, user=nil, password=nil)
+      @conn_options = "/d #{database}"
+      @conn_options << " /n #{user}" if user
+      @conn_options << " /p #{password}" if password
+
+      self
+    end # db
+
+    def ole_name=(name)
+      @ole_name = name
+
+      self
+    end # ole_name=
 
     def at_exit(&block)
       ::Kernel::at_exit do
         yield
       end
+
+      self
     end # at_exit
 
     def start
@@ -36,6 +54,8 @@ module S41C
         }
       end
 
+      connect_to_1c
+
       server = TCPServer.open(@host, @port)
 
       log "*** Server has been started on #{@host}:#{@port}"
@@ -53,7 +73,7 @@ module S41C
     private
 
     def read_response(session)
-      S41C::Utils.to_utf8(session.gets || '').chomp
+      to_utf8(session.gets || '').chomp
     end # read_response
 
     def log(msg)
@@ -61,52 +81,27 @@ module S41C
       @logger.flush
     end # log
 
-    def connect_to_1c(args)
-      @conn.ole_free unless @conn.nil?
-      options = args.shift || ''
+    def connect_to_1c
       begin
-        @conn = ::WIN32OLE.new('V77.Application') 
-        res = @conn.Initialize(
-          @conn.RMTrade, 
-          options,
+        @ole = ::WIN32OLE.new(@ole_name)
+        @conn = @ole.Initialize(
+          @ole.RMTrade, 
+          (@conn_options),
           ''
         )
-        "Connected"
+      rescue WIN32OLERuntimeError => e
+        @conn = nil
+        log "*** Error: #{to_utf8(e.message)}"
       rescue => e
-        @conn.ole_free
-        "Error: #{e.message}"
+        log "*** Error: #{e.message} from #{__FILE__}:#{__LINE__}"
       end
     end
 
-    def create(args)
+    def eval_code(code)
       return "Error: not connected" unless @conn
-      obj_name = args.shift || ''
-      begin
-        @obj = @conn.CreateObject(obj_name)
-        "Created"
-      rescue => e
-        "Error: #{e.message}"
-      end
-    end
 
-    def eval_expr(args)
-      return "Error: not connected" unless @conn
-      expr = args.shift || ''
-      begin
-        @conn.invoke("EvalExpr", expr).to_s
-      rescue => e
-        "Error: #{e.message}"
-      end
-    end
-
-    def invoke(args)
-      return "Error: working object not found. You must create it before" unless @conn
-      begin
-        @obj.invoke(*args).to_s.encode("UTF-8", "IBM866", :invalid => :replace, :replace => "?")
-      rescue => e
-        "Error: #{e.message}"
-      end
-    end
+      S41C::Sandbox.new(@ole, code).eval_code
+    end # eval_code
 
     def main_loop(server)
       loop do
@@ -138,20 +133,15 @@ module S41C
         end
 
         loop {
-          args = S41C::Utils.to_utf8(session.gets || '').chomp.split('|')
+          args = read_response(session).split("\0")
           cmd = args.shift
           case cmd
-          when "connect"
-            session.puts S41C::Utils.to_bin(connect_to_1c(args))
-            session.puts "+OK"
-          when "create"
-            session.puts S41C::Utils.to_bin(create(args))
-            session.puts "+OK"
-          when "eval_expr"
-            session.puts S41C::Utils.to_bin(eval_expr(args))
-            session.puts "+OK"
-          when "invoke"
-            session.puts S41C::Utils.to_bin(invoke(args))
+          when "eval"
+            code = ""
+            while !(part = session.gets)['end_of_code']
+              code << to_utf8(part)
+            end
+            session.puts to_bin(eval_code(code))
             session.puts "+OK"
           when "ping"
             session.puts "pong"
@@ -165,7 +155,7 @@ module S41C
             session.close
             exit
           else
-            session.puts "Bad command"
+            session.puts "Bad command: `#{cmd}`"
             session.puts "+OK"
           end
         }

data/lib/s41c/utils.rb

@@ -1,15 +1,30 @@
+# encoding: utf-8
+
 module S41C
 
   module Utils
 
-    def Utils.to_bin(str)
-      str.force_encoding("BINARY")
+    def to_bin(str)
+      str.to_s.force_encoding("BINARY")
     end
 
-    def Utils.to_utf8(str)
-      str.force_encoding("UTF-8")
+    def to_utf8(str)
+      return unless str.is_a?(String)
+      if str.encoding.to_s == "IBM866"
+        str.to_s.encode("UTF-8", "IBM866", :invalid => :replace, :replace => "?")
+      else
+        str.to_s.force_encoding("UTF-8")
+      end
     end
 
+    def get_1c_id(obj)
+      return false unless @ole
+
+      str_id = @ole.invoke('ЗначениеВСтрокуВнутр', obj)
+      escaped_str_id = "\"#{str_id.gsub('"', '""')}\""
+
+    end # get_1c_id
+
   end # Utils
 
 end # S41C

data/lib/s41c/version.rb

@@ -1,5 +1,5 @@
 module S41C
 
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 
 end # S41C

data/lib/s41c.rb

@@ -1,5 +1,5 @@
-require 'socket'
 require 's41c/version'
 require 's41c/utils'
+require 's41c/sandbox'
 require 's41c/server'
 require 's41c/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s41c
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-19 00:00:00.000000000 Z
+date: 2012-03-24 00:00:00.000000000 Z
 dependencies: []
 description: TCP-socket сервер и клиент для платформы "1С:Предприятие"
 email:
@@ -20,8 +20,8 @@ extra_rdoc_files: []
 files:
 - LICENSE.BSD
 - s41c.gemspec
-- s41c-0.0.1.gem
 - README.md
+- lib/s41c/sandbox.rb
 - lib/s41c/version.rb
 - lib/s41c/utils.rb
 - lib/s41c/server.rb