lux-hammer 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a61994d8f82b575a019cfb1171935b334b840cdb5561fcc56e9ba2c141a314d2
-  data.tar.gz: a4d4d730c830b4d30de13dc9e0c27e9cc2fa3902c9297154d4fe81ba5365fe94
+  metadata.gz: 1e64c1f3c63eddb83350353d2a5f5977e5afe544a68d9ed43eea129debc017e7
+  data.tar.gz: 8e5cfe7fa2ff99d970f172b77e5d23fb7ea27722f5103cfd2edf2c4aba4d5579
 SHA512:
-  metadata.gz: 0e4c0a5f1fbf47550df2929670e647cf7e1e390e7b3aab0b71932dc5f9557295953c39cdf9fafc6ac719d53b94ed14058bd1a2bb32bcaf9bb79ff3b2198fee16
-  data.tar.gz: b0012fd33259c5ea63af2d3ea0040c4a618292042f842dbda523f462d90fbc9138c04217c3c86a7d52fd56a6b650249ab2dd9bb6f070e1f1a24497ab68e6dbe2
+  metadata.gz: 452eee357de3639419009dae5b0160ab337e0dbea42aee6c44e084284e5e5557d2c2df8c803ed2bd8564e4808f49e1422c1bb9d5ea9a6bbbab57f1f217f2084a
+  data.tar.gz: 6572ee28bdb6e8f26328a315d29bdde5bb0a63190b13fa7255008b3d44db23c3337616fb485b78e3eeab73822d30e1c1263457ee473c00a94dae073e65ded3c6

data/.version

@@ -1 +1 @@
-0.3.15
+0.3.16

data/AGENTS.md

@@ -313,7 +313,7 @@ Task contracts:
   `hammer/cron_web.rb` - no webrick, keep it dependency-free): jobs
   table, per-job log tail, POST run-now, `/json` status. Flags:
   `--port`, `--pass` (HTTP basic auth on every route, any username,
-  constant-time compare; falls back to `HAMMER_CRON_PASS` env),
+  constant-time compare; falls back to `CRON_HTTP_PASS` env),
   `--list` (print jobs + next runs, exit), `--service` (print launchd
   plist / systemd unit, carries `--pass` when set, install hints on
   stderr).

data/README.md

@@ -683,11 +683,11 @@ On a shared machine, protect the UI with HTTP basic auth - useful since
 "run now" executes tasks:
 
 ```sh
-hammer h:cron --pass=secret        # or: HAMMER_CRON_PASS=secret hammer h:cron
+hammer h:cron --pass=secret        # or: CRON_HTTP_PASS=secret hammer h:cron
 curl -u :secret http://127.0.0.1:4267/json   # any username, password checked
 ```
 
-Prefer the `HAMMER_CRON_PASS` env var when other users can read your
+Prefer the `CRON_HTTP_PASS` env var when other users can read your
 process list (`ps` shows flag values). A `--service` unit generated
 while `--pass` is set carries the flag along, so keep that file private.
 Note this is plain HTTP - credentials are encoded, not encrypted; for

data/lib/hammer/builtins.rb

@@ -135,7 +135,7 @@ class Hammer
           example 'h:cron --list'
           example 'h:cron --service > ~/.config/systemd/user/hammer-cron.service'
           opt :port,    type: :integer, default: 4267, desc: 'web UI port (binds 127.0.0.1 only)'
-          opt :pass,    type: :string,  desc: 'HTTP basic-auth password for the web UI (or HAMMER_CRON_PASS env)'
+          opt :pass,    type: :string,  desc: 'HTTP basic-auth password for the web UI (or CRON_HTTP_PASS env)'
           opt :list,    type: :boolean, desc: 'print scheduled jobs + next runs, then exit'
           opt :service, type: :boolean, desc: 'print a launchd plist (macOS) / systemd unit (linux)'
           proc do |opts|
@@ -144,7 +144,7 @@ class Hammer
             end
             require_relative 'cron_server'
             server = Hammer::CronServer.new(self.class.root, port: opts[:port],
-                                            pass: opts[:pass] || ENV['HAMMER_CRON_PASS'])
+                                            pass: opts[:pass] || ENV['CRON_HTTP_PASS'])
             if opts[:service]
               server.print_service_unit
             elsif opts[:list]

data/lib/hammer/cron_server.rb

@@ -265,41 +265,11 @@ class Hammer
     def print_service_unit
       if RUBY_PLATFORM.include?('darwin')
         label = "com.lux-hammer.cron.#{File.basename(@root_dir)}"
-        puts <<~XML
-          <?xml version="1.0" encoding="UTF-8"?>
-          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-          <plist version="1.0">
-          <dict>
-            <key>Label</key><string>#{label}</string>
-            <key>ProgramArguments</key>
-            <array>
-              <string>#{@hammer_bin}</string>
-              <string>h:cron</string>
-              <string>--port=#{@port}</string>#{@pass ? "\n    <string>--pass=#{@pass}</string>" : ''}
-            </array>
-            <key>WorkingDirectory</key><string>#{@root_dir}</string>
-            <key>RunAtLoad</key><true/>
-            <key>KeepAlive</key><true/>
-            <key>StandardOutPath</key><string>#{@root_dir}/log/hammer/cron-server.log</string>
-            <key>StandardErrorPath</key><string>#{@root_dir}/log/hammer/cron-server.log</string>
-          </dict>
-          </plist>
-        XML
+        puts launchd_service_unit(label)
         warn Shell.paint("# save to ~/Library/LaunchAgents/#{label}.plist, then:", :gray)
         warn Shell.paint("#   launchctl load ~/Library/LaunchAgents/#{label}.plist", :gray)
       else
-        puts <<~UNIT
-          [Unit]
-          Description=hammer h:cron job server (#{File.basename(@root_dir)})
-
-          [Service]
-          ExecStart=#{@hammer_bin} h:cron --port=#{@port}#{" --pass=#{@pass}" if @pass}
-          WorkingDirectory=#{@root_dir}
-          Restart=on-failure
-
-          [Install]
-          WantedBy=default.target
-        UNIT
+        puts systemd_service_unit
         warn Shell.paint('# save to ~/.config/systemd/user/hammer-cron.service, then:', :gray)
         warn Shell.paint('#   systemctl --user enable --now hammer-cron', :gray)
       end
@@ -326,6 +296,71 @@ class Hammer
 
     private
 
+    def launchd_service_unit(label = "com.lux-hammer.cron.#{File.basename(@root_dir)}")
+      args = [@hammer_bin, 'h:cron', "--port=#{@port}"]
+      args << "--pass=#{@pass}" if @pass
+      arguments = args.map { |arg| "    <string>#{xml_escape(arg)}</string>" }.join("\n")
+      log_path = File.join(@root_dir, 'log/hammer/cron-server.log')
+
+      <<~XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>Label</key><string>#{xml_escape(label)}</string>
+          <key>ProgramArguments</key>
+          <array>
+        #{arguments}
+          </array>
+          <key>WorkingDirectory</key><string>#{xml_escape(@root_dir)}</string>
+          <key>RunAtLoad</key><true/>
+          <key>KeepAlive</key><true/>
+          <key>StandardOutPath</key><string>#{xml_escape(log_path)}</string>
+          <key>StandardErrorPath</key><string>#{xml_escape(log_path)}</string>
+        </dict>
+        </plist>
+      XML
+    end
+
+    def systemd_service_unit
+      args = [@hammer_bin, 'h:cron', "--port=#{@port}"]
+      args << "--pass=#{@pass}" if @pass
+
+      <<~UNIT
+        [Unit]
+        Description=#{systemd_quote("hammer h:cron job server (#{File.basename(@root_dir)})")}
+
+        [Service]
+        ExecStart=#{args.map { |arg| systemd_quote(arg) }.join(' ')}
+        WorkingDirectory=#{systemd_quote(@root_dir)}
+        Restart=on-failure
+
+        [Install]
+        WantedBy=default.target
+      UNIT
+    end
+
+    def xml_escape(value)
+      value.to_s.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
+           .gsub('"', '&quot;').gsub("'", '&apos;')
+    end
+
+    def systemd_quote(value)
+      escaped = value.to_s.gsub(/[\x00-\x1f\x7f%$\\"]/) do |char|
+        case char
+        when '%'  then '%%'
+        when '$'  then '$$'
+        when '\\' then '\\\\'
+        when '"'  then '\\"'
+        when "\n" then '\\n'
+        when "\r" then '\\r'
+        when "\t" then '\\t'
+        else format('\\x%02x', char.ord)
+        end
+      end
+      %Q{"#{escaped}"}
+    end
+
     # Refuse to start when the state file points at another live h:cron -
     # two schedulers would double-fire every job. Best-effort (no lock
     # file): kill(0) tells us whether that pid is still alive.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lux-hammer
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Dino Reic