sixarma-bt 0.7.1

data/LICENSE

@@ -0,0 +1,167 @@
+== sixarma-bt
+
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,8 @@
+== sixarma-bt
+6thSense.eu ArmA BuildTools (Automation Suite), by Sickboy (sb_at_6thSense.eu)
+Documentation:
+- You need at least 1 configuration and 1 previous version yaml file
+- If the most recent version is tagged as released: false,
+the next time you run the program it will assume that this will be the version to work with.
+If released: true, then it will assume you intend to create the next version.
+- run bt-cli -? for help

data/Rakefile

@@ -0,0 +1,49 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'sixarma-bt'
+  s.rubyforge_project = s.name
+  s.version = '0.7.1'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', 'LICENSE']
+  s.summary = 'BuildTools for full conversion Mods for Armed Assault'
+  s.description = 'The program uses a few of my other libraries and tools available for the Armed Assault Game, and subversion, to automate the building process of Full Conversion Mods, while keeping flexibility and configurability in mind'
+  s.author = 'Sickboy'
+  s.email = 'sb@6thsense.eu'
+  s.homepage = 'http://6thsense.eu'
+  # s.executables = ['your_executable_here']
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec}/**/*.rb") + Dir.glob("{bin,lib,spec}/**/*.yaml")
+  s.require_path = "lib"
+  s.bindir = "bin"
+  s.add_dependency('sixarma', '>= 0.4.0')
+  s.add_dependency('sixcore', '>= 0.3.0')
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "sixarma-bt Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/lib/sixarma/bt/build.rb

@@ -0,0 +1,135 @@
+module SixArma
+  module Bt
+    class Builder
+      private
+      # Cleans folders
+      # mod:: mod config object
+      # folder:: folder config object
+      def clear_folders(mod, folder)
+        case folder.type
+        when "addons"
+          # Remove deleted files
+          SixCore::info "Removing Deleted Files from Full..."
+          delete = File.open("#{mod.changes}/#{@config.workdel}_#{folder.name}.txt") { |file| file.readlines.map { |line| SixCore::clean(line) } }
+          delete.each do |item|
+            SixCore::filedel("#{@config.outroot}\\files\\full\\#{mod.destination}\\#{folder.name}\\#{item}.*")
+          end
+
+          SixCore::info "Cleaning Update folder..."
+          SixCore::filedel("#{@config.outroot}\\files\\update\\#{mod.destination}\\#{folder.name}\\*.pbo")
+          SixCore::filedel("#{@config.outroot}\\files\\update\\#{mod.destination}\\#{folder.name}\\*.bisign")
+        end
+      end
+
+      # Copy from addon folders
+      # e.g: 3rd Party pbos
+      # mod:: mod config object
+      # folder:: folder config object
+      def copy_stuff(mod, folder)
+        case folder.type
+        when "addons"
+          SixCore::info "Copying 3rd_Party_Pbos..."
+          thirdparty_pbo = File.open("#{mod.changes}/#{@config.work3rd_pbo}_#{folder.name}.txt") { |file| file.readlines.map { |line| SixCore::clean(line) } }
+          source = "#{mod.path}\\#{mod.source}\\#{folder.name}"
+          dest = "#{@config.outroot}\\files\\update\\#{mod.destination}\\#{folder.name}"
+          thirdparty_pbo.each do |item| SixCore::filecopy("#{source}\\#{item}", dest) end
+        end
+      end
+
+      # Verify if altsource exists, if not, use real source
+      def check_source(mod, folder, item)
+        source = "#{mod.path}\\#{mod.source}\\#{folder.name}\\#{item}"
+        unless mod.altsource.nil?
+          tmp = "#{mod.path}\\#{mod.altsource}\\#{folder.name}\\#{item}"
+          source = tmp if FileTest.directory?(tmp)
+        end
+        return source
+      end
+
+      # Build, Binarize, and pack PBOs
+      # mod:: Mod Config Object
+      # folder:: Folder Config Object
+      def pbotools_build(mod, folder)
+        # read files into arrays, strip newline chars
+        exclude = []
+        tmp = "#{mod.changes}/_exclude_#{folder.name}.txt"
+        if FileTest.exist?(tmp)
+          exclude = File.open(tmp) { |file| file.readlines.map { |line| SixCore::clean(line) } }
+        end
+
+        delete = File.open("#{mod.changes}/#{@config.workdel}_#{folder.name}.txt") { |file| file.readlines.map { |line| SixCore::clean(line) } }
+
+        tmp = File.open("#{mod.changes}/#{@config.workbin}_#{folder.name}.txt") { |file| file.readlines.map { |line| SixCore::clean(line) } }
+        binfiles = []
+        tmp.each do |e|
+          binfiles << e unless delete.include?(e) || exclude.include?(e)
+        end
+
+        tmp = File.open("#{mod.changes}/#{@config.workpbo}_#{folder.name}.txt") { |file| file.readlines.map { |line| SixCore::clean(line) } }
+        pbofiles = []
+        tmp.each do |e|
+          pbofiles << e unless delete.include?(e) || exclude.include?(e)
+        end
+        combined = []
+        combined += pbofiles
+        combined += binfiles
+
+        dest = "#{@config.outroot}\\files\\update\\#{mod.destination}\\#{folder.name}"
+
+        # Create folders and mirror SOURCE files
+        SixCore::info "Creating folders and mirroring source files..."
+        combined.each do |item|
+          source = check_source(mod, folder, item)
+          SixCore::filemirror(source, "#{@config.workdir}\\#{item}", "/XD .svn")
+          # When using alternate prefixes, also mirror files to prefix folder name
+          prefix = SixArma::PboTools::check_prefix(source, "__AUTO__")
+          unless prefix == "" or prefix != prefix.gsub!("\\", "")
+            SixCore::filemirror(source, "#{@config.workdir}\\#{prefix}", "/XD .svn")
+          end
+        end
+
+        # Build the addons
+        SixCore::info "Binarizing..."
+        binfiles.each do |item|
+          SixArma::PboTools.binarize("#{@config.workdir}\\#{item}", dest, "__AUTO__")
+        end
+
+        SixCore::info "PBOing..."
+        pbofiles.each do |item|
+          SixArma::PboTools.pack("#{@config.workdir}\\#{item}", dest, "__AUTO__")
+        end
+
+        # CleanUp
+        SixCore::info "Cleaning up..."
+        SixCore::filemove("#{dest}\\*.log", "#{@config.outroot}\\log\\")
+        #      combined.each do |item|
+        #        SixCore::filemove("#{dest}\\#{item}.log", "#{@config.outroot}\\log\\")
+        #      end
+      end
+
+      public
+      # Clears all mods and their subfolders
+      def clear()
+        @config.mods.each do |mod|
+          mod.subfolders.each do |folder|
+            SixCore::infos("Clear Addon Folders - #{mod.destination}\\#{folder.name}", COMPONENT)
+            clear_folders(mod, folder)
+          end
+        end
+        SixCore::halt() if @halt
+      end
+
+      # Meta method that launches pbotools_build and copy_stuff on each mod and subfolder
+      def addon_changes()
+        @config.mods.each do |mod|
+          mod.subfolders.each do |folder|
+            SixCore::infos("BuildChanges - #{mod.destination}\\#{folder.name}", COMPONENT)
+            pbotools_build(mod, folder) if folder.type == "addons"
+            copy_stuff(mod, folder)
+          end
+        end
+        SixCore::halt() if @halt
+      end
+    end
+  end
+end

data/lib/sixarma/bt/nsis.rb

@@ -0,0 +1,56 @@
+module SixArma
+  module Bt
+    class Builder
+      # Build an NSIS setup file
+      # type:: update or full
+      def nsis_build(type)
+        SixCore::infos("Nsis Build - #{type}", COMPONENT)
+        cfg = @config.nsis
+
+        newdelete = "";
+        @config.mods.each do |mod|
+          mod.subfolders.each do |folder|
+            del = File.open("#{mod.changes}/#{@config.workdel}_#{folder.name}.txt") do |file|
+              file.readlines.map { |line| SixCore::clean(line) }
+            end
+            del.each { |item| newdelete += "\n		Delete \"#{mod.nsis.out}\\#{folder.name}\\#{item}.*\"" }
+          end
+        end
+
+        replace = [
+          [cfg.reg_newver, SixCore::quote(@stats.newver)],
+          [cfg.reg_oldver, SixCore::quote(@stats.oldver)],
+          [cfg.reg_verpath, @config.verpath],
+          [cfg.reg_out, cfg.out],
+          [cfg.reg_delete, newdelete],
+          [cfg.reg_type, type]
+        ]
+
+        out = "#{cfg.out}_v#{@stats.newver}#{type}.exe"
+        nsis = SixCore::Nsis.new("#{@config.outroot}\\#{cfg.template}", "#{@config.outroot}\\#{cfg.output}")
+        SixCore::info "Creating Setup File: #{out}..."
+        nsis.create_output(replace)
+        size = (File.size("#{@config.outroot}\\#{out}") / 1024) / 1024
+        SixCore::info "Finished Creating Setup File: #{out} (#{size}MB)..."
+
+        return out
+      end
+
+      # Build NSIS Update
+      # nsis_build("update")
+      def nsis_update()
+        @stats.updatefile = nsis_build("update")
+        write_stats()
+        SixCore::halt() if @halt
+      end
+
+      # Build NSIS Full
+      # nsis_build("full")
+      def nsis_full()
+        @stats.fullfile = nsis_build("full")
+        write_stats()
+        SixCore::halt() if @halt
+      end
+    end
+  end
+end

data/lib/sixarma/bt/options.rb

@@ -0,0 +1,133 @@
+require 'optparse'
+require 'ostruct'
+require 'sixcore'
+
+
+# Configuration File
+@options = OpenStruct.new
+@options.configfile = ''
+@options.halt = false
+@options.todo = []
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} CONFIGFILE [options]"
+
+  opts.separator ''
+  opts.separator 'Processing the imported CONFIGFILE file:'
+
+  opts.on('-h', '--halt',  'Halt at every step') do |o|
+    @options.halt = o
+  end
+
+  opts.separator ''
+  opts.separator 'Programs'
+
+  opts.on('-c', '--complete',  'Run Complete Process',
+          'create_all, dist_all',
+          '(Will however use threads after finishing Update creation)') do |o|
+    @options.todo << 'complete'
+  end
+
+  opts.on('-r', '--release',  'Run Release Process',
+          'Sets release flag in version stats to true,',
+          'and checks for _tmp files on ftp and renames them') do |o|
+    @options.todo << 'release'
+  end
+
+  opts.on('--create_update',  'Run Create Update Process',
+          'build_full, update_sign("full", "update"), nsis_update') do |o|
+    @options.todo << 'create_update'
+  end
+
+  opts.on('--create_full',  'Run Create Full Process',
+          'build_full, nsis_full') do |o|
+    @options.todo << 'create_full'
+  end
+
+  opts.on('--create_all',  'Run Create All Process',
+          'create_update, nsis_full') do |o|
+    @options.todo << 'create_all'
+  end
+
+  opts.separator ''
+  opts.separator 'Individual Processes'
+
+  opts.on('--clear',  'Run Clear Process',
+          'Removes deleted files from Full and Clears out all Addons folders in update') do |o|
+    @options.todo << 'clear'
+  end
+
+  opts.on('--svn_do',  'Run Svn Do Process',
+          'Grabs SVN changes information') do |o|
+    @options.todo << 'svn_do'
+  end
+
+  opts.on('--addon_changes',  'Run Addon Changes Process',
+          'Builds addon folders into update folder') do |o|
+    @options.todo << 'addon_changes'
+  end
+
+  opts.separator ''
+  opts.separator 'Mini Programs'
+
+  opts.on('--build_update',  'Run Build Update Process',
+          'svn_do, clear, addon_changes, sign_update') do |o|
+    @options.todo << 'build_update'
+  end
+
+  opts.on('--build_full',  'Run Build Full Process',
+          'svn_do, clear, addon_changes, clear_sign, sign_full') do |o|
+    @options.todo << 'build_full'
+  end
+
+  opts.on('--sign_update',  'Run Sign Update Process',
+          'Sign all addons under update') do |o|
+    @options.todo << 'sign_update'
+  end
+
+  opts.on('--sign_full',  'Run Sign Full Process',
+          'Sign all addons under full') do |o|
+    @options.todo << 'sign_full'
+  end
+
+  opts.on('--nsis_update',  'Run NSIS Update Process',
+          'Builds an NSIS Update file') do |o|
+    @options.todo << 'nsis_update'
+  end
+
+  opts.on('--nsis_full',  'Run NSIS Full Process',
+          'Builds an NSIS Full file') do |o|
+    @options.todo << 'nsis_full'
+  end
+
+  opts.on('--dist_update',  'Run Dist Update Process',
+          'upload update to ftp(s), update_sign("full", "update"), nsis_update') do |o|
+    @options.todo << 'dist_update'
+  end
+
+  opts.on('--dist_full',  'Run Dist Full Process',
+          'upload full to ftp(s)') do |o|
+    @options.todo << 'dist_full'
+  end
+
+  opts.on('--dist_all',  'Run Dist All Process',
+          'dist_update, dist_full') do |o|
+    @options.todo << 'dist_all'
+  end
+
+  opts.separator ''
+  opts.separator 'Common options:'
+
+  opts.on_tail('-?', '--help', 'Display this message') do |o|
+    puts opts.help
+  end
+end
+
+option_parser.parse!
+
+if ARGV.empty?
+  @options.configfile = 'docs/example.yaml'
+  SixCore::info 'Please use parameter -? for help'
+else
+  @options.configfile = ARGV[0]
+end

data/lib/sixarma/bt/sign.rb

@@ -0,0 +1,97 @@
+module SixArma
+  module Bt
+    class Builder
+      private
+      # Creats signature files
+      # type:: update or full
+      def sign_create(type)
+        cfg = @config.sign
+
+        # create the key
+        name = "#{cfg.file}_v#{@stats.newver}"
+        r = SixArma::Sign.create(name)
+        SixCore::filecopy("#{r[2]}\\#{r[1]}", "#{@config.outroot}\\files\\#{type}\\keys\\")
+        return r
+      end
+
+      # Alternative signature creator (per folder)
+      # type:: update or full
+      # folder:: mod folder name
+      def sign_create2(type, folder)
+        cfg = @config.sign
+
+        # create the key
+        name = "#{cfg.file}_#{folder}_v#{@stats.newver}"
+        r = SixArma::Sign.create(name)
+        SixCore::filecopy("#{r[2]}\\#{r[1]}", "#{@config.outroot}\\files\\#{type}\\keys\\")
+        return r
+      end
+
+      # Signs addons
+      # type:: update or full
+      def sign_do(type)
+        SixCore::infos("Sign Do - #{type}", COMPONENT)
+
+        case @config.sign.keytype
+        when "whole"
+          signfiles = sign_create("full")
+          signfiles = sign_create("update") # TODO - Lame, function copies instead of create new one, but still - need to move
+
+          # process each destination's subfolders
+          @config.mods.each do |mod|
+            mod.subfolders.each do |folder|
+              if folder.type == "addons"
+                SixCore::info "Clearing signatures - #{type}\\#{mod.destination}\\#{folder.name}..."
+                SixCore::filedel("#{@config.outroot}\\files\\#{type}\\#{mod.destination}\\#{folder.name}\\*.bisign")
+                SixCore::info "Signing - #{mod.destination}\\#{folder.name}..."
+                SixArma::Sign.sign("#{@config.outroot}\\files\\#{type}\\#{mod.destination}\\#{folder.name}", signfiles[0])
+              end
+            end
+          end
+
+        when "folder"
+          @config.mods.each_with_index do |mod, idx|
+            changes = []
+            @stats.mods[idx].subfolders.each do |folder|
+              changes += (folder.add + folder.del + folder.change) # if folder.type == "addons"
+            end
+            unless changes.empty?
+              #sf = mod.destination.gsub("@", "")
+              #sf = mod.destination if sf.nil? or sf.empty?
+              # TODO: Lame update+full processing
+              SixCore::filedel("#{@config.outroot}\\files\\update\\Keys\\#{@config.sign.file}_#{mod.destination}*.bikey")
+              SixCore::filedel("#{@config.outroot}\\files\\full\\Keys\\#{@config.sign.file}_#{mod.destination}*.bikey")
+
+              signfiles = sign_create2("full", mod.destination)
+              signfiles = sign_create2("update", mod.destination)
+
+              mod.subfolders.each do |folder|
+                if folder.type == "addons"
+                  SixCore::info "Clearing signatures - #{type}\\#{mod.destination}\\#{folder.name}..."
+                  SixCore::filedel("#{@config.outroot}\\files\\#{type}\\#{mod.destination}\\#{folder.name}\\*.bisign")
+                  SixCore::info "Signing - #{mod.destination}\\#{folder.name}..."
+                  SixArma::Sign.sign("#{@config.outroot}\\files\\#{type}\\#{mod.destination}\\#{folder.name}", signfiles[0])
+                end
+              end
+            end
+          end
+        end
+      end
+
+      public
+      # Sign Update
+      # sign_do("update")
+      def sign_update()
+        sign_do("update")
+        SixCore::halt() if @halt
+      end
+
+      # Sign Full
+      # sign_do("full")
+      def sign_full()
+        sign_do("full")
+        SixCore::halt() if @halt
+      end
+    end
+  end
+end