check.cgi

#!/usr/bin/env ruby

############################################################################
# Copyright 2009-2019 Benjamin Kellermann                                  #
#                                                                          #
# This file is part of Dudle.                                              #
#                                                                          #
# Dudle is free software: you can redistribute it and/or modify it under   #
# the terms of the GNU Affero General Public License as published by       #
# the Free Software Foundation, either version 3 of the License, or        #
# (at your option) any later version.                                      #
#                                                                          #
# Dudle is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or        #
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public     #
# License for more details.                                                #
#                                                                          #
# You should have received a copy of the GNU Affero General Public License #
# along with dudle.  If not, see <http://www.gnu.org/licenses/>.           #
############################################################################

if __FILE__ == $0
	require 'pp'
	puts "Content-type: text/plain\n"
	puts

	def print_problems(problems)
		puts 'Some problem occurred:'
		print ' - '
		puts problems.collect { |a|
			a.join("\n   ")
		}.join("\n - ")
	end

	def system_info
		puts 'Some System Info:'
		puts "Ruby Version: #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
		puts 'Environment:'
		pp ENV
	end
	problems = []
	hints = []

	begin
		hints << "You might want to config your environment within the file 'config.rb' (see 'config_sample.rb' for a starting point)" unless File.exist?('config.rb')

		begin
			require_relative 'dudle'
			# require "rubygems"
			# require "atom" FIXME: rename atom.rb
		rescue LoadError => e
			problems << ['Some Library is missing:', e.message]
		end

		unless File.exist?('locale/de/dudle.mo')
			problems << ['If you want a language other than English, you will need a localization and therefore need to build the .mo files. Refer the README for details.']
		end

		if File.writable?('.')
			testdir = 'this-is-a-test-directory-created-by-check.cgi-it-should-be-deleted'
			if Dir.exist?(testdir) # might exist from a previous test
				require 'fileutils'
				FileUtils.rm_r(testdir)
			end
			Dir.mkdir(testdir)
			Dir.chdir(testdir)
			VCS.init
			teststring = 'This is a test'
			File.open('testfile', 'w') { |file|
				file << teststring
			}
			File.symlink('../participate.rb', 'index.cgi')
			VCS.add('testfile')
			VCS.commit('Test commit')
			if VCS.cat(VCS.revno, 'testfile') != teststring
				problems << ['git commit is not working! Please try to set the following within your .htaccess:', 'SetEnv GIT_AUTHOR_NAME="http user"', 'SetEnv GIT_AUTHOR_EMAIL=foo@example.org', 'SetEnv GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"', 'SetEnv GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"']
			end
			Dir.chdir('..')
			require 'fileutils'
			FileUtils.rm_r(testdir)
		else
			problems << ["Your webserver needs write access to #{File.expand_path('.')}"]
		end
	rescue Exception => e
		if problems.empty?
			puts 'Some problem occurred. Please contact the developer:'
			pp e
			puts e.backtrace.join("\n")
		else
			print_problems(problems)
		end
		system_info
	else
		if problems.empty?
			puts 'Your environment seems to be installed correctly!'
			unless hints.empty?
				print "Some hints are following:\n - "
				puts hints.join("\n - ")
			end
		else
			print_problems(problems)
			system_info
		end
	end

	# 4. You have to build a .mo file from the .po file in order to use the
	# localization. Type:
	# make
	# This requires libgettext-ruby-util, potool, and make to be installed.
	# sudo aptitude install libgettext-ruby-util potool make

end