aethernal-agent 0.1.10

data/lib/aethernal_agent/plugins/radarr/templates/config.xml.erb

@@ -0,0 +1,16 @@
+<Config>
+  <Port><%= @port %></Port>
+  <UrlBase>/radarr</UrlBase>
+  <BindAddress>*</BindAddress>
+  <SslPort><%= @ssl_port %></SslPort>
+  <EnableSsl>False</EnableSsl>
+  <ApiKey><%= @api_key %></ApiKey>
+  <AuthenticationMethod>Forms</AuthenticationMethod>
+  <LogLevel>Info</LogLevel>
+  <LaunchBrowser>False</LaunchBrowser>
+  <Branch>develop</Branch>
+  <SslCertHash>
+  </SslCertHash>
+  <UpdateMechanism>BuiltIn</UpdateMechanism>
+  <UpdateAutomatically>True</UpdateAutomatically>
+</Config>

data/lib/aethernal_agent/plugins/radarr/templates/radarr.apache.conf.erb

@@ -0,0 +1,6 @@
+Redirect "/radarr" "/radarr/app"
+<Location /radarr/>
+  ProxyPass http://localhost:<%= @port %>
+  ProxyPassReverse http://localhost:<%= @port %>
+  Require all granted
+</Location>

data/lib/aethernal_agent/plugins/sonarr/files/sonarr.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=Sonarr Daemon
+After=syslog.target network.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/mono --debug %h/apps/sonarr/Sonarr.exe -nobrowser
+TimeoutStopSec=20
+KillMode=process
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

data/lib/aethernal_agent/plugins/sonarr/manifest.yml

@@ -0,0 +1,66 @@
+name: Sonarr
+script_name: sonarr.rb
+version: 0.1
+required_aethernal_agent_version: "~> 0.1.0"
+description: Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
+installation_type: local_install
+configuration_type: multi_user
+apache_configuration: sonarr.apache.conf.erb
+icon:
+  name: sonarr.jpeg
+  sha256sum: 325f7b0e6fff416105d8a23848bfe3e424d19505db6b2baf0d6740acb92d56d5
+plain_name: sonarr
+services:
+  - sonarr
+actions:
+  restart:
+    user:
+      required: true
+      linux_user: true
+  uninstall:
+    nothing: true
+  install_packages:
+    user:
+      required: true
+      linux_user: true
+  remove_app_user:
+    user:
+      required: true
+      linux_user: true
+  configure_app_user:
+    port:
+      auto_generate_port: true
+      min: 6900
+      max: 6999
+    ssl_port:
+      auto_generate_port: true
+      min: 7900
+      max: 7999
+    user:
+      required: true
+      linux_user: true
+    password:
+      required: false
+      auto_generate: true
+    return_values:
+      - password
+      - port
+    display_values:
+      - user
+      - password
+estimated_size_mb: 23
+package:
+  folder_name: Sonarr
+  direct_download:
+    url: http://download.sonarr.tv/v3/phantom-develop/3.0.3.731/Sonarr.phantom-develop.3.0.3.731.linux.tar.gz
+    target_name: Sonarr.phantom-develop.3.0.3.731.linux.tar.gz
+    auto_extract: true
+    always_latest: false
+  apt:
+    "18.04":
+      add_sources:
+        mono_stable:
+          source_url: "deb https://download.mono-project.com/repo/ubuntu stable-bionic main"
+          key_id: "3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF"
+      packages:
+        - mono-devel

data/lib/aethernal_agent/plugins/sonarr/sonarr.rb

@@ -0,0 +1,70 @@
+class AethernalAgent::Sonarr < AethernalAgent::App
+  def initialize(options = {})
+    super(options)
+  end
+
+  def install_packages(options = {})
+    remove_app_user
+
+    super(options)
+    file(app_path, chmod: 711, owner: self.user)
+    FileUtils.mv(app_path + "/Sonarr", app_path + "/sonarr")
+    FileUtils.mv(app_path + "/sonarr", home_folder_path(File.join("apps")))
+    directory(app_path, action: :delete)
+  end
+
+  def remove_app_user(options = {})
+    super(options) do |opts|
+      directory(home_folder_path("/apps/sonarr"), action: :delete)
+      directory(home_folder_path("/apps/Sonarr"), action: :delete)
+      directory(home_folder_path("/.config/Sonarr"), action: :delete)
+    end
+  end
+
+  def configure_app_user(options = {})
+    self.install_packages(options)
+    super(options) do |opts|
+      @vars = {
+        api_key: Digest::SHA256.hexdigest(Time.now.to_i.to_s + "aethernal")[0..32],
+        port: opts['port'],
+        ssl_port: opts['ssl_port'],
+        password: opts['password'],
+        user: self.user}
+
+      write_template(template_path('config.xml.erb'),
+                     sonarr_config_path('config.xml'),
+                     @vars,
+                     {owner: @vars[:user]})
+    end
+    # If we run this within the super we have no systemd scripts yet so we need to do this after everything has been setup except the user.
+    add_user_to_db
+    return create_return_args(@vars)
+  end
+
+  protected
+
+  def sonarr_config_path(path ="/")
+    File.join(home_folder_path(".config/Sonarr"), path)
+  end
+
+  def add_user_to_db
+    # We need to start it for the database and migrations to be created
+    start
+    # Let's sleep a bit so we have some guarantee that the database has been migrated properly
+    sleep 120
+    # Let's stop it so we can mess with the database, not sure this is needed
+    stop
+    begin
+      db = SQLite3::Database.open(home_folder_path(".config/Sonarr/sonarr.db"))
+      # Add default user
+      db.execute "INSERT INTO Users VALUES (1, 'e852a6bb-6812-4e6c-8f99-f8c3c5201594', '#{self.user}', '#{Digest::SHA256.hexdigest(@vars[:password])}');"
+    rescue SQLite3::Exception => e
+      raise "Error setting up Sonarr: #{e}"
+    ensure
+      db.close if db
+    end
+
+    start
+  end
+
+end

data/lib/aethernal_agent/plugins/sonarr/templates/config.xml.erb

@@ -0,0 +1,16 @@
+<Config>
+  <Port><%= @port %></Port>
+  <UrlBase>/sonarr</UrlBase>
+  <BindAddress>*</BindAddress>
+  <SslPort><%= @ssl_port %></SslPort>
+  <EnableSsl>False</EnableSsl>
+  <ApiKey><%= @api_key %></ApiKey>
+  <AuthenticationMethod>Forms</AuthenticationMethod>
+  <LogLevel>Info</LogLevel>
+  <LaunchBrowser>False</LaunchBrowser>
+  <Branch>develop</Branch>
+  <SslCertHash>
+  </SslCertHash>
+  <UpdateMechanism>BuiltIn</UpdateMechanism>
+  <UpdateAutomatically>True</UpdateAutomatically>
+</Config>

data/lib/aethernal_agent/plugins/sonarr/templates/sonarr.apache.conf.erb

@@ -0,0 +1,6 @@
+Redirect "/sonarr" "/sonarr/app"
+<Location /sonarr/>
+  ProxyPass http://localhost:<%= @port %>
+  ProxyPassReverse http://localhost:<%= @port %>
+  Require all granted
+</Location>

data/lib/aethernal_agent/plugins/vnc/files/xstartup

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+xrdb $HOME/.Xresources
+xsetroot -solid grey
+#x-terminal-emulator -geometry 80x24+10+10 -ls -title "$VNCDESKTOP BOSS Desktop" &
+#x-window-manager &
+# Fix to make GNOME work
+export XKL_XMODMAP_DISABLE=1
+/etc/X11/Xsession

data/lib/aethernal_agent/plugins/vnc/manifest.yml

@@ -0,0 +1,41 @@
+name: Remote Desktop (VNC)
+script_name: vnc.rb
+version: 0.1
+required_aethernal_agent_version: "~> 0.1.0"
+description: Manage your server with a remote desktop instance running xfce.
+installation_type: global_install
+configuration_type: multi_user
+plain_name: vnc
+built_in_updater: false
+icon:
+  name: vnc.png
+  sha256sum: b49177a4d0b5a132267f9963e213a164633e946a56339425952169e0bcc4e779
+services:
+  - vnc
+actions:
+  restart:
+    user:
+      required: true
+      linux_user: true
+  configure_app_user:
+    port:
+      auto_generate_port: true
+      min: 5900
+      max: 5999
+    user:
+      required: true
+      linux_user: true
+    password:
+      required: false
+      auto_generate: true
+    display_values:
+      - port
+      - password
+estimated_size_mb: 600
+package:
+  apt:
+    "18.04":
+      packages:
+        - xfce4
+        - tightvncserver
+        - lxterminal

data/lib/aethernal_agent/plugins/vnc/templates/vnc.service.erb

@@ -0,0 +1,14 @@
+[Unit]
+Description=Remote desktop service (VNC)
+After=network-online.target
+
+[Service]
+Type=simple
+PIDFile=%h/.vnc/%H:<%= @offset %>.pid
+ExecStartPre=/bin/sh -c '/usr/bin/vncserver -kill :<%= @offset %> > /dev/null 2>&1 || :'
+ExecStart=/usr/bin/vncserver :<%= @offset %> -geometry 1440x900
+ExecStop=/usr/bin/vncserver -kill :<%= @offset %>
+Restart=on-failure
+
+[Install]
+WantedBy=default.target

data/lib/aethernal_agent/plugins/vnc/vnc.rb

@@ -0,0 +1,41 @@
+class AethernalAgent::Vnc < AethernalAgent::App
+  def initialize(options = {})
+    super(options)
+  end
+
+  def install_packages(options = {})
+    super(options)
+
+    apt_package(packages: "pulseaudio xscreensaver gvfs-common", action: :remove)
+  end
+
+  def uninstall_packages(options = {})
+    super(options)
+  end
+
+  def remove_app_user(options = {})
+    super do
+      directory(home_folder_path(".vnc"), action: :delete)
+    end
+  end
+
+  def configure_app_user(options = {})
+   self.install_packages(options)
+
+   super(options) do |opts|
+      directory( home_folder_path(".vnc"), owner: self.user)
+
+      # Make xstartup executable so vnc can use it
+      aethernal_agent_file("xstartup", home_folder_path(".vnc/xstartup"), chmod: 0711, owner: self.user)
+
+      run_command("echo #{opts[:password]} | vncpasswd -f > #{home_folder_path('.vnc/passwd')}")
+
+      # VNC won't start if the passwd is too exposed.
+      file_settings(home_folder_path('.vnc/passwd'), owner: self.user, chmod: 0600)
+
+      opts.reverse_merge!(offset: opts[:port] - 5900, home: home_folder_path())
+
+      set_ownership(home_folder_path('.config/'), self.user)
+    end
+  end
+end

data/lib/aethernal_agent/systemd.rb

@@ -0,0 +1,123 @@
+module AethernalAgent
+  module Systemd
+    class SystemdStatus < OpenStruct;end
+
+    SYSTEMD_ACTIONS = ["stop", "start", "enable", "disable", "restart"]
+
+    def run_user_systemctl(action, options = {})
+      results = {}
+      if options[:service_name]
+        run_command("loginctl enable-linger #{self.user}")
+        result = run_command("sudo -iu #{self.user} systemctl --user #{action} #{options[:service_name]}")
+        if result == false
+          add_errors("Could not '#{action}' service '#{options[:service_name]}'")
+        end
+        results[options[:service_name]] = result
+      else
+        self.manifest.services.each do |service|
+          result = run_command("sudo -iu #{self.user} systemctl --user #{action} #{service}")
+          if result == false
+            add_errors("Could not '#{action}' service '#{service}'")
+          end
+          results[service] = result
+        end
+      end
+
+      return results
+    end
+
+    def create_service_file(options = {})
+      AethernalAgent.logger.debug("Creating systemd file with options: #{options}")
+      # Ensure dbus communication is possible as root
+      run_command('echo \'export XDG_RUNTIME_DIR="/run/user/$UID"\' > /etc/profile.d/02-fix-xdg.sh')
+
+      # Ensure that processes keep running once a user logs out
+      run_command("loginctl enable-linger #{self.user}")
+
+      directory( home_folder_path(".config/systemd/"), owner: self.user)
+      directory( home_folder_path(".config/systemd/user/"), owner: self.user)
+
+      must_start = options[:start] || true
+      must_enable = options[:enable] || true
+
+      if options[:template]
+        write_template(
+          template_path(options[:template]), #source
+          service_file_path(options[:service_name]),
+          options[:vars],
+            {
+              owner: options[:user]
+            }
+        )
+      elsif options[:file]
+        aethernal_agent_file(options[:file], service_file_path(options[:service_name]), owner: options[:user])
+      end
+
+      reload_systemd_config
+      enable if must_enable
+      restart if must_start
+    end
+
+    def reload_systemd_config
+      run_command("systemctl --user daemon-reload")
+    end
+
+    def get_systemd_status(service_file)
+      begin
+        f = IO.popen("sudo -iu #{self.user} systemctl --user status #{service_file}")
+        status = parse_systemd_status_text(f.readlines.join("\n"))
+      rescue Errno::ENOENT => e
+        return false
+      ensure
+        f.close
+      end
+
+      return status
+    end
+
+    def parse_systemd_status_text(text)
+      s = SystemdStatus.new
+
+      if text.present?
+        loaded_status, service_file_and_enabled = text.match(/Loaded: (\w*) \((.*;)/).captures
+        s.service_file_name, enabled_status = service_file_and_enabled.split(";")
+        active_status,running_status = text.match(/Active: (\w*)\ \((.*)\)/).captures
+
+        if text.include?("since")
+          active_status,running_status,s.since = text.match(/Active: (\w*)\ \((.*)\) since (.*);/).captures
+          s.main_pid = text.match(/Main PID: (\d*)/).captures.first
+        end
+      end
+
+      s.loaded = loaded_status == "loaded"
+      s.enabled = enabled_status == " enabled" # there is a space in the output here on purpose
+      s.active = active_status == "active"
+      s.running = running_status == "running"
+
+      return s
+    end
+
+    def service_file_path(service_name)
+      home_folder_path(File.join(".config/systemd/user/", service_name))
+    end
+
+    SYSTEMD_ACTIONS.each do |action|
+      define_method(action) do |options = {}|
+        AethernalAgent.logger.info("#{action} on #{self.manifest.name} (#{self.manifest.services.join(' ')})")
+        opts, errors = ensure_action_options(__method__,options)
+        send("systemd_user_#{action}", opts)
+        return create_return_args(opts)
+      end
+    end
+
+    # Dynamically create systemd_user_stop / start etc. actions
+    def method_missing(method_name, *args)
+      systemd_call = method_name.match(/^systemd_user_(\w*)$/)
+      if systemd_call && systemd_call[1] && SYSTEMD_ACTIONS.include?(systemd_call[1])
+        run_user_systemctl(systemd_call[1], args.first)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/aethernal_agent/template.rb

@@ -0,0 +1,57 @@
+require 'erb'
+require 'aethernal_agent/filesystem'
+require 'aethernal_agent/errors'
+
+module AethernalAgent
+  class Template
+    include AethernalAgent::Filesystem
+    include AethernalAgent::Errors
+
+    attr_accessor :file, :parsed, :result, :template_path, :options
+
+    def initialize(template_path, vars, options)
+      self.template_path = template_path
+      self.options = options
+
+      vars.each do |k,v|
+        AethernalAgent.logger.debug("Setting #{k} to #{v} #{v.class}")
+        if [String, Symbol].include?(v.class)
+          eval("@#{k}= '#{v}'")
+        elsif v.is_a?(NilClass)
+          eval("@#{k}= nil")
+        else
+          eval("@#{k}= #{v}")
+        end
+      end
+    end
+
+    def parse
+      erb = ERB.new(File.open(self.template_path).read)
+      self.result = erb.result(binding)
+
+      if self.result
+        self.parsed = true
+        return true
+      else
+        return false
+      end
+    end
+
+    def write_to(path)
+      return false unless self.parsed
+
+      begin
+        file = File.open(path, "w")
+        AethernalAgent.logger.debug("Writing template to #{path}")
+        file << self.result
+        file.close
+
+        file_settings(path, self.options)
+
+      rescue StandardError => e
+        add_errors(e, path: path)
+        return false
+      end
+    end
+  end
+end