journald-native 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40cc80f310e9a40ca958130fae646a2498d50876
-  data.tar.gz: 742cc24381ddf5eaddba2baf430ef332f6030a2e
+  metadata.gz: 4020a007bf01dcb53dde8935a7772ab71e28c882
+  data.tar.gz: b95b33ae4d6014cf76c0b1b6e138829274f3d433
 SHA512:
-  metadata.gz: 6a0254aae671f1b71835ccb8ae0a22fed7827ad195643f1192dc930587b2c906723ecc2254d9c7fb59229a39ba8566b5039dbe1c04a6349e34170ec602109936
-  data.tar.gz: 3eaf04c61e3a201c86a430c03abed4da16ec7daccfc9c6d90e9b0c22ce1fbee34ba3c2d3d4758f4f23762eeaa93b6fb0d21b4e655f8fe7b11f289569c36b8b81
+  metadata.gz: 6ab72f2d53e00b60be3489609ee7065e293bef46c13145c14cfae7eae4adddbb465e1a4a785ba05930a50f1b97fa5de809a20f0b2d628a9073d7655c82dd3f74
+  data.tar.gz: 3983b62b9f1dc7367013048cab266f2adc71b5c0ed14ae9ad77bafe214866d6310c5d7b70f672d10636319815d7d815b4cab5a1078cbf672909d69c8659ebbef

data/.gitignore

@@ -26,3 +26,4 @@ Makefile
 *.iws
 .rakeTasks
 .idea
+extconf.h

data/README.md

@@ -1,6 +1,7 @@
 # journald-native
 
 [![Gem Version](https://badge.fury.io/rb/journald-native.svg)](http://badge.fury.io/rb/journald-native)
+[![Reference Status](https://www.versioneye.com/ruby/journald-native/reference_badge.svg)](https://www.versioneye.com/ruby/journald-native/references)
 
 A systemd-journal native logging lib wrapper.
 [See sd-journal help for more info](http://www.freedesktop.org/software/systemd/man/sd_journal_print.html)
@@ -29,13 +30,13 @@ Journald::LOG_DEBUG     # debug-level messages
 ```
 
 systemd-journal uses syslog constants to denote level therefore they are equal to those of the Syslog module,
-e.g. ```Journald::LOG_WARNING == Syslog::LOG_WARNING```. 
+e.g. ```Journald::LOG_WARNING == Syslog::LOG_WARNING```.
 [See syslog man page for more info](http://man7.org/linux/man-pages/man3/syslog.3.html)
 
 ### Methods
 
-Methods of Journald::Native class wrap systemd-journal calls. 
-[See sd-journal help for more info](http://www.freedesktop.org/software/systemd/man/sd_journal_print.html) 
+Methods of Journald::Native class wrap systemd-journal calls.
+[See sd-journal help for more info](http://www.freedesktop.org/software/systemd/man/sd_journal_print.html)
 
 ```ruby
 Journald::Native.send "MESSAGE=message", "PRIORITY=#{Journald::LOG_WARNING}"
@@ -43,9 +44,9 @@ Journald::Native.print Journald::LOG_WARNING, "message"
 Journald::Native.perror "message"
 ```
 
-It is not recommended to use ```print``` and ```perror``` as you may lose ```'\0'``` byte in your string due to
-C zero-terminated string format (all zero bytes in the middle will be removed) On the contrary ```send``` uses
-binary buffers and does not have this shortcoming.
+It is not recommended to use ```print``` and ```perror``` as you may get exception if your string contains
+```'\0'``` byte due to C zero-terminated string format. On the contrary ```send``` uses binary buffers and
+does not have this shortcoming.
 
 ### License
 

data/ext/journald_native/extconf.rb

@@ -4,17 +4,33 @@ LIBDIR      = RbConfig::CONFIG['libdir']
 INCLUDEDIR  = RbConfig::CONFIG['includedir']
 
 HEADER_DIRS = [INCLUDEDIR]
-
-LIB_DIRS = [LIBDIR]
+LIB_DIRS    = [LIBDIR]
 
 dir_config('systemd', HEADER_DIRS, LIB_DIRS)
 
+$CFLAGS = '-std=c99'
+
+def have_funcs
+  have_funcs = true
+
+  # check functions. redefine const list in sd_journal.h if changed
+  %w(sd_journal_print sd_journal_sendv sd_journal_perror).each do |func|
+    have_funcs &&= have_func(func)
+  end
+
+  have_funcs
+end
+
 # check headers
-abort 'systemd/sd-journal.h is missing. please install systemd-journal' unless find_header('systemd/sd-journal.h')
+have_header('systemd/sd-journal.h')
+
+# first try to find funcs in systemd
+have_library('systemd')
 
-# check functions
-%w(sd_journal_print sd_journal_sendv sd_journal_perror).each do |func|
-   abort "#{func}() is missing. systemd-journal is not usable" unless find_library('systemd-journal', func)
+unless have_funcs
+  have_library('systemd-journal') # try to fall back to systemd-journal if older systemd
+  have_funcs
 end
 
+create_header
 create_makefile('journald_native')

data/ext/journald_native/journald_native.c

@@ -2,7 +2,7 @@
 #define SD_JOURNAL_SUPPRESS_LOCATION
 
 #include <ruby.h>
-#include <systemd/sd-journal.h>
+#include "sd_journal.h"
 
 void Init_journald_native();
 
@@ -15,9 +15,7 @@ static void jdl_init_methods();
 static VALUE jdl_native_print(VALUE self, VALUE priority, VALUE message);
 static VALUE jdl_native_send(int argc, VALUE* argv, VALUE self);
 static VALUE jdl_native_perror(VALUE self, VALUE message);
-
-/* aux */
-static char * jdl_alloc_safe_string(VALUE string);
+static VALUE jdl_native_is_dummy();
 
 /* globals */
 static VALUE mJournald;
@@ -46,6 +44,9 @@ static void jdl_init_constants()
     rb_define_const(mJournald, "LOG_NOTICE",  INT2NUM(LOG_NOTICE));   /* normal but significant condition */
     rb_define_const(mJournald, "LOG_INFO",    INT2NUM(LOG_INFO));     /* informational */
     rb_define_const(mJournald, "LOG_DEBUG",   INT2NUM(LOG_DEBUG));    /* debug-level messages */
+
+    // dummy detection const
+    rb_define_const(mNative,   "IS_DUMMY",    jdl_native_is_dummy());
 }
 
 static void jdl_init_methods()
@@ -53,6 +54,9 @@ static void jdl_init_methods()
     rb_define_singleton_method(mNative, "print",  jdl_native_print,  2);
     rb_define_singleton_method(mNative, "send",   jdl_native_send,  -1); /* -1 to pass as C array */
     rb_define_singleton_method(mNative, "perror", jdl_native_perror, 1);
+
+    // dummy detection method
+    rb_define_singleton_method(mNative, "dummy?", jdl_native_is_dummy, 0);
 }
 
 static VALUE jdl_native_print(VALUE v_self, VALUE v_priority, VALUE v_message)
@@ -61,19 +65,17 @@ static VALUE jdl_native_print(VALUE v_self, VALUE v_priority, VALUE v_message)
     char *message;
 
     priority = NUM2INT(v_priority);
-    message  = jdl_alloc_safe_string(v_message);
+    message  = StringValueCStr(v_message);
 
     result = sd_journal_print(priority, "%s", message);
 
-    free(message);
-
     return INT2NUM(result);
 }
 
 static VALUE jdl_native_send(int argc, VALUE* argv, VALUE self)
 {
     struct iovec *msgs;
-    size_t i;
+    int i;
     int result;
 
     /* first check everything is a string / convertable to string */
@@ -102,42 +104,14 @@ static VALUE jdl_native_perror(VALUE v_self, VALUE v_message)
     int result;
     char *message;
 
-    message = jdl_alloc_safe_string(v_message);
+    message = StringValueCStr(v_message);
 
     result = sd_journal_perror(message);
 
-    free(message);
-
     return INT2NUM(result);
 }
 
-/**
- * Remove zeros from string and ensure it's zero-terminated
- */
-static char * jdl_alloc_safe_string(VALUE v_string)
+static VALUE jdl_native_is_dummy()
 {
-    char  *str;
-    size_t len;
-
-    char  *newstr,
-          *ptr;
-    size_t i;
-
-    /* convert to string */
-    StringValue(v_string);
-
-    str = RSTRING_PTR(v_string);
-    len = RSTRING_LEN(v_string);
-
-    newstr = calloc(len + 1, sizeof(char));
-
-    for (i = 0, ptr = newstr; i < len; i++) {
-        if (str[i]) {
-            *(ptr++) = str[i];
-        }
-    }
-
-    *ptr = '\0';
-
-    return newstr;
+    return JOURNALD_NATIVE_SD_JOURNAL_DUMMY ? Qtrue : Qfalse;
 }

data/ext/journald_native/sd_journal.h

@@ -0,0 +1,55 @@
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifndef JOURNALD_NATIVE_SD_JOURNAL_H
+    #define JOURNALD_NATIVE_SD_JOURNAL_H
+
+    #ifdef __linux__
+
+        #define JOURNALD_NATIVE_SD_JOURNAL_DUMMY false
+
+        /* do the real stuff */
+
+        #include "extconf.h"
+
+        /* check for extconf results */
+
+        #ifndef HAVE_SYSTEMD_SD_JOURNAL_H
+            #error Cannot include <systemd/sd-journal.h>. Please use linux version with systemd-journal installed
+        #endif
+
+        #ifndef HAVE_SD_JOURNAL_PRINT
+            #error Required function sd_journal_print is missing
+        #endif
+
+        #ifndef HAVE_SD_JOURNAL_SENDV
+            #error Required function sd_journal_sendv is missing
+        #endif
+
+        #ifndef HAVE_SD_JOURNAL_PERROR
+            #error Required function sd_journal_perror is missing
+        #endif
+
+        /* Do not add C line and file to the log messages */
+        #define SD_JOURNAL_SUPPRESS_LOCATION
+        /* include systemd-journal headers */
+        #include <systemd/sd-journal.h>
+
+    #else
+
+        #define JOURNALD_NATIVE_SD_JOURNAL_DUMMY true
+
+        #warning Compiling dummy version of the gem for non-Linux OS
+
+        #include "sd_journal_dummy.h"
+
+    #endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // JOURNALD_NATIVE_SD_JOURNAL_H

data/ext/journald_native/sd_journal_dummy.h

@@ -0,0 +1,23 @@
+/* dummy code to be used in sd_journal.h on non-linux system */
+
+#include <stdlib.h>
+
+/* syslog constants */
+#define LOG_EMERG   0
+#define LOG_ALERT   1
+#define LOG_CRIT    2
+#define LOG_ERR     3
+#define LOG_WARNING 4
+#define LOG_NOTICE  5
+#define LOG_INFO    6
+#define LOG_DEBUG   7
+
+/* iovec */
+struct iovec {
+    void  *iov_base;    /* Starting address */
+    size_t iov_len;     /* Number of bytes to transfer */
+};
+
+inline int sd_journal_print(int priority, const char *format, ...)  { return 0; }
+inline int sd_journal_sendv(const struct iovec *iov, int n)         { return 0; }
+inline int sd_journal_perror(const char *message)                   { return 0; }

data/lib/journald/native/version.rb

@@ -1,5 +1,5 @@
 module Journald
   module Native
-    VERSION = '1.0.2'
+    VERSION = '1.0.7'
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: journald-native
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Anton Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -60,13 +60,15 @@ extensions:
 - ext/journald_native/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ext/journald_native/extconf.rb
 - ext/journald_native/journald_native.c
+- ext/journald_native/sd_journal.h
+- ext/journald_native/sd_journal_dummy.h
 - journald-native.gemspec
 - lib/journald/native.rb
 - lib/journald/native/version.rb
@@ -80,19 +82,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: systemd-journal logging native lib wrapper
 test_files: []
-has_rdoc: