pi_customizer 0.3.0.pre.alpha → 0.3.1.pre.alpha

data/pi_build_modifier/lib/pi_build_modifier/modifier/mapper.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module PiBuildModifier
+
+  ##
+  # Mapper represents a container that is used by the pi_build_modifier to call
+  # the necessary steps to modify a build configuration.
+  # It triggers check, mapping, and modification steps for one build configuration.
+
+  class Mapper
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def check(json_data)
+      @data.check(json_data) unless @data.nil?
+    end
+
+    def map(json_data)
+      @data.map(json_data) unless @data.nil?
+    end
+
+    def modify
+      @data.modify unless @data.nil?
+    end
+
+  end
+end

data/pi_build_modifier/lib/pi_build_modifier/modifier/pi_modifier.rb

@@ -0,0 +1,81 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'json'
+
+module PiBuildModifier
+  class PiModifier
+
+    attr_reader :mappers
+
+    def initialize
+      @mappers = Array.new
+      @json_path = nil
+      @json_data = nil
+    end
+
+    def with_json_configuration(json_file)
+      @json_path = json_file
+    end
+
+    def with_mapper(mapper)
+      if mapper.is_a? Mapper
+        @mappers << mapper
+      else
+        raise 'Parameter must be of type Mapper'
+      end
+    end
+
+    def modify(do_check = false)
+      load_config
+      check_all if do_check
+      map_all
+      modify_all
+    end
+
+    private def load_config
+      if File.file?(@json_path)
+        File.open(@json_path, 'r+') do |f|
+          @json_data = JSON.parse(f.read)
+        end
+      else
+        raise "Json configuration file does not exist at '#{@json_path}!'"
+      end
+    end
+
+    private def check_all
+      @mappers.each do |mapper|
+        mapper.check(@json_data)
+      end
+    end
+
+    private def map_all
+      @mappers.each do |mapper|
+        mapper.map(@json_data)
+      end
+    end
+
+    private def modify_all
+      @mappers.each do |mapper|
+        mapper.modify
+      end
+    end
+  end
+end

data/pi_build_modifier/lib/pi_build_modifier/modifier_task.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'pi_build_modifier/modifier/pi_modifier'
+require 'pi_build_modifier/modifier/erb_mapper'
+require 'pi_build_modifier/net-tweaks/wifi_network'
+require 'pi_build_modifier/system/system_type'
+require 'pi_build_modifier/sys_tweaks/run_modifier'
+require 'pi_build_modifier/sys_tweaks/ssh'
+require 'pi_build_modifier/locale/locale_debconf'
+require 'pi_build_modifier/boot-files/boot'
+
+module PiBuildModifier
+  module Task
+
+    ##
+    # Modifier triggers all changes specified in the config. To this end,
+    # it configures and calls specialized mappers which map the config to
+    # the the individual pi-gen build scripts.
+
+    class Modifier
+
+      attr_reader :pi_modifier
+
+      ##
+      # Initialization and configuration of the mappers that are used to change in the pi-gen build sources
+
+      def initialize(config, workspace, pi_modifier = PiModifier.new)
+        @mappers = create_mappers
+        @pi_modifier = pi_modifier
+        configure_pi_modifier(config, workspace)
+      end
+
+      ##
+      # Defines all mappers
+
+      private def create_mappers
+        mappers = {
+            :wpa_supplicant => WPASupplicant.new,
+            :system => System.new,
+            :ssh => Ssh.new,
+            :run_modifier => RunModifier.new,
+            :locale => Locale.new,
+            :boot => Boot.new
+        }
+        mappers[:run_modifier].append(mappers[:ssh]) #TODO: This connection has to be established somewhere else
+        mappers
+      end
+
+      private def configure_pi_modifier(config, workspace)
+        @pi_modifier.with_json_configuration(config)
+        @mappers.each do |*, mapper_data|
+          @pi_modifier.with_mapper(mapper_data.mapper(workspace))
+        end
+      end
+
+      def execute
+        @pi_modifier.modify
+      end
+    end
+  end
+end

data/pi_build_modifier/lib/pi_build_modifier/net-tweaks/templates/wpa_supplicant.conf.erb

@@ -0,0 +1,5 @@
+country=<%= @wpa_country %>
+ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
+update_config=1
+
+<% @networks.each do |network|  %>network=<%= network %><% end %>

data/pi_build_modifier/lib/pi_build_modifier/net-tweaks/wifi_network.rb

@@ -0,0 +1,124 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'erb'
+require 'json'
+require 'openssl'
+require 'pi_build_modifier/modifier/erb_mapper'
+
+module PiBuildModifier
+
+  ##
+  # WifiNetwork represents a network in the wpa_supplicant configuration
+
+  class WifiNetwork
+
+    attr_reader :ssid, :psk
+
+    def initialize(ssid, psk)
+      @ssid = ssid
+      @psk = psk
+    end
+
+    def to_s
+      sprintf('{
+  ssid="%s"
+  psk=%s
+}', ssid, psk)
+    end
+  end
+
+  ##
+  # WPASupplicant represents the wpa_supplicant's configuration
+
+  class WPASupplicant
+
+    PASSPHRASE = 'passphrase'
+
+    WPA_PASSPHRASE = 'wpa_passphrase'
+
+    SSID = 'ssid'
+
+    attr_reader :template_path, :relative_output_path
+
+    ##
+    # By default, WPASupplicant is configured with:
+    # wpa_country:  DE
+    # template:     './templates/wpa_supplicant.conf.erb'
+    # output path:  'stage2/02-net-tweaks/files/wpa_supplicant.conf'
+
+    def initialize
+      @networks = map_network(nil)
+      @wpa_country = 'DE'
+      @template_path = File.join(File.dirname(__FILE__), '/templates/wpa_supplicant.conf.erb').to_s
+      @relative_output_path = 'stage2/02-net-tweaks/files/wpa_supplicant.conf'
+    end
+
+    def mapper(workspace)
+      ERBMapper.new(self, workspace)
+    end
+
+    #TODO: test
+    def check(json_data)
+      unless File.file?(@relative_output_path)
+        raise "File #{relative_output_path} does not exist"
+      end
+    end
+
+    ##
+    # map the 'wifi' section in the json configuration to the instance variables.
+
+    def map(json_data)
+      unless json_data.nil?
+        @networks = map_network(json_data['wifi']) if json_data.has_key?('wifi')
+        @wpa_country = json_data['wifi']['wpa_country'] if json_data.has_key?('wifi') && json_data['wifi'].has_key?('wpa_country')
+      end
+    end
+
+    private def map_network(json_data)
+      if json_data.nil? or not json_data.has_key?('networks')
+        networks = Array.new(0)
+      else
+        networks = json_data['networks'].map do |rd|
+          ssid = if rd.has_key?(SSID)
+                   rd[SSID]
+                 else
+                   'no_ssid'
+                 end
+          psk = if rd.has_key?(PASSPHRASE)
+                  OpenSSL::PKCS5.pbkdf2_hmac_sha1(rd[PASSPHRASE], ssid, 4096, 32).unpack("H*").first
+                elsif rd.has_key?(WPA_PASSPHRASE)
+                  rd[WPA_PASSPHRASE]
+                else
+                  'no_psk'
+                end
+          WifiNetwork.new(ssid, psk)
+        end
+      end
+      networks
+    end
+
+    def get_binding
+      binding
+    end
+
+  end
+end
+

data/pi_build_modifier/lib/pi_build_modifier/sys_tweaks/run_modifier.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'fileutils'
+require 'pi_build_modifier/modifier/mapper'
+
+
+module PiBuildModifier
+
+  ##
+  # RunModifier is a class which appends lines to the sys-tweaks run file in the pi-gen build directory.
+  # By default this is the file 'stage2/01-sys-tweaks/01-run.sh'.
+
+  class RunModifier < Mapper
+
+    attr_reader :relative_output_path, :appender
+
+    def initialize
+      @appender = Array.new
+      @workspace = nil
+      @relative_output_path = 'stage2/01-sys-tweaks/01-run.sh'
+    end
+
+    def mapper(workspace)
+      @workspace = workspace
+      self
+    end
+
+    def append(appender)
+      @appender << appender
+    end
+
+    ##
+    # modify the sys-tweaks run file by adding lines at the end of the file
+
+    def modify
+      open("#{@workspace}/#{@relative_output_path}", 'a') do |f|
+        f.puts ''
+        @appender.each do |a|
+          f.puts "source #{@workspace}/#{a.append_line}"
+        end
+      end
+    end
+
+  end
+end

data/pi_build_modifier/lib/pi_build_modifier/sys_tweaks/ssh.rb

@@ -0,0 +1,61 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'fileutils'
+require 'pi_build_modifier/modifier/mapper'
+require 'pi_build_modifier/sys_tweaks/run_modifier'
+require 'pi_build_modifier/config/logex'
+
+module PiBuildModifier
+
+  class Ssh
+
+    attr_accessor :enable
+
+    attr_reader :template_path, :relative_output_path
+
+    def initialize
+      @enable = 'enable'
+      @template_path = File.join(File.dirname(__FILE__), '/templates/ssh.sh.erb').to_s
+      @relative_output_path = 'stage2/01-sys-tweaks/ssh.sh'
+    end
+
+    def mapper(workspace)
+      ERBMapper.new(self, workspace)
+    end
+
+    def append_line
+      "#{@relative_output_path}"
+    end
+
+    def map(json_data)
+      unless json_data.nil?
+        @enable = 'disable' if json_data.has_key?('ssh') && json_data['ssh'].has_key?('enabled') && (not json_data['ssh']['enabled'])
+      else
+        $logger.error 'Ssh could not be configured: Invalid json data.'
+      end
+    end
+
+    def get_binding
+      binding
+    end
+
+  end
+end