poll.rb

############################################################################
# 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/>.           #
############################################################################

require_relative 'hash'
require 'yaml'
require 'time'
require 'fileutils'
require_relative 'pollhead'
require_relative 'timepollhead'

$KCODE = 'u' if RUBY_VERSION < '1.9.0'
class String
	@@htmlidcache = {}
	@@htmlidncache = {}

	# FIXME: htmlid should not depend on the order it is requested
	def to_htmlID
		if @@htmlidcache[self]
			id = @@htmlidcache[self]
		else
			id = gsub(/[^A-Za-z0-9_\-]/, '_')
			if @@htmlidncache[id]
				@@htmlidncache[id] += 1
				id += @@htmlidncache[id].to_s
			end
			@@htmlidncache[id] = -1
			@@htmlidcache[self] = id
		end
		id
	end
end

class WrongPollTypeError < StandardError
end

class Poll
	attr_reader :head, :name

	YESVAL   = 'a_yes__'
	MAYBEVAL = 'b_maybe'
	NOVAL    = 'c_no___'

	@@table_html_hooks = []
	def self.table_html_hooks
		@@table_html_hooks
	end

	def initialize(name, type)
		@name = name

		case type
		when 'normal'
			@head = PollHead.new
		when 'time'
			@head = TimePollHead.new
		else
			raise(WrongPollTypeError, "unknown poll type: #{type}")
		end
		@data = {}
		@comment = []
		store "Poll #{name} created"
	end

	def sort_data(fields)
		if fields.include?('name')
			until fields.pop == 'name'
			end
			@data.sort { |x, y|
				cmp = x[1].compare_by_values(y[1], fields)
				cmp == 0 ? x[0].downcase <=> y[0].downcase : cmp
			}
		else
			@data.sort { |x, y| x[1].compare_by_values(y[1], fields) }
		end
	end

	def userstring(participant, link)
		ret = ''
		if link
			ret += "<td><span class='edituser'>"
			ret += '<a title="'
			ret += format(_('Edit user %<user>s...'), user: CGI.escapeHTML(participant))
			ret += '" aria-label="'
			ret += format(_('Edit user %<user>s...'), user: CGI.escapeHTML(participant))
			ret += "\" href=\"?edituser=#{CGI.escape(participant)}\">"
			ret += EDIT
			ret += '</a> | <a title="'
			ret += format(_('Delete user %<user>s...'), user: CGI.escapeHTML(participant))
			ret += '" aria-label="'
			ret += format(_('Delete user %<user>s...'), user: CGI.escapeHTML(participant))
			ret += "\" href=\"?deleteuser&amp;edituser=#{CGI.escape(participant)}\">"
			ret += "#{DELETE}</a>"
			ret += '</span></td>'
			ret += "<td class='name'>"
		else
			ret += "<td class='name' colspan='2'>"
		end
		ret += "<span id=\"#{participant.to_htmlID}\">#{CGI.escapeHTML(participant)}</span>"
		ret += '</td>'
		ret
	end

	def to_html(showparticipation = true)
		# border=1 for textbrowsers ;--)
		ret = "<table id='participanttable' class='polltable' border='1'>\n"

		sortcolumns = $cgi.include?('sort') ? $cgi.params['sort'] : ['timestamp']
		ret += "<thead>#{@head.to_html(sortcolumns)}</thead>"
		ret += "<tbody id='participants'>"
		sort_data(sortcolumns).each { |participant, poll|
			if $cgi['edituser'] == participant
				ret += participate_to_html
			else
				ret += "<tr id=\"#{participant.to_htmlID}_tr\" class='participantrow'>\n"
				ret += userstring(participant, showparticipation)
				@head.columns.each { |column|
					case poll[column]
					when nil
						value = UNKNOWN
						klasse = 'undecided'
						str = _('Unknown')
					when /yes/ # allow anything containing yes (backward compatibility)
						value = YES
						klasse = YESVAL
						str = format(_('%<user>s selected Yes'), user: CGI.escapeHTML(participant))
					when /no/
						value = NO
						klasse = NOVAL
						str = format(_('%<user>s selected No'), user: CGI.escapeHTML(participant))
					when /maybe/
						value = MAYBE
						klasse = MAYBEVAL
						str = format(_('%<user>s selected Maybe'), user: CGI.escapeHTML(participant))
					end
					if column.to_s.match(/\d\d\d\d-\d\d-\d\d/)
						ret += "<td class=\"vote #{klasse}\" title=\"#{CGI.escapeHTML(participant)}: #{CGI.escapeHTML(column.to_s)}\"><span class='visually-hidden'>#{str}</span><span aria-hidden='true'>#{value}</span></td>\n"
					else
						ret += "<td class=\"vote #{klasse}\" title=\"#{CGI.escapeHTML(participant)}: #{CGI.escapeHTML(column.to_s)}\"><span class='visually-hidden'>#{str}</span><span aria-hidden='true'>#{value}</span></td>\n"
					end
				}
				ret += "<td class='date'>#{poll['timestamp'].strftime('%c')}</td>"
				ret += "</tr>\n"
			end
		}

		@@table_html_hooks.each { |hook| ret += hook.call(ret) }

		ret += '</tbody><tbody>'
		# PARTICIPATE
		ret += participate_to_html unless @data.keys.include?($cgi['edituser']) || !showparticipation

		# SUMMARY
		ret += "<tr id='summary'><td colspan='2' class='name'>" + _('Total') + "</td>\n"
		@head.columns.each { |column|
			yes = 0
			undecided = 0
			@data.each_value { |participant|
				if participant[column] =~ /yes/
					yes += 1
				elsif !participant.has_key?(column) or participant[column] =~ /maybe/
					undecided += 1
				end
			}

			if @data.empty?
				percent_f = 0
			else
				percent_f = 100.0 * yes / @data.size
			end
			percent = "#{percent_f.round}%" unless @data.empty?
			if undecided > 0
				percent + "-#{(100.0 * (undecided + yes) / @data.size).round} %"
			end

			ofstr = _('out of')
			votedstr = _('participants voted yes')

			ret += "<td id=\"sum_#{column.to_htmlID}\" class=\"sum match_#{(percent_f / 10).round * 10}\" title=\"#{yes} #{ofstr} #{@data.size} #{votedstr}\"><span aria-hidden=\"true\">#{yes}</span><span class=\"visually-hidden\">#{yes} #{ofstr} #{@data.size} #{votedstr}.</span></td>\n"
		}

		ret += "<td class='invisible'></td></tr>"
		ret += "</tbody></table>\n"
		ret
	end

	def invite_to_html
		edituser = $cgi['edituser'] unless $cgi.include?('deleteuser')
		invitestr = _('Invite')
		namestr = _('Name')
		ret = <<HEAD
<table id='participanttable'>
<thead>
	<tr><th colspan='2'>#{namestr}</th></tr>
</thead>
HEAD
		@data.keys.sort.each { |participant|
			has_voted = false
			@head.columns.each { |column|
				has_voted = true unless @data[participant][column].nil?
			}

			if edituser == participant
				ret += "<tr id='add_participant'>"
				ret += add_participant_input(edituser)
				ret += save_input(edituser, invitestr)
			else
				ret += "<tr id='#{participant.to_htmlID}_tr' class='participantrow'>"
				ret += userstring(participant, !has_voted)
			end
			ret += '</tr>'
		}
		unless @data.keys.include?(edituser)
			ret += "<tr id='add_participant'>"
			ret += add_participant_input(edituser)
			ret += save_input(edituser, invitestr)
			ret += '</tr>'
		end
		ret += '</table>'
		ret
	end

	def add_participant_input(edituser)
		<<END
<td colspan='2' id='add_participant_input_td'>
	<input type='hidden' name='olduser' value="#{CGI.escapeHTML(edituser.to_s)}" />
	<input size='16'
		type='text'
		name='add_participant'
		id='add_participant_input'
		aria-label='#{CGI.escapeHTML(_('Enter your name'))}'
		title='#{CGI.escapeHTML(_('Enter your name'))}'
		value="#{CGI.escapeHTML(edituser.to_s)}"/>
</td>
END
	end

	def save_input(edituser, savestring, changestr = _('Save changes'))
		ret = '<td>'
		if @data.include?(edituser)
			ret += "<input id='savebutton' type='submit' value=\"#{changestr}\" />"
			ret += "<br /><input id='cancelbutton' style='margin-top:1ex' type='submit' name='cancel' value='" + _('Cancel') + "' />"
		else
			ret += "<input id='savebutton' type='submit' value=\"#{savestring}\" />"
		end
		ret + "</td>\n"
	end

	def participate_to_html
		ret = "<tr id='separator_top'><td colspan='#{@head.col_size + 3}' class='invisible'></td></tr>\n"

		if $cgi.include?('deleteuser') && @data.include?($cgi['edituser'])
			ret += deleteuser_to_html
		else
			ret += edituser_to_html
		end
		ret + "<tr id='separator_bottom'><td colspan='#{@head.col_size + 3}' class='invisible'></td></tr>\n"
	end

	def deleteuser_to_html
		ret = "<tr id='add_participant'>\n"
		ret += "<td colspan='2' class='name'>#{CGI.escapeHTML($cgi['edituser'])}</td>"
		ret += "<td colspan='#{@head.col_size}'>"
		ret += format(_('Do you really want to delete user %<user>s?'), user: CGI.escapeHTML($cgi['edituser']))
		ret += "<input type='hidden' name='delete_participant_confirm' value='#{CGI.escapeHTML($cgi['edituser'])}' />"
		ret += '</td>'
		ret += save_input($cgi['edituser'], '', _('Confirm'))
		ret += '</tr>'
		ret
	end

	def edituser_to_html
		edituser = $cgi['edituser']
		checked = {}
		if @data.include?(edituser)
			@head.columns.each { |k| checked[k] = @data[edituser][k] }
		else
			edituser = $cgi.cookies['username'][0] unless @data.include?($cgi.cookies['username'][0])
			@head.columns.each { |k| checked[k] = NOVAL }
		end

		ret = "<tr id='add_participant'>\n"

		ret += add_participant_input(edituser)

		@head.columns.each { |column|
			ret += "<td class='checkboxes'><table class='checkboxes'>"
			[[YES, YESVAL, _('Yes')], [NO, NOVAL, _('No')], [MAYBE, MAYBEVAL, _('Maybe')]].each { |valhuman, valbinary, valtext|
				if column.to_s.match(/\d\d\d\d-\d\d-\d\d/)
					ret += <<-TR
					<tr class='input-#{valbinary}'>
						<td class='input-radio'>
							<input
								type='radio'
								value='#{valbinary}'
								id="add_participant_checked_#{column.to_htmlID}_#{valbinary}"
								name="add_participant_checked_#{CGI.escapeHTML(column.to_s)}"
								aria-label="#{CGI.escapeHTML(column.to_s)}: #{valtext}"
								title="#{CGI.escapeHTML(column.to_s)}: #{valhuman}" #{checked[column] == valbinary ? "checked='checked'" : ''}
							/>
							<label for="add_participant_checked_#{column.to_htmlID}_#{valbinary}"><span class="visually-hidden">#{valtext}</span><span aria-hidden="true">#{valhuman}</span></label>
						</td>
					</tr>
					TR
				else
					ret += <<-TR
				<tr class='input-#{valbinary}'>
					<td class='input-radio'>
						<input
							type='radio'
							value='#{valbinary}'
							id="add_participant_checked_#{column.to_htmlID}_#{valbinary}"
							name="add_participant_checked_#{CGI.escapeHTML(column.to_s)}"
							aria-label="#{CGI.escapeHTML(column.to_s)}: #{valtext}"
							title="#{CGI.escapeHTML(column.to_s)}: #{valhuman}" #{checked[column] == valbinary ? "checked='checked'" : ''}
						/>
						<label for="add_participant_checked_#{column.to_htmlID}_#{valbinary}"><span class="visually-hidden">#{valtext}</span><span aria-hidden="true">#{valhuman}</span></label>
					</td>
				</tr>
					TR
				end
			}
			ret += '</table></td>'
		}
		ret += save_input(edituser, _('Save'))

		ret += "</tr>\n"

		ret
	end

	def comment_to_html(editable = true)
		ret = "<div id='comments'>"
		ret	+= '<h2>' + _('Comments') if !@comment.empty? || editable
		if $cgi.include?('comments_reverse')
			ret += "<a class='comment_sort' href='?'><span class='visually-hidden'>" + ' ' + _('Sort oldest comment first')
			ret += "</span><span aria-hidden='true'>#{REVERSESORT}</a>"
		else
			ret += "<a class='comment_sort' href='?comments_reverse'><span class='visually-hidden'>" + ' ' + _('Sort newest comment first')
			ret	+= "</span><span aria-hidden='true'>#{SORT}</span></a>"
		end

		if @comment.size > 5
			ret += "<a class='top_bottom_ref' href='#comment#{@comment.size - 1}'><span class='visually-hidden'>" + ' ' + _('Go to last comment')
			ret += "</span><span aria-hidden='true'>#{GODOWN}</span></a>"
		end

		ret	+= '</h2>' if !@comment.empty? || editable

		unless @comment.empty?
			i = 0 # for commentanchor
			c = @comment.dup
			c.reverse! if $cgi.include?('comments_reverse')
			c.each { |time, name, comment|
				ret += "<form method='post' action='.'>"
				ret += "<div class='textcolumn'><h3 class='comment' id='comment#{i}'>"
				i += 1
				ret += format(_('%<user>s said on %<time>s'), user: name, time: time.strftime('%d.%m., %H:%M'))
				if editable
					ret += "<input type='hidden' name='delete_comment' value='#{time.strftime('%s')}' />"
					ret += '&nbsp;'
					ret += "<input class='delete_comment_button' type='submit' value='"
					ret += _('Delete')
					ret += "' />"
				end
				ret += "</h3>#{comment}</div>"
				ret += '</form>'
			}
		end

		if @comment.size > 5
			ret += "<a class='top_bottom_ref'  href='#top' title='" + _('Go up') + "'><span class='visually-hidden'>" + _('Go up')
			ret += + "</span><span aria-hidden='true'>#{GOUP}</span></a>"
		end

		if editable
			# ADD COMMENT
			saysstr = _('says')
			submitstr = _('Submit comment')
			commentnamestr = _('Your name')
			ret += <<ADDCOMMENT
<form method='post' action='.' accept-charset='utf-8' id='newcomment'>
	<div class='comment' id='add_comment'>
	<label for='commentname'>#{commentnamestr}:</label>
		<input
			value="#{CGI.escapeHTML($cgi.cookies['username'][0] || 'Anonymous')}"
			type='text'
			id='commentname'
			name='commentname'
			size='9'
			aria-label='#{CGI.escapeHTML(_('Enter your name'))}'
			title='#{CGI.escapeHTML(_('Enter your name'))}'/> #{saysstr}&nbsp;
		<br />
		<textarea
			cols='50'
			rows='7'
			name='comment'
			aria-label='#{CGI.escapeHTML(_('Enter a comment'))}'
			></textarea>
		<br /><input type='submit' value='#{submitstr}' />
	</div>
</form>
ADDCOMMENT
		end

		ret += "</div>\n"
		ret
	end

	def history_selectform(revision, selected)
		showhiststr = _('Show history items:')
		ret = <<FORM
<form method='get' action=''>
	<div>
	<label class='label' for='history'>#{showhiststr}</label>
		<select name='history' id='history'>
FORM
		[['', _('All')],
	  ['participants', _('Participant related')],
	  ['columns', _('Column related')],
	  ['comments', _('Comment related')],
	  ['ac', _('Access control related')]].each { |value, opt|
		 ret += "<option value='#{value}' #{selected == value ? "selected='selected'" : ''} >#{opt}</option>"
	 }
	 ret += '</select>'
	 ret += "<input type='hidden' name='revision' value=\"#{revision}\" />" if revision
	 updatestr = _('Update')
	 ret += <<FORM
		<input type='submit' value='#{updatestr}' />
	</div>
</form>
FORM
	 ret
	end

	def history_to_html(middlerevision, only)
		log = VCS.history
		if only != ''
			case only
			when 'comments'
				match = /^Comment .*$/
			when 'participants'
				match = /^Participant .*$/
			when 'columns'
				match = /^Column .*$/
			when 'ac'
				match = /^Access Control .*$/
			end
			log = log.comment_matches(match)
		end
		log.around_rev(middlerevision, 11).to_html(middlerevision, only)
	end

	def add_participant(olduser, name, agreed)
		name.strip!
		if name == ''
			maximum = @data.keys.collect { |e| e.scan(/^Anonymous #(\d*)/).flatten[0] }.compact.collect { |i| i.to_i }.max
			maximum ||= 0
			name = "Anonymous ##{maximum + 1}"
		end
		action = ''
		if @data.delete(olduser)
			action = 'edited'
		else
			action = 'added'
		end
		@data[name] = { 'timestamp' => Time.now }
		@head.columns.each { |column|
			@data[name][column] = agreed[column.to_s]
		}
		store "Participant #{name.strip} #{action}"
	end

	def delete(name)
		return unless @data.has_key?(name)

		@data.delete(name)
		store "Participant #{name.strip} deleted"
	end

	def store(comment)
		lockfile = 'data.yaml.lock'

		File.open(lockfile, 'w') { |lock|
			if lock.flock(File::LOCK_EX)
				File.open('data.yaml', 'w') { |out|
					out << "# This is a dudle poll file\n"
					out << to_yaml
					out.chmod(0o660)
				}
				VCS.commit(comment)

				lock.flock(File::LOCK_UN)
			end
		}
	end

	###############################
	# comment related functions
	###############################
	def add_comment(name, comment)
		@comment << [Time.now, CGI.escapeHTML(name.strip), CGI.escapeHTML(comment.strip).gsub("\r\n", '<br />')]
		store "Comment added by #{name}"
	end

	def delete_comment(deltime)
		@comment.each_with_index { |c, i|
			if c[0].strftime('%s') == deltime
				store "Comment from #{@comment.delete_at(i)[1]} deleted"
			end
		}
	end

	###############################
	# column related functions
	###############################
	def delete_column(column)
		return false unless @head.delete_column(column)

		store "Column #{column} deleted"
		true
	end

	def edit_column(oldcolumn, newtitle, cgi)
		parsedtitle = @head.edit_column(oldcolumn, newtitle, cgi)
		store "Column #{parsedtitle} #{oldcolumn == '' ? 'added' : 'edited'}" if parsedtitle
	end

	def edit_column_htmlform(activecolumn, revision)
		@head.edit_column_htmlform(activecolumn, revision)
	end
end

if __FILE__ == $0
	require 'test/unit'
	require 'cgi'
	require 'pp'

	SITE = 'glvhc_8nuv_8fchi09bb12a-23_uvc'
	class Poll
		attr_accessor :head, :data, :comment

		def store(comment); end
	end
	# ┌───────────────────┬─────────────────────────────────┬────────────┐
	# │                   │            May 2009             │            │
	# ├───────────────────┼────────┬────────────────────────┼────────────┤
	# │                   │Tue, 05 │        Sat, 23         │            │
	# ├───────────────────┼────────┼────────┬────────┬──────┼────────────┤
	# │      Name ▾▴      │   ▾▴   │10:00 ▾▴│11:00 ▾▴│foo ▾▴│Last edit ▾▴│
	# ├───────────────────┼────────┼────────┼────────┼──────┼────────────┤
	# │Alice ^✍           │✔       │✘       │✔       │✘     │24.11, 18:15│
	# ├───────────────────┼────────┼────────┼────────┼──────┼────────────┤
	# │Bob ^✍             │✔       │✔       │✘       │?     │24.11, 18:15│
	# ├───────────────────┼────────┼────────┼────────┼──────┼────────────┤
	# │Dave ^✍            │✘       │?       │✔       │✔     │24.11, 18:16│
	# ├───────────────────┼────────┼────────┼────────┼──────┼────────────┤
	# │Carol ^✍           │✔       │✔       │?       │✘     │24.11, 18:16│
	# ├───────────────────┼────────┼────────┼────────┼──────┼────────────┤
	# │total              │3       │2       │2       │1     │            │
	# └───────────────────┴────────┴────────┴────────┴──────┴────────────┘

	class PollTest < Test::Unit::TestCase
		Y = Poll::YESVAL
		N = Poll::NOVAL
		M = Poll::MAYBEVAL
		A = 'Alice'
		B = 'Bob'
		C = 'Carol'
		D = 'Dave'
		Q = '2009-05-05'
		W = '2009-05-23 10:00'
		E = '2009-05-23 11:00'
		R = '2009-05-23 foo'
		def setup
			def add_participant(type, user, votearray)
				h = { Q => votearray[0], W => votearray[1], E => votearray[2], R => votearray[3] }
				@polls[type].add_participant('', user, h)
			end

			@polls = {}
			%w[time normal].each { |type|
				@polls[type] = Poll.new(SITE, type)

				@polls[type].edit_column('', '2009-05-05', { 'columndescription' => '' })
				2.times { |t|
					@polls[type].edit_column('', "2009-05-23 #{t + 10}:00", { 'columntime' => "#{t + 10}:00", 'columndescription' => '' })
				}
				@polls[type].edit_column('', '2009-05-23 foo', { 'columntime' => 'foo', 'columndescription' => '' })

				add_participant(type, A, [Y, N, Y, N])
				add_participant(type, B, [Y, Y, N, M])
				add_participant(type, D, [N, M, Y, Y])
				add_participant(type, C, [Y, Y, M, N])
			}
		end

		def test_sort
			%w[time normal].each { |type|
				comment = "Test Type: #{type}"
				assert_equal([A, B, C, D], @polls[type].sort_data(['name']).collect { |a| a[0] }, comment)
				assert_equal([A, B, D, C], @polls[type].sort_data(['timestamp']).collect { |a| a[0] }, comment)
				assert_equal([B, C, D, A], @polls[type].sort_data([W, 'name']).collect { |a| a[0] }, comment)
				assert_equal([B, A, C, D], @polls[type].sort_data([Q, R, E]).collect { |a| a[0] }, comment + ' ' + [Q, R, E].join('; '))
			}
		end
	end

	class StringTest < Test::Unit::TestCase
		def test_htmlid
			assert_equal('foo.bar.',   'foo bar '.to_htmlID)
			assert_equal('foo.bar.',   'foo bar '.to_htmlID)
			assert_equal('foo.bar.0',  'foo.bar '.to_htmlID)
			assert_equal('foo.bar.00', 'foo.bar 0'.to_htmlID)
			assert_equal('foo.bar.',   'foo bar '.to_htmlID)
			assert_equal('foo.bar.1',  'foo bar.'.to_htmlID)
			assert_equal('foo.bar.2',  'foo?bar.'.to_htmlID)
			assert_equal('foo.bar.3',  'foo bar?'.to_htmlID)
			assert_equal('foo.bar.2',  'foo?bar.'.to_htmlID)
		end
	end
end