Merge remote-tracking branch 'origin/Mario/extralife_fix'
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / command / vote.qc
1 // =============================================
2 //  Server side voting code, reworked by Samual
3 //  Last updated: December 27th, 2011
4 // =============================================
5
6 //  Nagger for players to know status of voting
7 float Nagger_SendEntity(entity to, float sendflags)
8 {
9         float nags, i, f, b;
10         entity e;
11         WriteByte(MSG_ENTITY, ENT_CLIENT_NAGGER);
12
13         // bits:
14         //   1 = ready
15         //   2 = player needs to ready up
16         //   4 = vote
17         //   8 = player needs to vote
18         //  16 = warmup
19         // sendflags:
20         //  64 = vote counts
21         // 128 = vote string
22
23         nags = 0;
24         if(readycount)
25         {
26                 nags |= 1;
27                 if(to.ready == 0)
28                         nags |= 2;
29         }
30         if(vote_called)
31         {
32                 nags |= 4;
33                 if(to.vote_selection == 0)
34                         nags |= 8;
35         }
36         if(inWarmupStage)
37                 nags |= 16;
38
39         if(sendflags & 64)
40                 nags |= 64;
41
42         if(sendflags & 128)
43                 nags |= 128;
44
45         if(!(nags & 4)) // no vote called? send no string
46                 nags &~= (64 | 128);
47
48         WriteByte(MSG_ENTITY, nags);
49
50         if(nags & 64)
51         {
52                 WriteByte(MSG_ENTITY, vote_accept_count);
53                 WriteByte(MSG_ENTITY, vote_reject_count);
54                 WriteByte(MSG_ENTITY, vote_needed_overall);
55                 WriteChar(MSG_ENTITY, to.vote_selection);
56         }
57
58         if(nags & 128)
59                 WriteString(MSG_ENTITY, vote_called_display);
60
61         if(nags & 1)
62         {
63                 for(i = 1; i <= maxclients; i += 8)
64                 {
65                         for(f = 0, e = edict_num(i), b = 1; b < 256; b *= 2, e = nextent(e))
66                                 if(!IS_REAL_CLIENT(e) || e.ready)
67                                         f |= b;
68                         WriteByte(MSG_ENTITY, f);
69                 }
70         }
71
72         return TRUE;
73 }
74
75 void Nagger_Init()
76 {
77         Net_LinkEntity(nagger = spawn(), FALSE, 0, Nagger_SendEntity);
78 }
79
80 void Nagger_VoteChanged()
81 {
82         if(nagger)
83                 nagger.SendFlags |= 128;
84 }
85
86 void Nagger_VoteCountChanged()
87 {
88         if(nagger)
89                 nagger.SendFlags |= 64;
90 }
91
92 void Nagger_ReadyCounted()
93 {
94         if(nagger)
95                 nagger.SendFlags |= 1;
96 }
97
98
99 // =======================
100 //  Game logic for voting
101 // =======================
102
103 void VoteReset() 
104 {
105         entity tmp_player;
106
107         FOR_EACH_CLIENT(tmp_player) { tmp_player.vote_selection = 0; }
108
109         if(vote_called)
110         {
111                 strunzone(vote_called_command);
112                 strunzone(vote_called_display);
113         }
114
115         vote_called = VOTE_NULL;
116         vote_caller = world;
117         vote_endtime = 0;
118         
119         vote_called_command = string_null;
120         vote_called_display = string_null;
121         
122         vote_parsed_command = string_null;
123         vote_parsed_display = string_null;
124
125         Nagger_VoteChanged();
126 }
127
128 void VoteStop(entity stopper) 
129 {
130         bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", GetCallerName(vote_caller), "^2's vote\n");
131         if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid))); }
132         
133         // Don't force them to wait for next vote, this way they can e.g. correct their vote.
134         if((vote_caller) && (stopper == vote_caller)) { vote_caller.vote_waittime = time + autocvar_sv_vote_stop; }
135
136         VoteReset();
137 }
138
139 void VoteAccept() 
140 {
141         bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
142         
143         if((vote_called == VOTE_MASTER) && vote_caller)
144                 vote_caller.vote_master = 1;
145         else
146                 localcmd(strcat(vote_called_command, "\n"));
147         
148         if(vote_caller) { vote_caller.vote_waittime = 0; } // people like your votes, you don't need to wait to vote again
149
150         VoteReset();
151         Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_ACCEPT);
152 }
153
154 void VoteReject() 
155 {
156         bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2's vote for ", vote_called_display, "^2 was rejected\n");
157         VoteReset();
158         Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_FAIL);
159 }
160
161 void VoteTimeout() 
162 {
163         bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2's vote for ", vote_called_display, "^2 timed out\n");
164         VoteReset();
165         Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_FAIL);
166 }
167
168 void VoteSpam(float notvoters, float mincount, string result)
169 {
170         bprint(strcat(
171                 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
172                 strcat("^2:^1", ftos(vote_reject_count)),
173                 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
174                 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
175                 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? "" : "have to "), "vote\n"))));
176         
177         if(autocvar_sv_eventlog)
178         {
179                 GameLogEcho(strcat(
180                         strcat(":vote:v", result, ":", ftos(vote_accept_count)),
181                         strcat(":", ftos(vote_reject_count)),
182                         strcat(":", ftos(vote_abstain_count)),
183                         strcat(":", ftos(notvoters)),
184                         strcat(":", ftos(mincount))));
185         }
186 }
187
188 void VoteCount(float first_count) 
189 {
190         // declarations
191         vote_accept_count = vote_reject_count = vote_abstain_count = 0;
192         
193         float spectators_allowed = ((autocvar_sv_vote_nospectators != 2) 
194                                 || ((autocvar_sv_vote_nospectators == 1) && (inWarmupStage || gameover))
195                                 || (autocvar_sv_vote_nospectators == 0));
196                                 
197         float vote_player_count = 0, notvoters = 0;
198         float vote_real_player_count = 0, vote_real_accept_count = 0;
199         float vote_real_reject_count = 0, vote_real_abstain_count = 0;
200         float vote_needed_of_voted, final_needed_votes;
201         float vote_factor_overall, vote_factor_of_voted;
202         
203         entity tmp_player;
204
205         Nagger_VoteCountChanged();
206         
207         // add up all the votes from each connected client
208         FOR_EACH_REALCLIENT(tmp_player)
209         {
210                 ++vote_player_count;
211                 if(IS_PLAYER(tmp_player)) { ++vote_real_player_count; }
212                 
213                 switch(tmp_player.vote_selection)
214                 {
215                         case VOTE_SELECT_REJECT: { ++vote_reject_count; { if(IS_PLAYER(tmp_player)) ++vote_real_reject_count; } break; }
216                         case VOTE_SELECT_ACCEPT: { ++vote_accept_count; { if(IS_PLAYER(tmp_player)) ++vote_real_reject_count; } break; }
217                         case VOTE_SELECT_ABSTAIN: { ++vote_abstain_count; { if(IS_PLAYER(tmp_player)) ++vote_real_abstain_count; } break; }
218                         default: break;
219                 }
220         }
221         
222         // Check to see if there are enough players on the server to allow master voting... otherwise, vote master could be used for evil.
223         if((vote_called == VOTE_MASTER) && autocvar_sv_vote_master_playerlimit > vote_player_count) 
224         {
225                 if(vote_caller) { vote_caller.vote_waittime = 0; }
226                 print_to(vote_caller, "^1There are not enough players on this server to allow you to become vote master.");
227                 VoteReset();
228                 return;
229         }
230         
231         // if spectators aren't allowed to vote and there are players in a match, then only count the players in the vote and ignore spectators. 
232         if(!spectators_allowed && (vote_real_player_count > 0))
233         {
234                 vote_accept_count = vote_real_accept_count;
235                 vote_reject_count = vote_real_reject_count;
236                 vote_abstain_count = vote_real_abstain_count;
237                 vote_player_count = vote_real_player_count;
238         }
239         
240         // people who have no opinion in any way :D
241         notvoters = (vote_player_count - vote_accept_count - vote_reject_count - vote_abstain_count);
242
243         // determine the goal for the vote to be passed or rejected normally
244         vote_factor_overall = bound(0.5, autocvar_sv_vote_majority_factor, 0.999);
245         vote_needed_overall = floor((vote_player_count - vote_abstain_count) * vote_factor_overall) + 1;
246         
247         // if the vote times out, determine the amount of votes needed of the people who actually already voted
248         vote_factor_of_voted = bound(0.5, autocvar_sv_vote_majority_factor_of_voted, 0.999);
249         vote_needed_of_voted = floor((vote_accept_count + vote_reject_count) * vote_factor_of_voted) + 1;
250         
251         // are there any players at all on the server? it could be an admin vote
252         if(vote_player_count == 0 && first_count)
253         {
254                 VoteSpam(0, -1, "yes"); // no players at all, just accept it 
255                 VoteAccept();
256                 return;
257         }
258         
259         // since there ARE players, finally calculate the result of the vote    
260         if(vote_accept_count >= vote_needed_overall)
261         {
262                 VoteSpam(notvoters, -1, "yes"); // there is enough acceptions to pass the vote
263                 VoteAccept();
264                 return;
265         }
266         
267         if(vote_reject_count > vote_player_count - vote_abstain_count - vote_needed_overall)
268         {
269                 VoteSpam(notvoters, -1, "no"); // there is enough rejections to deny the vote
270                 VoteReject();
271                 return;
272         }
273         
274         // there is not enough votes in either direction, now lets just calculate what the voters have said
275         if(time > vote_endtime)
276         {
277                 final_needed_votes = vote_needed_overall;
278                 
279                 if(autocvar_sv_vote_majority_factor_of_voted)
280                 {
281                         if(vote_accept_count >= vote_needed_of_voted)
282                         {
283                                 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "yes");
284                                 VoteAccept();
285                                 return;
286                         }
287                         
288                         if(vote_accept_count + vote_reject_count > 0)
289                         {
290                                 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "no");
291                                 VoteReject();
292                                 return;
293                         }
294                         
295                         final_needed_votes = min(vote_needed_overall, vote_needed_of_voted);
296                 }
297
298                 // it didn't pass or fail, so not enough votes to even make a decision. 
299                 VoteSpam(notvoters, final_needed_votes, "timeout");
300                 VoteTimeout();
301         }
302 }
303
304 void VoteThink() 
305 {
306         if(vote_endtime > 0) // a vote was called
307         if(time > vote_endtime) // time is up
308         {
309                 VoteCount(FALSE);
310         }
311         
312         return;
313 }
314
315
316 // =======================
317 //  Game logic for warmup
318 // =======================
319
320 // Resets the state of all clients, items, weapons, waypoints, ... of the map.
321 void reset_map(float dorespawn)
322 {
323         entity oldself;
324         oldself = self;
325
326         if(time <= game_starttime && round_handler_IsActive())
327                 round_handler_Reset(game_starttime);
328
329         if(g_race || g_cts)
330                 race_ReadyRestart();
331         else MUTATOR_CALLHOOK(reset_map_global);
332
333         for(self = world; (self = nextent(self)); )
334         if(IS_NOT_A_CLIENT(self))
335         {
336                 if(self.reset)
337                 {
338                         self.reset();
339                         continue;
340                 }
341
342                 if(self.team_saved)
343                         self.team = self.team_saved;
344
345                 if(self.flags & FL_PROJECTILE) // remove any projectiles left
346                         remove(self);
347         }
348
349         // Waypoints and assault start come LAST
350         for(self = world; (self = nextent(self)); )
351         if(IS_NOT_A_CLIENT(self))
352         {
353                 if(self.reset2)
354                 {
355                         self.reset2();
356                         continue;
357                 }
358         }
359
360         // Moving the player reset code here since the player-reset depends
361         // on spawnpoint entities which have to be reset first --blub
362         if(dorespawn)
363         if(!MUTATOR_CALLHOOK(reset_map_players))
364         FOR_EACH_CLIENT(self) // reset all players
365         {
366                 /*
367                 only reset players if a restart countdown is active
368                 this can either be due to cvar sv_ready_restart_after_countdown having set
369                 restart_mapalreadyrestarted to 1 after the countdown ended or when
370                 sv_ready_restart_after_countdown is not used and countdown is still running
371                 */
372                 if (restart_mapalreadyrestarted || (time < game_starttime))
373                 {
374                         //NEW: changed behaviour so that it prevents that previous spectators/observers suddenly spawn as players
375                         if (IS_PLAYER(self)) {
376                                 //PlayerScore_Clear(self);
377                                 self.killcount = 0;
378                                 //stop the player from moving so that he stands still once he gets respawned
379                                 self.velocity = '0 0 0';
380                                 self.avelocity = '0 0 0';
381                                 self.movement = '0 0 0';
382                                 PutClientInServer();
383                         }
384                 }
385         }
386
387         if(g_keyhunt)
388                 kh_Controller_SetThink(autocvar_g_balance_keyhunt_delay_round + (game_starttime - time), kh_StartRound);
389
390         self = oldself;
391 }
392
393 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
394 void ReadyRestart_think() 
395 {
396         restart_mapalreadyrestarted = 1;
397         reset_map(TRUE);
398         Score_ClearAll();
399         remove(self);
400         
401         return;
402 }
403
404 // Forces a restart of the game without actually reloading the map // this is a mess...
405 void ReadyRestart_force()
406 {
407         entity tmp_player, restart_timer;
408
409         bprint("^1Server is restarting...\n");
410
411         VoteReset();
412
413         // clear overtime, we have to decrease timelimit to its original value again.
414         if (checkrules_overtimesadded > 0 && g_race_qualifying != 2) { cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime))); }
415
416         checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
417
418         readyrestart_happened = 1;
419         game_starttime = time + RESTART_COUNTDOWN;
420
421         // clear player attributes
422         FOR_EACH_CLIENT(tmp_player)
423         {
424                 tmp_player.alivetime = 0;
425                 tmp_player.killcount = 0;
426                 PlayerStats_Event(tmp_player, PLAYERSTATS_ALIVETIME, -PlayerStats_Event(tmp_player, PLAYERSTATS_ALIVETIME, 0));
427         }
428
429         restart_mapalreadyrestarted = 0; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
430
431         // disable the warmup global for the server
432         inWarmupStage = 0; // once the game is restarted the game is in match stage
433
434         // reset the .ready status of all players (also spectators)
435         FOR_EACH_REALCLIENT(tmp_player) { tmp_player.ready = 0; }
436         readycount = 0;
437         Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
438
439         // lock teams with lockonrestart
440         if(autocvar_teamplay_lockonrestart && teamplay)
441         {
442                 lockteams = 1;
443                 bprint("^1The teams are now locked.\n");
444         }
445
446         //initiate the restart-countdown-announcer entity
447         if(autocvar_sv_ready_restart_after_countdown)
448         {
449                 restart_timer = spawn();
450                 restart_timer.think = ReadyRestart_think;
451                 restart_timer.nextthink = game_starttime;
452         }
453
454         // after a restart every players number of allowed timeouts gets reset, too
455         if(autocvar_sv_timeout) { FOR_EACH_REALPLAYER(tmp_player) { tmp_player.allowed_timeouts = autocvar_sv_timeout_number; } }
456
457         //reset map immediately if this cvar is not set
458         if not(autocvar_sv_ready_restart_after_countdown) { reset_map(TRUE); }
459
460         if(autocvar_sv_eventlog) { GameLogEcho(":restart"); }
461 }
462
463 void ReadyRestart()
464 {
465         // no arena, assault support yet...
466         if(g_arena | g_assault | gameover | intermission_running | race_completing)
467                 localcmd("restart\n");
468         else
469                 localcmd("\nsv_hook_gamerestart\n");
470
471         // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
472         // Otherwise scores could be manipulated during the countdown.
473         if not(autocvar_sv_ready_restart_after_countdown) { Score_ClearAll(); }
474
475         ReadyRestart_force();
476         
477         return;
478 }
479
480 // Count the players who are ready and determine whether or not to restart the match
481 void ReadyCount()
482 {
483         entity tmp_player;
484         float ready_needed_factor, ready_needed_count;
485         float t_ready = 0, t_players = 0;
486
487         FOR_EACH_REALCLIENT(tmp_player)
488         {
489                 if(IS_PLAYER(tmp_player) || tmp_player.caplayer == 1)
490                 {
491                         ++t_players;
492                         if(tmp_player.ready) { ++t_ready; }
493                 }
494         }
495
496         readycount = t_ready;
497
498         Nagger_ReadyCounted();
499
500         ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
501         ready_needed_count = floor(t_players * ready_needed_factor) + 1;
502         
503         if(readycount >= ready_needed_count)
504         {
505                 ReadyRestart();
506         }
507                 
508         return;
509 }
510
511
512 // ======================================
513 //  Supporting functions for VoteCommand
514 // ======================================
515
516 float Votecommand_check_assignment(entity caller, float assignment)
517 {
518         float from_server = (!caller);
519         
520         if((assignment == VC_ASGNMNT_BOTH) 
521                 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY) 
522                 || (from_server && assignment == VC_ASGNMNT_SERVERONLY)))
523         {
524                 return TRUE;
525         }
526
527         return FALSE;
528 }
529
530 string VoteCommand_extractcommand(string input, float startpos, float argc) 
531 {
532         string output;
533         
534         if((argc - 1) < startpos)
535                 output = "";
536         else
537                 output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
538                 
539         return output;
540 }
541
542 float VoteCommand_checknasty(string vote_command)
543 {
544         if((strstrofs(vote_command, ";", 0) >= 0)
545                 || (strstrofs(vote_command, "\n", 0) >= 0)
546                 || (strstrofs(vote_command, "\r", 0) >= 0)
547                 || (strstrofs(vote_command, "$", 0) >= 0))
548                 return FALSE;
549                 
550         return TRUE;
551 }
552
553 float VoteCommand_checkinlist(string vote_command, string list)
554 {
555         string l = strcat(" ", list, " ");
556         
557         if(strstrofs(l, strcat(" ", vote_command, " "), 0) >= 0)
558                 return TRUE;
559         
560         return FALSE;
561 }
562
563 string ValidateMap(string validated_map, entity caller)
564 {
565         validated_map = MapInfo_FixName(validated_map);
566         
567         if not(validated_map)
568         {
569                 print_to(caller, "This map is not available on this server.");
570                 return string_null;
571         }
572         
573         if(!autocvar_sv_vote_override_mostrecent && caller)
574         {
575                 if(Map_IsRecent(validated_map))
576                 {
577                         print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
578                         return string_null;
579                 }
580         }
581         
582         if(!MapInfo_CheckMap(validated_map))
583         {
584                 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
585                 return string_null;
586         }
587
588         return validated_map;
589 }
590
591 float VoteCommand_checkargs(float startpos, float argc)
592 {
593         float p, q, check, minargs;
594         string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
595         string cmdrestriction = cvar_string(cvarname); // note: this warns on undefined cvar. We want that.
596         string charlist, arg;
597         float checkmate;
598
599         if(cmdrestriction == "")
600                 return TRUE;
601
602         ++startpos; // skip command name
603
604         // check minimum arg count
605
606         // 0 args: argc == startpos
607         // 1 args: argc == startpos + 1
608         // ...
609
610         minargs = stof(cmdrestriction);
611         if(argc - startpos < minargs)
612                 return FALSE;
613
614         p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
615
616         for(;;)
617         {
618                 // we know that at any time, startpos <= argc - minargs
619                 // so this means: argc-minargs >= startpos >= argc, thus
620                 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
621                 // have been seen already
622
623                 if(startpos >= argc) // all args checked? GOOD
624                         break;
625
626                 if(p < 0) // no more args? FAIL
627                 {
628                         // exception: exactly minargs left, this one included
629                         if(argc - startpos == minargs)
630                                 break;
631
632                         // otherwise fail
633                         return FALSE;
634                 }
635
636                 // cut to next semicolon
637                 q = strstrofs(cmdrestriction, ";", p+1); // find next semicolon
638                 if(q < 0)
639                         charlist = substring(cmdrestriction, p+1, -1);
640                 else
641                         charlist = substring(cmdrestriction, p+1, q - (p+1));
642
643                 // in case we ever want to allow semicolons in VoteCommand_checknasty
644                 // charlist = strreplace("^^", ";", charlist);
645
646                 if(charlist != "")
647                 {
648                         // verify the arg only contains allowed chars
649                         arg = argv(startpos);
650                         checkmate = strlen(arg);
651                         for(check = 0; check < checkmate; ++check)
652                                 if(strstrofs(charlist, substring(arg, check, 1), 0) < 0)
653                                         return FALSE; // not allowed character
654                         // all characters are allowed. FINE.
655                 }
656
657                 ++startpos;
658                 --minargs;
659                 p = q;
660         }
661
662         return TRUE;
663 }
664
665 float VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, float argc)
666 {
667         string first_command;
668         
669         first_command = argv(startpos);
670
671         if not(VoteCommand_checkinlist(first_command, vote_list))
672                 return FALSE;
673
674         if not(VoteCommand_checkargs(startpos, argc))
675                 return FALSE;
676
677         switch(first_command) // now go through and parse the proper commands to adjust as needed.
678         {
679                 case "kick":
680                 case "kickban": // catch all kick/kickban commands
681                 {
682                         entity victim = GetIndexedEntity(argc, (startpos + 1));
683                         float accepted = VerifyClientEntity(victim, TRUE, FALSE);
684                         
685                         if(accepted > 0)
686                         {
687                                 string reason = ((argc > next_token) ? substring(vote_command, argv_start_index(next_token), strlen(vote_command) - argv_start_index(next_token)) : "No reason provided");
688                                 string command_arguments;
689                                 
690                                 if(first_command == "kickban")
691                                         command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
692                                 else
693                                         command_arguments = reason;
694                                 
695                                 vote_parsed_command = strcat(first_command, " # ", ftos(num_for_edict(victim)), " ", command_arguments);
696                                 vote_parsed_display = strcat("^1", vote_command, " (^7", victim.netname, "^1): ", reason);
697                         }
698                         else { print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n")); return FALSE; }
699                         
700                         break;
701                 }
702                 
703                 case "map":
704                 case "chmap":
705                 case "gotomap": // re-direct all map selection commands to gotomap
706                 {
707                         vote_command = ValidateMap(argv(startpos + 1), caller);
708                         if not(vote_command) { return FALSE; }
709                         vote_parsed_command = strcat("gotomap ", vote_command);
710                         vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
711                         
712                         break;
713                 }
714                 
715                 default: 
716                 { 
717                         vote_parsed_command = vote_command;
718                         vote_parsed_display = strzone(strcat("^1", vote_command));
719                         
720                         break; 
721                 }
722         }
723
724         return TRUE;
725 }
726
727
728 // =======================
729 //  Command Sub-Functions
730 // =======================
731
732 void VoteCommand_abstain(float request, entity caller) // CLIENT ONLY
733 {
734         switch(request)
735         {
736                 case CMD_REQUEST_COMMAND:
737                 {
738                         if not(vote_called) { print_to(caller, "^1No vote called."); }
739                         else if not(caller.vote_selection == VOTE_SELECT_NULL || autocvar_sv_vote_change) { print_to(caller, "^1You have already voted."); }
740                         
741                         else // everything went okay, continue changing vote
742                         {
743                                 print_to(caller, "^1You abstained from your vote.");
744                                 caller.vote_selection = VOTE_SELECT_ABSTAIN;
745                                 msg_entity = caller;
746                                 if(!autocvar_sv_vote_singlecount) { VoteCount(FALSE); }
747                         }
748                         
749                         return;
750                 }
751                         
752                 default:
753                 case CMD_REQUEST_USAGE:
754                 {
755                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
756                         print_to(caller, "  No arguments required.");
757                         return;
758                 }
759         }
760 }
761
762 void VoteCommand_call(float request, entity caller, float argc, string vote_command) // BOTH
763 {
764         switch(request)
765         {
766                 case CMD_REQUEST_COMMAND:
767                 {
768                         float spectators_allowed = ((autocvar_sv_vote_nospectators != 2) 
769                                 || ((autocvar_sv_vote_nospectators == 1) && inWarmupStage) 
770                                 || (autocvar_sv_vote_nospectators == 0));
771                                 
772                         float tmp_playercount = 0;
773                         entity tmp_player;
774                         
775                         vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
776                         
777                         if not(autocvar_sv_vote_call || !caller) { print_to(caller, "^1Vote calling is not allowed."); }
778                         else if(!autocvar_sv_vote_gamestart && time < game_starttime) { print_to(caller, "^1Vote calling is not allowed before the match has started."); }
779                         else if(vote_called) { print_to(caller, "^1There is already a vote called."); }
780                         else if(!spectators_allowed && (caller && !IS_PLAYER(caller))) { print_to(caller, "^1Only players can call a vote."); }
781                         else if(timeout_status) { print_to(caller, "^1You can not call a vote while a timeout is active."); }
782                         else if(caller && (time < caller.vote_waittime)) { print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote.")); }
783                         else if not(VoteCommand_checknasty(vote_command)) { print_to(caller, "^1Syntax error in command, see 'vhelp' for more info."); }
784                         else if not(VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) { print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info."); }
785
786                         else // everything went okay, continue with calling the vote
787                         {
788                                 vote_caller = caller; // remember who called the vote
789                                 vote_called = VOTE_NORMAL;
790                                 vote_called_command = strzone(vote_parsed_command);
791                                 vote_called_display = strzone(vote_parsed_display);
792                                 vote_endtime = time + autocvar_sv_vote_timeout;
793                                 
794                                 if(caller)
795                                 {
796                                         caller.vote_selection = VOTE_SELECT_ACCEPT;
797                                         caller.vote_waittime = time + autocvar_sv_vote_wait;
798                                         msg_entity = caller;
799                                 }
800                                 
801                                 FOR_EACH_REALCLIENT(tmp_player) { ++tmp_playercount; }
802                                 if(tmp_playercount > 1) { Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_CALL); } // don't announce a "vote now" sound if player is alone
803                                 
804                                 bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2 calls a vote for ", vote_called_display, "\n");
805                                 if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display)); }
806                                 Nagger_VoteChanged();
807                                 VoteCount(TRUE); // needed if you are the only one
808                         }
809                         
810                         return;
811                 }
812                         
813                 default:
814                 case CMD_REQUEST_USAGE:
815                 {
816                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
817                         print_to(caller, "  Where 'command' is the command to request a vote upon.");
818                         print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
819                         print_to(caller, strcat("          ", GetCommandPrefix(caller), " vote call endmatch"));
820                         return;
821                 }
822         }
823 }
824
825 void VoteCommand_master(float request, entity caller, float argc, string vote_command) // CLIENT ONLY
826 {
827         switch(request)
828         {
829                 case CMD_REQUEST_COMMAND:
830                 {
831                         if(autocvar_sv_vote_master)
832                         {
833                                 switch(strtolower(argv(2)))
834                                 {
835                                         case "do":
836                                         {
837                                                 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
838                                                 
839                                                 if not(caller.vote_master) { print_to(caller, "^1You do not have vote master privelages."); }
840                                                 else if not(VoteCommand_checknasty(vote_command)) { print_to(caller, "^1Syntax error in command, see 'vhelp' for more info."); }
841                                                 else if not(VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc)) { print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info."); }
842                                                 
843                                                 else // everything went okay, proceed with command
844                                                 {
845                                                         localcmd(strcat(vote_parsed_command, "\n"));
846                                                         print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
847                                                         bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
848                                                         if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display)); }
849                                                 }
850                                                 
851                                                 return;
852                                         }
853                                         
854                                         case "login":
855                                         {
856                                                 if not(autocvar_sv_vote_master_password != "") { print_to(caller, "^1Login to vote master is not allowed."); }
857                                                 else if(caller.vote_master) { print_to(caller, "^1You are already logged in as vote master."); }
858                                                 else if not(autocvar_sv_vote_master_password == argv(3)) { print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller))); }
859
860                                                 else // everything went okay, proceed with giving this player master privilages
861                                                 {
862                                                         caller.vote_master = TRUE;
863                                                         print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
864                                                         bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
865                                                         if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid))); }
866                                                 }
867                                                 
868                                                 return;
869                                         }
870                                         
871                                         default: // calling a vote for master
872                                         {
873                                                 float spectators_allowed = ((autocvar_sv_vote_nospectators != 2) 
874                                                         || ((autocvar_sv_vote_nospectators == 1) && inWarmupStage) 
875                                                         || (autocvar_sv_vote_nospectators == 0));
876                                                 
877                                                 if not(autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
878                                                 else if(vote_called) { print_to(caller, "^1There is already a vote called."); }
879                                                 else if(!spectators_allowed && (caller && !IS_PLAYER(caller))) { print_to(caller, "^1Only players can call a vote."); }
880                                                 else if(timeout_status) { print_to(caller, "^1You can not call a vote while a timeout is active."); }
881                                                 
882                                                 else // everything went okay, continue with creating vote
883                                                 {
884                                                         vote_caller = caller;
885                                                         vote_called = VOTE_MASTER;
886                                                         vote_called_command = strzone("XXX");
887                                                         vote_called_display = strzone("^3master");
888                                                         vote_endtime = time + autocvar_sv_vote_timeout;
889                                                         
890                                                         caller.vote_selection = VOTE_SELECT_ACCEPT;
891                                                         caller.vote_waittime = time + autocvar_sv_vote_wait;
892                                                         
893                                                         bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2 calls a vote to become ^3master^2.\n");
894                                                         if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display)); }
895                                                         Nagger_VoteChanged();
896                                                         VoteCount(TRUE); // needed if you are the only one
897                                                 }
898                                                 
899                                                 return;
900                                         }
901                                 }
902                         }
903                         else { print_to(caller, "^1Master control of voting is not allowed."); }
904                         
905                         return;
906                 }
907                         
908                 default:
909                 case CMD_REQUEST_USAGE:
910                 {
911                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
912                         print_to(caller, "  If action is left blank, it calls a vote for you to become master.");
913                         print_to(caller, "  Otherwise the actions are either 'do' a command or 'login' as master.");
914                         return;
915                 }
916         }
917 }
918
919 void VoteCommand_no(float request, entity caller) // CLIENT ONLY
920 {
921         switch(request)
922         {
923                 case CMD_REQUEST_COMMAND:
924                 {
925                         if not(vote_called) { print_to(caller, "^1No vote called."); }
926                         else if not(caller.vote_selection == VOTE_SELECT_NULL || autocvar_sv_vote_change) { print_to(caller, "^1You have already voted."); }
927                         else if(((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote) { VoteStop(caller); }
928                         
929                         else // everything went okay, continue changing vote
930                         {
931                                 print_to(caller, "^1You rejected the vote.");
932                                 caller.vote_selection = VOTE_SELECT_REJECT;
933                                 msg_entity = caller;
934                                 if(!autocvar_sv_vote_singlecount) { VoteCount(FALSE); }
935                         }
936                         
937                         return;
938                 }
939                         
940                 default:
941                 case CMD_REQUEST_USAGE:
942                 {
943                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
944                         print_to(caller, "  No arguments required.");
945                         return;
946                 }
947         }
948 }
949
950 void VoteCommand_status(float request, entity caller) // BOTH
951 {
952         switch(request)
953         {
954                 case CMD_REQUEST_COMMAND:
955                 {
956                         if(vote_called)
957                                 print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", GetCallerName(vote_caller), "^7."));
958                         else
959                                 print_to(caller, "^1No vote called.");
960                                 
961                         return;
962                 }
963                         
964                 default:
965                 case CMD_REQUEST_USAGE:
966                 {
967                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
968                         print_to(caller, "  No arguments required.");
969                         return;
970                 }
971         }
972 }
973
974 void VoteCommand_stop(float request, entity caller) // BOTH
975 {
976         switch(request)
977         {
978                 case CMD_REQUEST_COMMAND:
979                 {
980                         if not(vote_called) { print_to(caller, "^1No vote called."); }
981                         else if((caller == vote_caller) || !caller || caller.vote_master) { VoteStop(caller); }
982                         else { print_to(caller, "^1You are not allowed to stop that vote."); }
983                         
984                         return;
985                 }
986                         
987                 default:
988                 case CMD_REQUEST_USAGE:
989                 {
990                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
991                         print_to(caller, "  No arguments required.");
992                         return;
993                 }
994         }
995 }
996
997 void VoteCommand_yes(float request, entity caller) // CLIENT ONLY
998 {
999         switch(request)
1000         {
1001                 case CMD_REQUEST_COMMAND:
1002                 {
1003                         if not(vote_called) { print_to(caller, "^1No vote called."); }
1004                         else if not(caller.vote_selection == VOTE_SELECT_NULL || autocvar_sv_vote_change) { print_to(caller, "^1You have already voted."); }
1005                         
1006                         else // everything went okay, continue changing vote
1007                         {
1008                                 print_to(caller, "^1You accepted the vote.");
1009                                 caller.vote_selection = VOTE_SELECT_ACCEPT;
1010                                 msg_entity = caller;
1011                                 if(!autocvar_sv_vote_singlecount) { VoteCount(FALSE); }
1012                         }
1013                         
1014                         return;
1015                 }
1016                         
1017                 default:
1018                 case CMD_REQUEST_USAGE:
1019                 {
1020                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1021                         print_to(caller, "  No arguments required.");
1022                         return;
1023                 }
1024         }
1025 }
1026
1027 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1028 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1029 void VoteCommand_(float request)
1030 {
1031         switch(request)
1032         {
1033                 case CMD_REQUEST_COMMAND:
1034                 {
1035                         
1036                         return;
1037                 }
1038                         
1039                 default:
1040                 case CMD_REQUEST_USAGE:
1041                 {
1042                         print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1043                         print_to(caller, "  No arguments required.");
1044                         return;
1045                 }
1046         }
1047 }
1048 */
1049
1050
1051 // ================================
1052 //  Macro system for vote commands
1053 // ================================
1054
1055 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1056 #define VOTE_COMMANDS(request,caller,arguments,command) \
1057         VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1058         VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1059         VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1060         VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1061         VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1062         VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1063         VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1064         VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1065         /* nothing */
1066
1067 void VoteCommand_macro_help(entity caller, float argc)
1068 {
1069         string command_origin = GetCommandPrefix(caller);
1070         
1071         if(argc == 2) // help display listing all commands
1072         {
1073                 print_to(caller, "\nVoting commands:\n");
1074                 #define VOTE_COMMAND(name,function,description,assignment) \
1075                         { if(Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat("  ^2", name, "^7: ", description)); } }
1076                         
1077                 VOTE_COMMANDS(0, caller, 0, "")
1078                 #undef VOTE_COMMAND
1079                 
1080                 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are listed above.\n"));
1081                 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help COMMAND"));
1082                 print_to(caller, strcat("\n^7You can call a vote for or execute these commands: ^3", autocvar_sv_vote_commands, "^7 and maybe further ^3arguments^7"));
1083         }
1084         else // usage for individual command
1085         {
1086                 #define VOTE_COMMAND(name,function,description,assignment) \
1087                         { if(Votecommand_check_assignment(caller, assignment)) { if(name == strtolower(argv(2))) { function; return; } } }
1088                         
1089                 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "")
1090                 #undef VOTE_COMMAND
1091         }
1092         
1093         return;
1094 }
1095
1096 float VoteCommand_macro_command(entity caller, float argc, string vote_command)
1097 {
1098         #define VOTE_COMMAND(name,function,description,assignment) \
1099                 { if(Votecommand_check_assignment(caller, assignment)) { if(name == strtolower(argv(1))) { function; return TRUE; } } }
1100                 
1101         VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command)
1102         #undef VOTE_COMMAND
1103         
1104         return FALSE;
1105 }
1106
1107
1108 // ======================================
1109 //  Main function handling vote commands
1110 // ======================================
1111
1112 void VoteCommand(float request, entity caller, float argc, string vote_command) 
1113 {
1114         // Guide for working with argc arguments by example:
1115         // argc:   1    - 2      - 3     - 4
1116         // argv:   0    - 1      - 2     - 3 
1117         // cmd     vote - master - login - password
1118         
1119         switch(request)
1120         {
1121                 case CMD_REQUEST_COMMAND:
1122                 {
1123                         if(VoteCommand_macro_command(caller, argc, vote_command))
1124                                 return;
1125                 }
1126                         
1127                 default:
1128                         print_to(caller, strcat(((argv(1) != "") ? strcat("Unknown vote command \"", argv(1), "\"") : "No command provided"), ". For a list of supported commands, try ", GetCommandPrefix(caller), " vote help.\n"));
1129                 case CMD_REQUEST_USAGE:
1130                 {
1131                         VoteCommand_macro_help(caller, argc);
1132                         return;
1133                 }
1134         }
1135 }