ffi-cups 0.1.1 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2e82ad0fb30fa3e5c587658a3eef2af2044b3e06564e581c68e3b6d2d7e18db
-  data.tar.gz: c0f9f05991f788f5e4f2e10cf2e603fea2bb3eb45061d8318bd769e92be2b2f0
+  metadata.gz: 2cd36e5fc525b811e3fedc0ef3b015aa47e04cf93528510a539ae3562a0e0357
+  data.tar.gz: ca00e58337c11b4291dc1debd2908e21e3bb772d4127779fc28937043fd77aa6
 SHA512:
-  metadata.gz: 4d1d560770915cf815dd32172d4707068401b9b7892babc5c3d099d99de7e10a567dd4a59a7543510f20d0a266361cf73b1e0abf23a971d04c4795d6be6d7c70
-  data.tar.gz: 6e3400f9edef9223e67fc46fbe4c51b1d7492c0e99d3a9e60360d3bb7745df9c6a79eb2d35ca7a805740dbe158f0848b3b4d4f2a3094ac140f1a7bb58ab49656
+  metadata.gz: 2f751bb3648d4b66926dc962a469f6446de032c0d309892ff8defae327051c5425bdb54ad7bf52f557e11d4f03e120269abc63b17a0091ac47652042e6350bfa
+  data.tar.gz: 5726071fba04a620382afc78954c3f0790c496befdecc0cad3a3c8327cf440c4fd9f68e03a96d695fa6c2ef737bbcdb709f49cbe89889feb7eaa20292b1c2f14

data/.gitignore

@@ -3,6 +3,8 @@ log/
 pkg/
 *.gem
 
+Gemfile.lock
+
 # YARD
 .yardopts
 .yardoc

data/README.md

@@ -1,4 +1,6 @@
 # ffi-cups
+[![Gem Version](https://badge.fury.io/rb/ffi-cups.svg)](https://badge.fury.io/rb/ffi-cups)
+
 ffi-cups is a FFI wrapper around libcups providing access to the Cups API.
 It was written using Ruby 2.7.0.
 
@@ -20,38 +22,50 @@ gem install ffi-cups
 ffi-cups requires libcups2 to be installed
 
 ## TODO
-- send print jobs by creating the job itself first.
+- Job's state
+- Cancel jobs
+- Get all jobs with filters
 
 ## Example usage
 ```ruby
 require 'ffi-cups'
 
 printers = Cups::Printer.get_destinations
-# [#<Cups::Printer:0x000055fe50b178e0 @name="HP_Officejet_J4500_series_ubuntu", @options={"device-uri"=>"ipps://HP%20Officejet%20J4500%20series%20%40%20ubuntu._ipps._tcp.local/cups", "printer-info"=>"HP Officejet J4500 series @ ubuntu", "printer-location"=>"", "printer-make-and-model"=>"HP Officejet j4585 All-in-one Printer", "printer-type"=>"16814110"}>, #<Cups::Printer:0x000055fe50b15798 @name="Virtual_PDF_Printer", @options={"copies"=>"1", "device-uri"=>"cups-pdf:/", "finishings"=>"3", "job-cancel-after"=>"10800", "job-hold-until"=>"no-hold", "job-priority"=>"50", "job-sheets"=>"none,none", "marker-change-time"=>"0", "number-up"=>"1", "printer-commands"=>"AutoConfigure,Clean,PrintSelfTestPage", "printer-info"=>"Virtual PDF Printer", "printer-is-accepting-jobs"=>"true", "printer-is-shared"=>"false", "printer-is-temporary"=>"false", "printer-location"=>"", "printer-make-and-model"=>"Generic CUPS-PDF Printer (w/ options)", "printer-state"=>"3", "printer-state-change-time"=>"1617884232", "printer-state-reasons"=>"none", "printer-type"=>"10547276", "printer-uri-supported"=>"ipp://localhost/printers/Virtual_PDF_Printer"}>]
+# [#<Cups::Printer:0x000055fe50b15798 @name="Virtual_PDF_Printer",
+#  @options={"copies"=>"1", "device-uri"=>"cups-pdf:/", "finishings"=>"3" 
+#  "job-cancel-after"=>"10800", "job-hold-until"=>"no-hold", ...
 
 printer = Cups::Printer.get_destination("Virtual_PDF_Printer")
-#<Cups::Printer:0x0000560f1d4e0958 @name="Virtual_PDF_Printer", @options={"copies"=>"1", "device-uri"=>"cups-pdf:/", "finishings"=>"3", "job-cancel-after"=>"10800", "job-hold-until"=>"no-hold", "job-priority"=>"50", "job-sheets"=>"none,none", "marker-change-time"=>"0", "number-up"=>"1", "printer-commands"=>"AutoConfigure,Clean,PrintSelfTestPage", "printer-info"=>"Virtual PDF Printer", "printer-is-accepting-jobs"=>"true", "printer-is-shared"=>"false", "printer-is-temporary"=>"false", "printer-location"=>"", "printer-make-and-model"=>"Generic CUPS-PDF Printer (w/ options)", "printer-state"=>"3", "printer-state-change-time"=>"1617884232", "printer-state-reasons"=>"none", "printer-type"=>"10547276", "printer-uri-supported"=>"ipp://localhost/printers/Virtual_PDF_Printer"}> 
+# <Cups::Printer:0x0000560f1d4e0958 @name="Virtual_PDF_Printer", @options={"copies"=>"1" 
+#   "device-uri"=>"cups-pdf:/", ...
+
+printer.state
+# :idle 
+
+printer.state_reasons
+# ["none"]
+
+# Print a file (PDF, JPG, etc) you can pass a hash of printing options if you
+# want to override the printer's default. See Cups::Constants for more options
+options = {
+  Cups::CUPS_MEDIA => Cups::CUPS_MEDIA_A4,
+  Cups::CUPS_ORIENTATION => Cups::CUPS_ORIENTATION_LANDSCAPE
+}
+
+job = printer.print_file('/tmp/example.jpg', 'Title', options)
 
 ```
 
 ## Remote CUPS Server
 You may create a connection object passing a :hostname and/or :port arguments.
 
-You are in charge of the connection object, remember to close the 
-connection once you stop using it.
-
 ```ruby
 # Create a Connection object with hostname and/or port
-connection = Cups::Connection.instance(hostname:'print.example.com')
-
-# Create a http pointer with CUPS API
-http = connection.httpConnect2
+connection = Cups::Connection.instance('print.example.com')
 
 # Get all printers from the remote connection
-remote_printers = Cups::Printer.get_destinations(http)
+remote_printers = Cups::Printer.get_destinations(connection)
 
-# Close connection and release pointer
-Cups::Connection.close(http)
 ```
 
 ## License

data/lib/ffi-cups.rb

@@ -36,4 +36,5 @@ require 'ffi-cups/ffi/array'
 
 # wrappers
 require 'ffi-cups/connection'
+require 'ffi-cups/job'
 require 'ffi-cups/printer'

data/lib/ffi-cups/connection.rb

@@ -8,19 +8,20 @@ module Cups
 
     private_class_method :new
 
-    def initialize(args={})
-      @hostname = args.fetch(:hostname) { Cups::CUPS_HTTP_DEFAULT }
-      @port = args.fetch(:port) { 631 }
+    def initialize(hostname, port=nil)
+      @hostname = hostname
+      @port = port.nil? ? 631 : port
     end
 
     # Returns or creates a singleton instance
-    # @param args [Hash] hash argument with hostname and port
+    # @param hostname [String]
+    # @param port [Integer]
     # @return [Object] a connection object
-    def self.instance(args)
+    def self.instance(hostname, port=nil)
       return @instance if @instance
 
       @instance_mutex.synchronize do 
-        @instance ||= new(args)
+        @instance ||= new(hostname, port)
       end
 
       @instance
@@ -49,8 +50,7 @@ module Cups
     # Wrapper around {::FFI::Cups::Http#httpClose}
     # @param http (Pointer)
     def self.close(http)
-      FFI::Cups::Http.httpClose(pointer)
-      pointer.autorelease = true
+      FFI::Cups::Http.httpClose(http)
     end
   end
 end

data/lib/ffi-cups/ffi/cups.rb

@@ -23,6 +23,14 @@ module FFI::Cups
   # {https://www.cups.org/doc/cupspm.html#cupsCheckDestSupported}
   attach_function 'cupsCheckDestSupported', [:pointer, :pointer, :pointer, :string, :string], :int, blocking: true
 
+  # Get the supported values/capabilities for the destination.
+  # @overload cupsCopyDestInfo(pointer, pointer)
+  #   @param http [Pointer]
+  #   @param dest [Pointer]
+  #   @return [Pointer] Destination information
+  # {https://www.cups.org/doc/cupspm.html#cupsCopyDestInfo}
+  attach_function 'cupsCopyDestInfo', [:pointer, :pointer], :pointer, blocking: true
+
   # Get the named destination from the list.
   # @overload cupsGetDest(string, string, int, pointer)
   #   @param name [String]
@@ -46,7 +54,7 @@ module FFI::Cups
   #   @param number [Integer] of destinations
   #   @param pointer [Pointer] to destinations
   # {https://www.cups.org/doc/cupspm.html#cupsFreeDests}
-  attach_function 'cupsFreeDests', [ :int, :pointer ], :void, blocking: true
+  attach_function 'cupsFreeDests', [:int, :pointer], :void, blocking: true
 
   # Prints a File
   # @overload cupsPrintFile(string, string, string, int, pointer)

data/lib/ffi-cups/job.rb

@@ -1,13 +1,11 @@
 module Cups
   class Job
-    attr_accessor :id, :title, :printer
-
+    attr_reader :id, :title, :printer
     def initialize(id, title, printer=nil)
       @id = id
       @title = title
       @printer = printer
     end
-
   end
 end
 

data/lib/ffi-cups/printer.rb

@@ -1,12 +1,13 @@
 module Cups
   class Printer
-    attr_reader :name, :options
+    attr_reader :name, :options, :connection
 
     # @param name [String] printer's name
     # @param options [Hash] printer's options
-    def initialize(name, options={})
+    def initialize(name, options={}, connection=nil)
       @name = name
       @options = options
+      @connection = connection
     end
 
     # Returns the printer state
@@ -26,36 +27,80 @@ module Cups
       options['printer-state-reasons'].split(/,/)
     end
 
+    def print_file(filename, title, options={})
+      raise "File not found: #{filename}" unless File.exists? filename
+      
+      http = @connection.nil? ? nil : @connection.httpConnect2
+      # Get all destinations with cupsGetDests2
+      dests = FFI::MemoryPointer.new :pointer
+      num_dests = FFI::Cups.cupsGetDests2(http, dests)
+
+      # Get the destination from name with cupsGetDest
+      p_dest = FFI::Cups.cupsGetDest(@name, nil, num_dests, dests.get_pointer(0))
+      dest = Cups::Struct::Destination.new(p_dest)
+      raise "Destination with name: #{@name} not found!" if dest.null?
+
+      p_options = nil
+      num_options = 0
+      unless options.empty?
+        p_options = FFI::MemoryPointer.new :pointer
+        options.each do |k, v|
+          unless self.class.cupsCheckDestSupported(p_dest, k, v, http)
+            raise "Option:#{k} #{v if v} not supported for printer: #{@name}" 
+          end
+          num_options = FFI::Cups.cupsAddOption(k, v, num_options, p_options)
+        end
+        p_options = p_options.get_pointer(0)
+      end
+
+      job_id = FFI::Cups.cupsPrintFile2(http, @name, filename, title, num_options, p_options)
+      job = Cups::Job.new(job_id, title, self)
+
+      if job_id.zero?
+        last_error = Cups.cupsLastErrorString()
+        self.class.cupsFreeOptions(num_options, p_options) unless options.empty?
+        raise last_error
+      end
+
+      self.class.cupsFreeOptions(num_options, p_options) unless options.empty?
+      self.class.cupsFreeDests(num_dests, dests)
+      Cups::Connection.close(http)
+      return job
+    end
+
     # Get all destinations (printer devices)
     # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
     def self.get_destinations(connection=nil)
       pointer = FFI::MemoryPointer.new :pointer
-      destinations = cupsGetDests2(connection, pointer)
+      dests = cupsGetDests2(pointer, connection)
       printers = []
-      destinations.each do |k, d|
-        destination_opt = cupsOptions(d)
-        options = {}
-
-        destination_opt.each do |k, o|
-          options[o[:name].dup] = o[:value].dup
-        end
-
-        printer = Cups::Printer.new(d[:name].dup, options)
+      dests.each do |d|
+        printer = Cups::Printer.new(d[:name].dup, printer_options(d), connection)
         printers.push(printer)
       end
-      cupsFreeDests(destinations.keys.count, pointer)
+      cupsFreeDests(dests.count, pointer)
       return printers
     end
 
     # Get a destination by name
     # @param name [String] name of the printer
     # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
+    # @return [Printer] a printer object
     def self.get_destination(name, connection=nil)
-      printers = get_destinations(connection)
-      printers.each do |p|
-        return p if p.name == name
-      end
-      raise "Destination with name: #{name} not found!" 
+      http = connection.nil? ? nil : connection.httpConnect2
+      # Get all destinations with cupsGetDests2
+      dests = FFI::MemoryPointer.new :pointer
+      num_dests = FFI::Cups.cupsGetDests2(http, dests)
+
+      # Get the destination from name with cupsGetDest
+      p_dest = FFI::Cups.cupsGetDest(name, nil, num_dests, dests.get_pointer(0))
+      dest = Cups::Struct::Destination.new(p_dest)
+      raise "Destination with name: #{name} not found!" if dest.null?
+
+      printer = Cups::Printer.new(dest[:name].dup, printer_options(dest), connection)
+      cupsFreeDests(num_dests, dests)
+      Cups::Connection.close(http) if http
+      return printer
     end
 
     private
@@ -63,43 +108,69 @@ module Cups
     # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
     # @param pointer [Pointer] pointer to the destinations
     # @return [Hash] hashmap of destination structs
-    def self.cupsGetDests2(connection=nil, pointer)
-      count_destinations = FFI::Cups.cupsGetDests2(connection, pointer)
-      struct_size = Cups::Struct::Destination.size
-      destinations = {}
-      count_destinations.times do |index|
-        destination = Cups::Struct::Destination.new(pointer.get_pointer(0) + (struct_size * index))
-        destinations[index] = destination
+    def self.cupsGetDests2(pointer, connection=nil)
+      http = connection.nil? ? nil : connection.httpConnect2
+      num_dests = FFI::Cups.cupsGetDests2(http, pointer)
+      size = Cups::Struct::Destination.size
+      destinations = []
+      num_dests.times do |i|
+        destination = Cups::Struct::Destination.new(pointer.get_pointer(0) + (size * i))
+        destinations.push(destination)
       end
+      Cups::Connection.close(http) if http
       return destinations
     end
 
+    # Wrapper around {::FFI::Cups#cupsCheckDestSupported}
+    # @param dest [Pointer] pointer to the destination
+    # @param option [String]
+    # @param value [String]
+    # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
+    # @return [Boolean] true if supported, false otherwise
+    def self.cupsCheckDestSupported(dest, option, value, connection=nil)
+      info = FFI::Cups.cupsCopyDestInfo(connection, dest)
+      i = FFI::Cups.cupsCheckDestSupported(connection, dest, info, option, value)
+      return !i.zero?
+    end
+
     # Returns a destination's options
-    # @param destination [Object] {Cups::Struct::Destination} object
-    # @return [Hash] hashmap of destination' options as {Cups::Struct::Option}
-    def self.cupsOptions(destination)
-      struct_size = Cups::Struct::Option.size
-      options = {}
+    # @param dest [Object] {Cups::Struct::Destination} object
+    # @return [Hash] hash of destination' options as {Cups::Struct::Option}
+    def self.cups_options(dest)
+      size = Cups::Struct::Option.size
+      options = []
+
+      dest[:num_options].times do |i|
+        option = Cups::Struct::Option.new(dest[:options] + (size * i))
+        options.push(option)
+      end
+      return options
+    end
 
-      destination[:num_options].times do |index|
-        option = Cups::Struct::Option.new(destination[:options] + (struct_size * index))
-        options[index] = option
+    # Returns a destination's options as hash
+    # @param dest [Object] {Cups::Struct::Destination} object
+    # @return [Hash] hash of destination' options
+    def self.printer_options(dest)
+      dest_opts = cups_options(dest)
+      options = {}
+      dest_opts.each do |o|
+        options[o[:name].dup] = o[:value].dup
       end
       return options
     end
 
     # Wrapper around {::FFI::Cups#cupsFreeDests}
-    # @param number_destinations [Integer]
+    # @param num_dests [Integer]
     # @param pointer [Pointer] pointer to the destinations
-    def self.cupsFreeDests(number_destinations, pointer)
-      FFI::Cups.cupsFreeDests(number_destinations, pointer.get_pointer(0))
+    def self.cupsFreeDests(num_dests, pointer)
+      FFI::Cups.cupsFreeDests(num_dests, pointer.get_pointer(0))
     end
 
     # Wrapper around {::FFI::Cups#cupsFreeOptions}
-    # @param number_options [Integer]
+    # @param num_opts [Integer]
     # @param pointer [Pointer] pointer to the options
-    def self.cupsFreeOptions(number_options, pointer)
-      FFI::Cups.cupsFreeOptions(number_options, pointer.get_pointer(0))
+    def self.cupsFreeOptions(num_opts, pointer)
+      FFI::Cups.cupsFreeOptions(num_opts, pointer)
     end
   end
 end

data/lib/ffi-cups/version.rb

@@ -1,3 +1,3 @@
 module Cups
-  VERSION = "0.1.1"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-cups
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.9
 platform: ruby
 authors:
 - Hugo Marquez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -35,7 +35,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ffi-cups (0.1.0)
-      ffi (~> 1.15.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    diff-lcs (1.4.4)
-    ffi (1.15.0)
-    rake (12.3.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  ffi-cups!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.2