class Project

Attributes

document_root[RW]

output_folder[RW]

project_name[RW]

project_realm[RW]

project_users[RW]

server_admin[RW]

server_name[RW]

server_port_nossl[RW]

server_port_ssl[RW]

server_root[RW]

smtp_default_domain[RW]

smtp_enabled[RW]

smtp_from[RW]

smtp_from_author[RW]

smtp_from_name[RW]

smtp_password[RW]

smtp_port[RW]

smtp_replyto[RW]

smtp_server[RW]

smtp_subject_prefix[RW]

smtp_user[RW]

trac_admin[RW]

virtual_host[RW]

virtual_host_ip[RW]

Public Class Methods

new() click to toggle source

The class constructor

@return [Project] returns the created class

# File lib/projektbauer.rb, line 61
def initialize

  @server_port_nossl = nil
  @server_port_ssl = nil
  @server_root = "xxx"


  @project_name        = nil  # name of project
  @virtual_host        = nil  # set of the project
  @project_realm       = nil  # realm for authorization
  @project_admin_user  = nil  # admin - user
  @server_admin        = nil  # email of server admin
  @smtp_enabled        = false # email is not supported by default

  @trac_admin          = "trac-admin"  # the command to trac-admin

end

Public Instance Methods

create_all() click to toggle source

calling this method after setting all attributes does the entire generation job

@return [Nil] no return

# File lib/projektbauer.rb, line 339
def create_all
  init_filenames
  create_folders

  create_index_html

  save_virtual_host_httpd_conf
  save_project_location_httpd_conf
  update_virtual_host_locations_httpd_conf
  update_include_virtual_hosts_httpd_conf

  create_htpasswd
  create_svn_authz_file
  create_svn

  create_trac
end

create_folders() click to toggle source

Creates the folders in the file system. If a folder already exists, nothing happens.

@return [nil] no return

# File lib/projektbauer.rb, line 116
def create_folders
  #todo: double check if path exists
  FileUtils.mkdir_p @_project_svn_dir
  FileUtils.mkdir_p @_project_trac_dir
  FileUtils.mkdir_p @_document_root_dir
  #todo: ensure that folders are not listable
  #todo: htaccess - file
  nil
end

create_htpasswd() click to toggle source

This creates the htdigest file

@return [Nil] no return

# File lib/projektbauer.rb, line 287
def create_htpasswd

  allusers = @project_users.map{|k,v| v}.flatten
  pwdhashes = {}
  passwords = {}
  allusers.each{|user|
    password = (0...10).map{ ('a'..'z').to_a[rand(26)] }.join
    pwdhashes[user] = _create_passwdentry(@project_realm, user, password)
    passwords[user] = password
  }

  if File.exists?(@_project_auth_user_file) then
    oldcontents = File.open(@_project_auth_user_file).readlines
    oldcontents = oldcontents.map{|i| i.strip }.sort.uniq

    oldentries={}
    oldcontents.each{|entry|

      record = entry.split(":")
      if pwdhashes.has_key?(record.first) then
        pwdhashes[record.first] = entry
        passwords[record.first] = "<password unchanged>"
      else
        passwords[record.first] = "<user deleted>"
      end
    }
  else
    oldcontents=[]
  end

  newcontents=pwdhashes.map{|k,v| v }.sort.uniq
  unless oldcontents==newcontents
    File.open(@_project_auth_user_file, "w"){|f|
      f.puts(newcontents.join("\n"))
    }
  end

  File.open(@_project_auth_user_file+".txt", "a"){|f|
    f.puts "generated passwords for #{@project_realm}"
    f.puts ""
    f.puts(passwords.map{|k,v| "#{k} => #{v}"}.sort.join("\n"))
  }

end

create_index_html() click to toggle source

Creates a minimalistic index.html in the virtual host. In particular this avoids that the files can be listed.

@return [Nil] no return

# File lib/projektbauer.rb, line 182
def create_index_html
  config = expand_erb("index_html.erb")
  File.open(@_index_html_file, "w") {|f|
    f.puts config
  }
end

create_svn() click to toggle source

This creates the svn repository if it does not yet exist. Note that this is tested by investigating the format folder in the svn repository.

todo: improve the detection

@return [type] [description]

# File lib/projektbauer.rb, line 269
def create_svn
  unless File.exists?(@_project_svn_dir + "/format")
    cmd = "svnadmin create \"#{@_project_svn_dir}\""
    puts cmd
    `#{cmd}`
    initialfolders= ["tags", "branches", "trunk"]
    cmd = ["svn mkdir",
           initialfolders.map{|d| "file://\"#{@_project_svn_dir}\"/#{d}"},
           "-m \"Repository created by Projektbauer\""].flatten.join(" ")
    puts cmd
    `#{cmd}`
  end
end

create_svn_authz_file() click to toggle source

creates the Authorization file for svn. Thereby it creates an observer and a contributor group. the {Project.project_admin_user} is entered as contributor

@return [Nil] no return

# File lib/projektbauer.rb, line 166
def create_svn_authz_file
  config =expand_erb("svn_authz_file.erb")

  File.open(@_project_svn_authz_file, "w") {|f|
    f.puts config
  }
  nil
end

create_trac() click to toggle source

This creates the trac environment

@return [type] [description]

# File lib/projektbauer.rb, line 222
def create_trac
  quoted_project_trac_dir = "\"#{@_project_trac_dir}\""

  unless File.exists?("#{@_project_trac_dir}/conf")
    FileUtils.mkdir_p(@_project_trac_dir)
    _trac_admin "#{quoted_project_trac_dir} initenv \"#{@project_name}\" sqlite:\"#{@_project_trac_dir}/db/trac.db\""
    FileUtils.rm(@_trac_ini_file)  # remove this such that it gets regenerated
  end

  _update_trac_ini

  # create group for project.admins
  _trac_admin "#{quoted_project_trac_dir} permission add project.admins TRAC_ADMIN TICKET_ADMIN WIKI_ADMIN"


  @project_users[:admin].each{|u|
    _trac_admin "#{quoted_project_trac_dir} permission add #{u} project.admins"
  }
  _trac_admin "#{quoted_project_trac_dir} permission add project.contributors TRAC_ADMIN TICKET_ADMIN WIKI_ADMIN"
  anonymous_revoke="BROWSER_VIEW CHANGESET_VIEW FILE_VIEW LOG_VIEW MILESTONE_VIEW REPORT_SQL_VIEW"
  anonymous_revoke <<" REPORT_VIEW ROADMAP_VIEW SEARCH_VIEW TICKET_VIEW TIMELINE_VIEW WIKI_VIEW"

  _trac_admin "#{quoted_project_trac_dir} permission remove anonymous #{anonymous_revoke}"
  _trac_admin "#{quoted_project_trac_dir} permission add authenticated #{anonymous_revoke}"

  # crate include-file for webserver
  #
  _trac_admin "#{quoted_project_trac_dir} deploy #{quoted_project_trac_dir}"

  cmd = "chmod +x #{@_project_trac_dir}/cgi-bin/*"
  `#{cmd}`
  # link to the svn repository
  #
  _trac_admin "#{quoted_project_trac_dir} repository add \"(default)\" \"#{@_project_svn_dir}\" svn"

  _create_post_commit
end

init_filenames() click to toggle source

Inititalizes filenames etc. Needs to be called whenever one or more of the attributes are changed.

@return [nil] no return

# File lib/projektbauer.rb, line 85
def init_filenames

  #todo add checks for the attributes
  # no spaces in project_name
  #

  @_virtual_host_home_dir               = "#{@server_root}/#{@virtual_host}"
  @_include_virtual_hosts_httpd_conf    = "#{@server_root}/include_virtual_hosts.httpd.conf"
  @_project_home                        = "#{@_virtual_host_home_dir}/#{@project_name}"
  @_virtual_host_httpd_conf             = "#{@_virtual_host_home_dir}/virtual_host.httpd.conf"
  @_virtual_host_locations_httpd_conf   = "#{@_virtual_host_home_dir}/include_locations.httpd.conf"
  @_project_location_httpd_conf         = "#{@_project_home}/#{@project_name}.httpd.conf"
  @_project_svn_dir                     = "#{@_project_home}/svn"
  @_project_trac_dir                    = "#{@_project_home}/trac"
  @_project_auth_user_file              = "#{@_project_home}/#{@project_realm}.htdigest"
  @_project_svn_authz_file              = "#{@_project_home}/#{@project_name}.dav_svn_authz"
  @_document_root_dir                   = "#{@_virtual_host_home_dir}/www"
  @_index_html_file                     = "#{@_document_root_dir}/index.html"
  @_trac_admin                          = "#{@trac_admin}"
  @_trac_ini_file                       = "#{@_project_trac_dir}/conf/trac.ini"
  nil
end

save_project_location_httpd_conf() click to toggle source

create the apache configuration for the <location> It corresponds to a project.

@return [Nil] no return

# File lib/projektbauer.rb, line 149
def save_project_location_httpd_conf
  config = expand_erb("project_location_httpd_conf.erb")

  File.open(@_project_location_httpd_conf,"w"){|f|
    f.puts config
  }

  nil
end

save_virtual_host_httpd_conf() click to toggle source

This basically creates the configuration of the virtual host

@return [Nil] no return

# File lib/projektbauer.rb, line 133
def save_virtual_host_httpd_conf
  config = expand_erb("virtual_host_httpd_conf.erb")

  File.open(@_virtual_host_httpd_conf,"w"){|f|
    f.puts config
  }

  nil
end

update_include_virtual_hosts_httpd_conf() click to toggle source

Updates the include file with the virtual hosts. This file needs to be added manually to `/etc/apache2/apache2.conf`

@return [Nil] no return

# File lib/projektbauer.rb, line 209
def update_include_virtual_hosts_httpd_conf
  _maintain_include_file(@_include_virtual_hosts_httpd_conf,
                         @_project_location_httpd_conf
                         )
  nil
end

update_virtual_host_locations_httpd_conf() click to toggle source

Updates the include file with the locations. This file is subsequently included in the virtual hosts.

Duplicate entries are removed.

@return [Nil] no return

# File lib/projektbauer.rb, line 197
def update_virtual_host_locations_httpd_conf
  _maintain_include_file(@_virtual_host_locations_httpd_conf,
                         @_project_location_httpd_conf
                         )
end

Private Instance Methods

_create_passwdentry(realm, user, password) click to toggle source

Creates on e particular password entry

@param realm [String] Realm for the password @param user [String] username @param password [String] password

@return [type] [description]

# File lib/projektbauer.rb, line 447
def _create_passwdentry(realm, user, password)
  pwdhash=Digest::MD5.hexdigest("#{user}:#{realm}:#{password}")
  result="#{user}:#{realm}:#{pwdhash}"
  result
end

_create_post_commit() click to toggle source

This creates the post commit hook file

@param file [type] [description]

@return [type] [description]

# File lib/projektbauer.rb, line 413
def _create_post_commit()
  post_commit_file="#{@_project_svn_dir}/hooks/post-commit"
  trac_ini = expand_erb("post-commit.erb")
    File.open(post_commit_file, "w") {|f|
      f.puts trac_ini
    }
  cmd="chmod +x \"#{post_commit_file}\""
  #{cmd}`
end

_maintain_include_file(include_file, entry) click to toggle source

This maintains an include file as follows:

the file is read
the new entry is appended
the result is sorted an duplicates are removed
the file is saved if it is different than before

@param include_file [String] Name if the include file to be maintained @param entry [String] The new entry which shall be included

@return [Nil] no return

# File lib/projektbauer.rb, line 385
def _maintain_include_file(include_file, entry)
  if File.exists?(include_file) then
    old = File.open(include_file).readlines.map{|i| i.strip}
    new=old.clone
  else
    new=[]
  end

  new << "Include #{entry}"

  new=new.sort.uniq

  unless old == new then
    File.open(include_file, "w") {|f|
      f.puts new.join("\n")
    }
  end
  nil
end

_trac_admin(command) click to toggle source

This performs tracadmin commands @param cmd [STring] the arguments to trac-admin

@return [String] [description]

# File lib/projektbauer.rb, line 459
def _trac_admin(command)

  cmd= "#{@trac_admin} #{command}"
  puts cmd
  `#{cmd}`
end

_update_trac_ini() click to toggle source

This updates (actually rewrites) trac.ini

@return [Nil]

# File lib/projektbauer.rb, line 428
def _update_trac_ini()
  trac_ini = expand_erb("trac.ini.erb")
  unless File.exists?(@_trac_ini_file)
    File.open(@_trac_ini_file, "w") {|f|
      f.puts trac_ini
    }
  end
end

expand_erb(file) click to toggle source

This expands the embedded ruby templated @param file [String] Path to the erb template

@return [String] Expanded Templated

# File lib/projektbauer.rb, line 366
def expand_erb(file)
  template=ERB.new File.new(File.dirname(__FILE__)+ "/projektbauer/erb/" + file).readlines.join
  template.result(binding)
end