systemd-journal 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f9a1f4583f555e4c8832ce277fc87d02eeabb2f
-  data.tar.gz: a4bc24e388cf2211574a5f138df8d05dc7f97505
+  metadata.gz: df7fe5c76f75b85e1c6ae332b5dc4db8268956c9
+  data.tar.gz: ddb32ec9f34855f7fe8ae5bfef85f5c8606b9295
 SHA512:
-  metadata.gz: 25274b48c5eba590dd4904f10142932fc4c6458170a49f93453c4d7e0cbb9822c6d045e2d9536f0d79244528081d2725fe99ab1aafacb3ebb4ae891a2076e05c
-  data.tar.gz: 2f863c1a90d35b999115eedd3b160b5d36db4cc273f80fdad5a91fca74dcc9f8c1189b9e1cd9c47dbc6e69df3b180d02ab15be8718ec46383539ebc1e22c14ce
+  metadata.gz: 1aa3dd8871ac3b44fe9e063a5fef7ed300f2580a76ebb0a122951dd1136fe86c99322f5342515fafcaf723c337b90ccc59a4a89c47cb02fe007912ba9e493b6f
+  data.tar.gz: 30018c03c4cc3178e2798c9f7edf60d290cdef165ee41bccc5a9256f0fe922b5f9473a6f6fb6d3fe8662f56111eef6878729874b05bc69b06729c4e521a1c6b5

data/.rubocop.yml

@@ -6,3 +6,12 @@ RaiseArgs:
 
 SpaceAroundBlockBraces:
   EnforcedStyle: space_inside_braces
+Lambda:
+  Enabled: false
+
+GlobalVars:
+  AllowedVariables:
+    - $NO_FFI_SPEC
+
+Documentation:
+  Enabled: false

data/README.md

@@ -1,4 +1,4 @@
-# Systemd::Journal [![Gem Version](https://badge.fury.io/rb/systemd-journal.png)](http://badge.fury.io/rb/systemd-journal)  [![Build Status](https://travis-ci.org/ledbettj/systemd-journal.png?branch=master)](https://travis-ci.org/ledbettj/systemd-journal)
+# Systemd::Journal [![Gem Version](https://badge.fury.io/rb/systemd-journal.png)](http://badge.fury.io/rb/systemd-journal)  [![Build Status](https://travis-ci.org/ledbettj/systemd-journal.png?branch=master)](https://travis-ci.org/ledbettj/systemd-journal) [![Code Climate](https://codeclimate.com/github/ledbettj/systemd-journal.png)](https://codeclimate.com/github/ledbettj/systemd-journal)
 
 Ruby bindings for reading from the systemd journal.
 
@@ -9,7 +9,7 @@ Ruby bindings for reading from the systemd journal.
 
 Add this line to your application's Gemfile:
 
-    gem 'systemd-journal', '~> 1.0.0'
+    gem 'systemd-journal', '~> 1.1.0'
 
 And then execute:
 
@@ -62,6 +62,27 @@ Moving around the journal:
     # seek the entry that occured closest to this time
     j.seek(Time.parse("2013-10-31T12:00:00+04:00:00"))
 
+Waiting for things to happen:
+
+    j = Systemd::Journal.new
+    j.seek(:tail)
+    # wait up to one second for something to happen
+    if j.wait(1_000_000)
+      puts 'something changed!'
+    # same as above, but can be interrupted with Control+C.
+    if j.wait(1_000_000, select: true)
+      puts 'something changed!'
+
+Accessing the catalog:
+
+    j = Systemd::Journal.new
+    j.move_next
+    j.move_next while !j.current_entry.catalog?
+
+    puts j.current_entry.catalog
+    # or if you have a message id:
+    puts Systemd::Journal.catalog_for(j.current_entry.message_id)
+
 
 See the documentation for more examples.
 
@@ -78,3 +99,5 @@ If you run into problems or have questions, please open an
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request, targeting the __develop__ branch.
 6. Wipe hands on pants, you're done.
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ledbettj/systemd-journal/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -1,15 +1,15 @@
-require "bundler/gem_tasks"
-require "yard"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
+require 'bundler/gem_tasks'
+require 'yard'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-desc "open a console with systemd/journal required"
+desc 'open a console with systemd/journal required'
 task :console do
   exec 'pry -I./lib -r systemd/journal'
 end
 
 Rubocop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
   task.fail_on_error = false
 end
 

data/lib/systemd/id128.rb

@@ -62,6 +62,15 @@ module Systemd
         def to_s
           ('%02x' * 16) % self[:bytes].to_a
         end
+
+        def self.from_s(str)
+          r = Id128.new
+          [str].pack('H*').bytes.each_with_index do |b, i|
+            r[:bytes][i] = b
+          end
+
+          r
+        end
       end
     end
   end

data/lib/systemd/journal.rb

@@ -1,7 +1,10 @@
 require 'systemd/journal/native'
 require 'systemd/journal/flags'
-require 'systemd/journal/compat'
+require 'systemd/journal/writable'
 require 'systemd/journal/fields'
+require 'systemd/journal/navigable'
+require 'systemd/journal/filterable'
+require 'systemd/journal/waitable'
 require 'systemd/journal_error'
 require 'systemd/journal_entry'
 require 'systemd/id128'
@@ -12,11 +15,14 @@ module Systemd
   # Class to allow interacting with the systemd journal.
   # To read from the journal, instantiate a new {Systemd::Journal}; to write to
   # the journal, use
-  # {Systemd::Journal::Compat::ClassMethods#message Journal.message} or
-  # {Systemd::Journal::Compat::ClassMethods#print Journal.print}.
+  # {Systemd::Journal::Writable::ClassMethods#message Journal.message} or
+  # {Systemd::Journal::Writable::ClassMethods#print Journal.print}.
   class Journal
     include Enumerable
-    include Systemd::Journal::Compat
+    include Systemd::Journal::Writable
+    include Systemd::Journal::Navigable
+    include Systemd::Journal::Filterable
+    include Systemd::Journal::Waitable
 
     # Returns a new instance of a Journal, opened with the provided options.
     # @param [Hash] opts optional initialization parameters.
@@ -60,115 +66,6 @@ module Systemd
       yield current_entry while move_next
     end
 
-    # Move the read pointer by `offset` entries.
-    # @param [Integer] offset how many entries to move the read pointer by. If
-    #   this value is positive, the read pointer moves forward.  Otherwise, it
-    #   moves backwards.
-    # @return [Integer] the number of entries the read pointer actually moved.
-    def move(offset)
-      offset > 0 ? move_next_skip(offset) : move_previous_skip(-offset)
-    end
-
-    # Filter the journal at a high level.
-    # Takes any number of arguments; each argument should be a hash representing
-    # a condition to filter based on.  Fields inside the hash will be ANDed
-    # together.  Each hash will be ORed with the others.  Fields in hashes with
-    # Arrays as values are treated as an OR statement, since otherwise they
-    # would never match.
-    # @example
-    #   j = Systemd::Journal.filter(
-    #     {_systemd_unit: 'session-4.scope'},
-    #     {priority: [4, 6]},
-    #     {_exe: '/usr/bin/sshd', priority: 1}
-    #   )
-    #   # equivalent to
-    #   (_systemd_unit == 'session-4.scope') ||
-    #   (priority == 4 || priority == 6)     ||
-    #   (_exe == '/usr/bin/sshd' && priority == 1)
-    def filter(*conditions)
-      clear_filters
-
-      last_index = conditions.length - 1
-
-      conditions.each_with_index do |condition, index|
-        add_filters(condition)
-        add_disjunction unless index == last_index
-      end
-    end
-
-    # Move the read pointer to the next entry in the journal.
-    # @return [Boolean] True if moving to the next entry was successful.
-    # @return [Boolean] False if unable to move to the next entry, indicating
-    #   that the pointer has reached the end of the journal.
-    def move_next
-      rc = Native.sd_journal_next(@ptr)
-      raise JournalError.new(rc) if rc < 0
-      rc > 0
-    end
-
-    # Move the read pointer forward by `amount` entries.
-    # @return [Integer] the actual number of entries by which the read pointer
-    #   moved. If this number is less than the requested amount, the read
-    #   pointer has reached the end of the journal.
-    def move_next_skip(amount)
-      rc = Native.sd_journal_next_skip(@ptr, amount)
-      raise JournalError.new(rc) if rc < 0
-      rc
-    end
-
-    # Move the read pointer to the previous entry in the journal.
-    # @return [Boolean] True if moving to the previous entry was successful.
-    # @return [Boolean] False if unable to move to the previous entry,
-    #   indicating that the pointer has reached the beginning of the journal.
-    def move_previous
-      rc = Native.sd_journal_previous(@ptr)
-      raise JournalError.new(rc) if rc < 0
-      rc > 0
-    end
-
-    # Move the read pointer backwards by `amount` entries.
-    # @return [Integer] the actual number of entries by which the read pointer
-    #   was moved.  If this number is less than the requested amount, the read
-    #   pointer has reached the beginning of the journal.
-    def move_previous_skip(amount)
-      rc = Native.sd_journal_previous_skip(@ptr, amount)
-      raise JournalError.new(rc) if rc < 0
-      rc
-    end
-
-    # Seek to a position in the journal.
-    # Note: after seeking, you must call {#move_next} or {#move_previous}
-    #   before you can call {#read_field} or {#current_entry}.
-    #
-    # @param [Symbol, Time] whence one of :head, :tail, or a Time instance.
-    #   `:head` (or `:start`) will seek to the beginning of the journal.
-    #   `:tail` (or `:end`) will seek to the end of the journal. When a `Time`
-    #   is provided, seek to the journal entry logged closest to that time. When
-    #   a String is provided, assume it is a cursor from {#cursor} and seek to
-    #   that entry.
-    # @return [True]
-    def seek(whence)
-      rc = case whence
-           when :head, :start
-             Native.sd_journal_seek_head(@ptr)
-           when :tail, :end
-             Native.sd_journal_seek_tail(@ptr)
-           else
-             if whence.is_a?(Time)
-               # TODO: is this right? who knows.
-               Native.sd_journal_seek_realtime_usec(@ptr, whence.to_i * 1_000_000)
-             elsif whence.is_a?(String)
-               Native.sd_journal_seek_cursor(@ptr, whence)
-             else
-               raise ArgumentError.new("Unknown seek type: #{whence.class}")
-             end
-           end
-
-      raise JournalErrornew(rc) if rc < 0
-
-      true
-    end
-
     # Read the contents of the provided field from the current journal entry.
     #   {#move_next} or {#move_previous} must be called at least once after
     #   initialization or seeking prior to attempting to read data.
@@ -215,6 +112,27 @@ module Systemd
       JournalEntry.new(results)
     end
 
+    def current_catalog
+      out_ptr = FFI::MemoryPointer.new(:pointer, 1)
+
+      rc = Native.sd_journal_get_catalog(@ptr, out_ptr)
+      raise JournalError.new(rc) if rc <  0
+
+      Journal.read_and_free_outstr(out_ptr.read_pointer)
+    end
+
+    def self.catalog_for(message_id)
+      out_ptr = FFI::MemoryPointer.new(:pointer, 1)
+
+      rc = Native.sd_journal_get_catalog_for_message_id(
+        Systemd::Id128::Native::Id128.from_s(message_id),
+        out_ptr
+      )
+      raise JournalError.new(rc) if rc < 0
+
+      read_and_free_outstr(out_ptr.read_pointer)
+    end
+
     # Get the list of unique values stored in the journal for the given field.
     # If passed a block, each possible value will be yielded.
     # @return [Array] the list of possible values.
@@ -241,112 +159,6 @@ module Systemd
       results
     end
 
-    # Block until the journal is changed.
-    # @param timeout_usec [Integer] the maximum number of microseconds to wait
-    #   or `-1` to wait indefinitely.
-    # @example Wait for an event for a maximum of 3 seconds
-    #   j = Systemd::Journal.new
-    #   j.seek(:tail)
-    #   if j.wait(3 * 1_000_000)
-    #     # event occurred
-    #   end
-    # @return [Nil] if the wait time was reached (no events occured).
-    # @return [Symbol] :append if new entries were appened to the journal.
-    # @return [Symbol] :invalidate if journal files were added/removed/rotated.
-    def wait(timeout_usec = -1)
-      rc = Native.sd_journal_wait(@ptr, timeout_usec)
-      raise JournalError.new(rc) if rc.is_a?(Fixnum) && rc < 0
-      rc == :nop ? nil : rc
-    end
-
-    # Blocks and waits for new entries to be appended to the journal. When new
-    # entries are written, yields them in turn.  Note that this function does
-    # not automatically seek to the end of the journal prior to waiting.
-    # This method Does not return.
-    # @example Print out events as they happen
-    #   j = Systemd::Journal.new
-    #   j.seek(:tail)
-    #   j.watch do |event|
-    #     puts event.message
-    #   end
-    def watch
-      loop do
-        if wait
-          yield current_entry while move_next
-        end
-      end
-    end
-
-    # Add a filter to journal, such that only entries where the given filter
-    # matches are returned.
-    # {#move_next} or {#move_previous} must be invoked after adding a filter
-    # before attempting to read from the journal.
-    # @param [String] field the column to filter on, e.g. _PID, _EXE.
-    # @param [String] value the match to search for, e.g. '/usr/bin/sshd'
-    # @return [nil]
-    def add_filter(field, value)
-      match = "#{field.to_s.upcase}=#{value}"
-      rc = Native.sd_journal_add_match(@ptr, match, match.length)
-      raise JournalError.new(rc) if rc < 0
-    end
-
-    # Add a set of filters to the journal, such that only entries where the
-    # given filters match are returned.
-    # @param [Hash] filters a set of field/filter value pairs.
-    #   If the filter value is an array, each value in the array is added
-    #   and entries where the specified field matches any of the values is
-    #   returned.
-    # @example Filter by PID and EXE
-    #   j.add_filters(_pid: 6700, _exe: '/usr/bin/sshd')
-    def add_filters(filters)
-      filters.each do |field, value|
-        Array(value).each{ |v| add_filter(field, v) }
-      end
-    end
-
-    # Add an OR condition to the filter.  All previously added matches
-    # will be ORed with the terms following the disjunction.
-    # {#move_next} or {#move_previous} must be invoked after adding a match
-    # before attempting to read from the journal.
-    # @return [nil]
-    # @example Filter entries returned using an OR condition
-    #   j = Systemd::Journal.new
-    #   j.add_filter('PRIORITY', 5)
-    #   j.add_disjunction
-    #   j.add_filter('_EXE', '/usr/bin/sshd')
-    #   while j.move_next
-    #     # current_entry is either an sshd event or
-    #     # has priority 5
-    #   end
-    def add_disjunction
-      rc = Native.sd_journal_add_disjunction(@ptr)
-      raise JournalError.new(rc) if rc < 0
-    end
-
-    # Add an AND condition to the filter.  All previously added terms will be
-    # ANDed together with terms following the conjunction.
-    # {#move_next} or {#move_previous} must be invoked after adding a match
-    # before attempting to read from the journal.
-    # @return [nil]
-    # @example Filter entries returned using an AND condition
-    #   j = Systemd::Journal.new
-    #   j.add_filter('PRIORITY', 5)
-    #   j.add_conjunction
-    #   j.add_filter('_EXE', '/usr/bin/sshd')
-    #   while j.move_next
-    #     # current_entry is an sshd event with priority 5
-    #   end
-    def add_conjunction
-      rc = Native.sd_journal_add_conjunction(@ptr)
-      raise JournalError.new(rc) if rc < 0
-    end
-
-    # Remove all filters and conjunctions/disjunctions.
-    # @return [nil]
-    def clear_filters
-      Native.sd_journal_flush_matches(@ptr)
-    end
-
     # Get the number of bytes the Journal is currently using on disk.
     # If {Systemd::Journal::Flags::LOCAL_ONLY} was passed when opening the
     # journal,  this value will only reflect the size of journal files of the
@@ -380,35 +192,10 @@ module Systemd
       end
     end
 
-    # returns a string representing the current read position.
-    # This string can be passed to {#seek} or {#cursor?}.
-    # @return [String] a cursor token.
-    def cursor
-      out_ptr = FFI::MemoryPointer.new(:pointer, 1)
-      if (rc = Native.sd_journal_get_cursor(@ptr, out_ptr)) < 0
-        raise JournalError.new(rc)
-      end
-
-      read_and_free_outstr(out_ptr.read_pointer)
-    end
-
-    # Check if the read position is currently at the entry represented by the
-    # provided cursor value.
-    # @param c [String] a cursor token returned from {#cursor}.
-    # @return [Boolean] True if the current entry is the one represented by the
-    # provided cursor, False otherwise.
-    def cursor?(c)
-      if (rc = Native.sd_journal_test_cursor(@ptr, c)) < 0
-        raise JournalError.new(rc)
-      end
-
-      rc > 0
-    end
-
     private
 
     def self.finalize(ptr)
-      proc{ Native.sd_journal_close(ptr) unless ptr.nil? }
+      proc { Native.sd_journal_close(ptr) unless ptr.nil? }
     end
 
     def enumerate_helper(enum_function)
@@ -430,7 +217,7 @@ module Systemd
     # some sd_journal_* functions return strings that we're expected to free
     # ourselves. This function copies the string from a char* to a ruby string,
     # frees the char*, and returns the ruby string.
-    def read_and_free_outstr(ptr)
+    def self.read_and_free_outstr(ptr)
       str = ptr.read_string
       LibC.free(ptr)
       str

data/lib/systemd/journal/filterable.rb

@@ -0,0 +1,102 @@
+module Systemd
+  class Journal
+    module Filterable
+      # Filter the journal at a high level.
+      # Takes any number of arguments; each argument should be a hash
+      # representing a condition to filter based on.  Fields inside the hash
+      # will be ANDed together.  Each hash will be ORed with the others.
+      # Fields in hashes with Arrays as values are treated as an OR statement,
+      # since otherwise they would never match.
+      # @example
+      #   j = Systemd::Journal.filter(
+      #     {_systemd_unit: 'session-4.scope'},
+      #     {priority: [4, 6]},
+      #     {_exe: '/usr/bin/sshd', priority: 1}
+      #   )
+      #   # equivalent to
+      #   (_systemd_unit == 'session-4.scope') ||
+      #   (priority == 4 || priority == 6)     ||
+      #   (_exe == '/usr/bin/sshd' && priority == 1)
+      def filter(*conditions)
+        clear_filters
+
+        last_index = conditions.length - 1
+
+        conditions.each_with_index do |condition, index|
+          add_filters(condition)
+          add_disjunction unless index == last_index
+        end
+      end
+
+      # Add a filter to journal, such that only entries where the given filter
+      # matches are returned.
+      # {#move_next} or {#move_previous} must be invoked after adding a filter
+      # before attempting to read from the journal.
+      # @param [String] field the column to filter on, e.g. _PID, _EXE.
+      # @param [String] value the match to search for, e.g. '/usr/bin/sshd'
+      # @return [nil]
+      def add_filter(field, value)
+        match = "#{field.to_s.upcase}=#{value}"
+        rc = Native.sd_journal_add_match(@ptr, match, match.length)
+        raise JournalError.new(rc) if rc < 0
+      end
+
+      # Add a set of filters to the journal, such that only entries where the
+      # given filters match are returned.
+      # @param [Hash] filters a set of field/filter value pairs.
+      #   If the filter value is an array, each value in the array is added
+      #   and entries where the specified field matches any of the values is
+      #   returned.
+      # @example Filter by PID and EXE
+      #   j.add_filters(_pid: 6700, _exe: '/usr/bin/sshd')
+      def add_filters(filters)
+        filters.each do |field, value|
+          Array(value).each { |v| add_filter(field, v) }
+        end
+      end
+
+      # Add an OR condition to the filter.  All previously added matches
+      # will be ORed with the terms following the disjunction.
+      # {#move_next} or {#move_previous} must be invoked after adding a match
+      # before attempting to read from the journal.
+      # @return [nil]
+      # @example Filter entries returned using an OR condition
+      #   j = Systemd::Journal.new
+      #   j.add_filter('PRIORITY', 5)
+      #   j.add_disjunction
+      #   j.add_filter('_EXE', '/usr/bin/sshd')
+      #   while j.move_next
+      #     # current_entry is either an sshd event or
+      #     # has priority 5
+      #   end
+      def add_disjunction
+        rc = Native.sd_journal_add_disjunction(@ptr)
+        raise JournalError.new(rc) if rc < 0
+      end
+
+      # Add an AND condition to the filter.  All previously added terms will be
+      # ANDed together with terms following the conjunction.
+      # {#move_next} or {#move_previous} must be invoked after adding a match
+      # before attempting to read from the journal.
+      # @return [nil]
+      # @example Filter entries returned using an AND condition
+      #   j = Systemd::Journal.new
+      #   j.add_filter('PRIORITY', 5)
+      #   j.add_conjunction
+      #   j.add_filter('_EXE', '/usr/bin/sshd')
+      #   while j.move_next
+      #     # current_entry is an sshd event with priority 5
+      #   end
+      def add_conjunction
+        rc = Native.sd_journal_add_conjunction(@ptr)
+        raise JournalError.new(rc) if rc < 0
+      end
+
+      # Remove all filters and conjunctions/disjunctions.
+      # @return [nil]
+      def clear_filters
+        Native.sd_journal_flush_matches(@ptr)
+      end
+    end
+  end
+end