1 ###RUN_PERL: #!/usr/bin/perl
4 # 2words is generated from 2words.1.pl.
6 # The wordgame interface
8 # Copyright (C) 2016 - 2017, 2023 Balthasar SzczepaĆski
10 # This program is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU Affero General Public License as
12 # published by the Free Software Foundation, either version 3 of the
13 # License, or (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU Affero General Public License for more details.
20 # You should have received a copy of the GNU Affero General Public License
21 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 # use Encode::Locale ('decode_argv');
26 use Encode ('encode', 'decode');
28 ###PERL_LIB: use lib /botm/lib/bsta
30 'read_data_file', 'write_data_file',
34 'html_entity_encode_dec',
38 'STATE', 'INTF_STATE',
40 'fail_method', 'fail_content_type',
41 'print_html_start', 'print_html_end',
42 'print_html_head_start', 'print_html_head_end',
43 'print_html_body_start', 'print_html_body_end',
50 ###PERL_PATH_SEPARATOR: PATH_SEPARATOR = /
52 ###PERL_CGI_PATH: CGI_PATH = /bsta/
53 ###PERL_CGI_2WORDS_PATH: CGI_2WORDS_PATH = /bsta/2words
55 ###PERL_DATA_PATH: DATA_PATH = /botm/data/bsta/
56 ###PERL_DATA_DEFAULT_PATH: DATA_DEFAULT_PATH = /botm/data/bsta/default
57 ###PERL_DATA_LIST_PATH: DATA_LIST_PATH = /botm/data/bsta/list
58 ###PERL_DATA_SETTINGS_PATH: DATA_SETTINGS_PATH = /botm/data/bsta/settings
59 ###PERL_DATA_STATE_PATH: DATA_STATE_PATH = /botm/data/bsta/state
60 ###PERL_DATA_STORY_PATH: DATA_STORY_PATH = /botm/data/bsta/story
62 ###PERL_WWW_PATH: WWW_PATH = /botm/www/1190/bsta/
64 ###PERL_WEBSITE_NAME: WEBSITE_NAME = Bicycles on the Moon
66 ###PERL_STORY_LENGTH: STORY_LENGTH = 16
67 ###PERL_PAGE_LENGTH: PAGE_LENGTH = 16
68 ###PERL_FIRSTPAGE_LENGTH: FIRSTPAGE_LENGTH = 4
70 binmode STDIN, ':encoding(UTF-8)';
71 binmode STDOUT, ':encoding(UTF-8)';
72 binmode STDERR, ':encoding(UTF-8)';
111 delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};
112 ###PERL_SET_PATH: $ENV{'PATH'} = /usr/local/bin:/usr/bin:/bin;
114 if ($ENV{'REQUEST_METHOD'} =~ /^(HEAD|GET|POST)$/) {
118 exit fail_method($ENV{'REQUEST_METHOD'}, 'GET, POST, HEAD');
121 %http = read_header_env(\%ENV);
122 %cgi = url_query_decode($ENV{'QUERY_STRING'});
124 if ($method eq 'POST') {
125 if ($http{'content-type'} eq 'application/x-www-form-urlencoded') {
126 my %cgi_post = url_query_decode( <STDIN> );
127 %cgi = merge_settings(\%cgi, \%cgi_post);
129 # multipart not supported
131 exit fail_content_type($method, $http{'content-type'});
135 $IP = get_remote_addr();
136 $page = get_id(\%cgi);
137 if ($cgi{'words'} ne '') {
138 $words = $cgi{'words'};
141 %settings = read_data_file(DATA_SETTINGS_PATH());
142 %state = read_data_file(DATA_STATE_PATH());
143 $ong_state = int($state{'state'});
144 $cmd_clear = $settings{'password'}.' clear';
145 $cmd_clear_all = $settings{'password'}.' clearall';
148 if (open ($story_file,"+<:encoding(UTF-8)",DATA_STORY_PATH())){
150 if (flock($story_file,2)) {
153 %story = read_data_file($story_file);
155 if ($story{'lastip'} =~ /^.+$/) {
162 $last_letter = lc($story{'letter'});
163 $story_id = int($story{'id'});
164 $intf_pass = int($story{'pass'});
165 $intf_state = int($story{'state'});
166 $intf_mode = $intf_state & INTF_STATE->{'mode'};
167 $intf_pause = $intf_state & INTF_STATE->{'||'};
169 if ($IP ne $last_IP) {
177 ($words eq $cmd_clear) ||
178 ($words eq $cmd_clear_all) ||
182 ($words eq $cmd_clear_all) ||
187 $story{'content'} = '';
188 $story{'lastip' } = '0.0.0.0';
189 $story{'letter' } = '';
191 $story{'state' } = INTF_STATE->{'X'};
193 if ($ong_state == STATE->{'inactive'}) {
202 write_data_file($story_file, '', '', \%story);
207 $message = "It's not your turn.";
209 # TODO: consider allowing non-ASCII letters in words.
210 # (not very important in English language)
211 elsif ($words =~ /^([!"\(\),\.:;\?][ \t]*)?([A-Za-z][A-Za-z'\-]*[A-Za-z']?)([!"\(\),\.:;\? \t][ \t]*)([A-Za-z][A-Za-z'\-]*[A-Za-z']?)([!"\(\),\.:;\?]?[ \t]*)$/) {
213 $first_letter = lc(substr($2, 0, 1));
214 $second_letter = lc(substr($4, 0, 1));
216 ($first_letter ne $last_letter) &&
219 $message = 'The first word must start with '.uc($last_letter).'.';
221 elsif ($first_letter eq $second_letter) {
222 $message = 'The second word can\'t also start with '.uc($first_letter).'.';
227 $story{'content'} = $story{'content'} . $words."\n";
229 $story{'lastip'} = $IP;
230 $story{'letter'} = $second_letter;
232 if ($cgi{'next'} ne '') {
234 if (split(/\r?\n/,$story{'content'}) >= (STORY_LENGTH-1)) {
235 # store finished game
236 $story_i_path = DATA_STORY_PATH.$story_id;
237 write_data_file($story_i_path, '', '', \%story);
239 $new_story{'id' } = $story_id + 1;
240 $new_story{'letter' } = '';
241 $new_story{'lastip' } = $IP;
242 $new_story{'content'} = '';
243 $new_story{'pass' } = 0;
244 $new_story{'state' } = INTF_STATE->{'X'};
245 # reset hidden interface
246 $intf_state = INTF_STATE->{'X'};
248 $intf_mode = INTF_STATE->{'X'};
250 if($ong_state == STATE->{'inactive'}) {
251 # ONG not activated yet; reset index
261 write_data_file($story_file, '', '', \%new_story);
264 $message = 'To early to finish this wordgame.';
265 write_data_file($story_file, '', '', \%story);
270 if ($intf_pass == 1) {
271 # hidden interface was already active; deactivate
274 if($ong_state == STATE->{'inactive'}) {
284 elsif(lc($2).' '.lc($4) eq $settings{'unlock'}) {
285 # correct password for the hidden interface!
286 if ($intf_pass != 0) {
287 $message = 'The password has already been used in this story.';
289 elsif ($ong_state != STATE->{'inactive'}) {
290 # ONG already active, nothing to do here
303 # prepare to ONG frame 0!
305 $frame_data_path = join_path(PATH_SEPARATOR(), DATA_PATH(), 0);
306 %frame_data = read_data_file($frame_data_path);
307 %default = read_data_file(DATA_DEFAULT_PATH());
309 $ext = (defined($frame_data{'ext'})) ?
313 $frame_file = sprintf($settings{'frame'}, 0, $ext);
314 $in_path = join_path(PATH_SEPARATOR(), DATA_PATH(), $frame_file);;
315 $out_path = join_path(PATH_SEPARATOR(), WWW_PATH(), $frame_file);
317 # set ONG time of frame 0
318 # NOTE: might get overwritten later if ONG not launched
319 $frame_data{'ongtime'} = $time;
320 $frame_data{'timer'} = 0;
321 write_data_file($frame_data_path, '', '', \%frame_data);
323 # update the GOTO list with frame 0
324 $goto_list{'title-0' } = $frame_data{'title'};
325 $goto_list{'ongtime-0'} = $frame_data{'ongtime'};
326 write_data_file(DATA_LIST_PATH(), '', '', \%goto_list);
328 if(copy ($in_path, $out_path)) {
329 # new state of hidden interface
331 $intf_state = INTF_STATE->{'X'};
332 $intf_mode = INTF_STATE->{'X'};
335 $story{'state'} = INTF_STATE->{'X'};
346 write_data_file($story_file, '', '', \%story);
351 $message = 'Please, two words, not more, not less (some punctuation is allowed).';
357 ($ong_state == STATE->{'inactive'})
359 $intf_state = int($cgi{'s'}) & INTF_STATE->{'mask'};
360 $intf_mode = $intf_state & INTF_STATE->{'mode'};
361 $intf_pause = $intf_state & INTF_STATE->{'||'};
362 $story{'state'} = $intf_state;
370 write_data_file($story_file, '', '', \%story);
372 @story_lines = split(/\r?\n/, $story{'content'});
373 if(@story_lines & 1) {
380 print "Content-type: text/html\n\n";
381 if($method eq 'HEAD') {
385 my $max_page = int(($story_id - FIRSTPAGE_LENGTH - 1) / PAGE_LENGTH) + 1;
386 my $newer_available = ($page > 0);
387 my $older_available = ($page < $max_page);
388 my $show_intf = ($intf_pass == 1) && ($ong_state == STATE->{'inactive'});
392 (($page-1) * PAGE_LENGTH ) + FIRSTPAGE_LENGTH
395 my $id_stop = $story_id-1 - (($page*PAGE_LENGTH) + FIRSTPAGE_LENGTH);
400 my $bsta_url = CGI_PATH;
401 my $twowords_url = CGI_2WORDS_PATH;
405 my $newest_url = merge_url(
406 {'path' => $twowords_url},
409 if ($newer_available) {
410 $newer_url = merge_url(
411 {'path' => $twowords_url},
415 if ($older_available) {
416 $older_url = merge_url(
417 {'path' => $twowords_url},
420 $oldest_url = merge_url(
421 {'path' => $twowords_url},
422 {'path' => $max_page}
425 my $button_4_url = merge_url(
426 {'path' => $twowords_url},
427 {'query' => {'s' => (INTF_STATE->{'>'} | $intf_pause)}}
429 my $button_3_url = merge_url(
430 {'path' => $twowords_url},
431 {'query' => {'s' => (INTF_STATE->{'<<'} | $intf_pause)}}
433 my $button_2_url = merge_url(
434 {'path' => $twowords_url},
435 {'query' => {'s' => (INTF_STATE->{'>>'} | $intf_pause)}}
437 my $button_1_url = merge_url(
438 {'path' => $twowords_url},
439 {'query' => {'s' => INTF_STATE->{'X'}}}
441 my $button_0_url = merge_url(
442 {'path' => $twowords_url},
443 {'query' => {'s' => ($intf_pause ? $intf_mode : ($intf_mode | INTF_STATE->{'||'}))}}
445 my $button_5_img = merge_url(
446 {'path' => CGI_PATH()},
447 {'path' => 'intf-20.gif'}
449 my $button_4_img = merge_url(
450 {'path' => CGI_PATH()},
451 {'path' => 'intf-10'.(($intf_mode == INTF_STATE->{'>'}) ? '_' : '').'.gif'}
453 my $button_3_img = merge_url(
454 {'path' => CGI_PATH()},
455 {'path' => 'intf-08'.(($intf_mode == INTF_STATE->{'<<'}) ? '_' : '').'.gif'}
457 my $button_2_img = merge_url(
458 {'path' => CGI_PATH()},
459 {'path' => 'intf-04'.(($intf_mode == INTF_STATE->{'>>'}) ? '_' : '').'.gif'}
461 my $button_1_img = merge_url(
462 {'path' => CGI_PATH()},
463 {'path' => 'intf-02.gif'}
465 my $button_0_img = merge_url(
466 {'path' => CGI_PATH()},
467 {'path' => 'intf-01'.($intf_pause ? '_' : '').'.gif'}
469 my $intf_img_id = '';
470 if ($intf_state == INTF_STATE->{'>'}) {
473 elsif ($intf_mode == INTF_STATE->{'<<'}) {
476 elsif ($intf_mode == INTF_STATE->{'>>'}) {
479 my $intf_img = merge_url(
480 {'path' => CGI_PATH()},
481 {'path' => 'intf-00'.$intf_img_id.'.gif'}
484 my $_bsta_url = html_entity_encode_dec($bsta_url , 1);
485 my $_twowords_url = html_entity_encode_dec($twowords_url , 1);
486 my $_newest_url = html_entity_encode_dec($newest_url , 1);
487 my $_newer_url = html_entity_encode_dec($newer_url , 1);
488 my $_older_url = html_entity_encode_dec($older_url , 1);
489 my $_oldest_url = html_entity_encode_dec($oldest_url , 1);
490 my $_button_4_url = html_entity_encode_dec($button_4_url , 1);
491 my $_button_3_url = html_entity_encode_dec($button_3_url , 1);
492 my $_button_2_url = html_entity_encode_dec($button_2_url , 1);
493 my $_button_1_url = html_entity_encode_dec($button_1_url , 1);
494 my $_button_0_url = html_entity_encode_dec($button_0_url , 1);
495 my $_button_5_img = html_entity_encode_dec($button_5_img , 1);
496 my $_button_4_img = html_entity_encode_dec($button_4_img , 1);
497 my $_button_3_img = html_entity_encode_dec($button_3_img , 1);
498 my $_button_2_img = html_entity_encode_dec($button_2_img , 1);
499 my $_button_1_img = html_entity_encode_dec($button_1_img , 1);
500 my $_button_0_img = html_entity_encode_dec($button_0_img , 1);
501 my $_intf_img = html_entity_encode_dec($intf_img , 1);
502 my $_message = html_entity_encode_dec($message , 1);
503 my $_website_name = html_entity_encode_dec(WEBSITE_NAME(), 1);
505 print_html_start(\*STDOUT);
506 print_html_head_start(\*STDOUT);
509 print ' <title>Two words • '.$_website_name.'</title>'."\n";
510 print ' <link rel="start" href="'.$_oldest_url.'">'."\n";
511 if ($older_available) {
512 print ' <link rel="prev" href="'.$_older_url.'">'."\n";
514 if ($newer_available) {
515 print ' <link rel="next" href="'.$_newer_url.'">'."\n";
518 print_html_head_end(\*STDOUT);
519 print_html_body_start(\*STDOUT);
521 print ' <div id="inst" class="ins">'."\n";
523 print ' <div id="title">'."\n";
524 print ' <h1 id="titletext">Two words</h1>'."\n";
525 print ' </div>'."\n";
528 print ' <div id="storypuzzle">'."\n";
529 for (my $i = 0; $i < @story_lines; ++$i) {
530 print ' <span class="'.($turn ? 'ni':'br').'">'.html_entity_encode_dec($story_lines[$i], 1).'</span>'."\n";
533 print ' </div>'."\n";
535 print ' <div id="command">'."\n";
536 if ($message ne '') {
537 print ' <span class="br">'.$_message.'</span>'."\n";
541 print ' <form method="post" action="'.$_twowords_url.'">'."\n";
542 if ($message eq '') {
543 if ($story{"content"} eq '') {
544 print ' Two words, please:<br>'."\n";
547 print ' Please continue, two words:<br>'."\n";
550 print ' <input class="intx" type="text" name="words">'."\n";
551 print ' <input class="inbt" type="submit" value="enter">'."\n";
552 if(@story_lines >= (STORY_LENGTH-1)) {
553 print ' <input class="inbt" type="submit" name="next" value="enter and then start a new one">'."\n";
555 print ' </form>'."\n";
558 if ($message eq '') {
559 print ' Wait for it.'."\n";
562 print ' </div>'."\n";
564 elsif ($message ne '') {
565 print ' <div id="command">'."\n";
566 print ' <span class="br">'.$_message.'</span>'."\n";
567 print ' </div>'."\n";
569 print ' </div>'."\n";
572 print ' <div id="framespace">'."\n";
573 print ' <table id="intftable" cellspacing="0" cellpadding="0">'."\n";
574 print ' <tr class="intf">'."\n";
575 print ' <td colspan="6" class="intf"><img src="'.$_intf_img.'" alt="" class="intf"></td>'."\n";
578 print ' <tr class="intf">'."\n";
579 print ' <td class="intf"><img src="'.$_button_5_img.'" alt="o" class="intf"></td>'."\n";
580 print ' <td class="intf"><a href="'.$_button_4_url.'"><img src="'.$_button_4_img.'" class="intf" alt=">"></a></td>'."\n";
581 print ' <td class="intf"><a href="'.$_button_3_url.'"><img src="'.$_button_3_img.'" class="intf" alt="<<"></a></td>'."\n";
582 print ' <td class="intf"><a href="'.$_button_2_url.'"><img src="'.$_button_2_img.'" class="intf" alt=">>"></a></td>'."\n";
583 print ' <td class="intf"><a href="'.$_button_1_url.'"><img src="'.$_button_1_img.'" class="intf" alt="^"></a></td>'."\n";
584 print ' <td class="intf"><a href="'.$_button_0_url.'"><img src="'.$_button_0_img.'" class="intf" alt="||"></a></td>'."\n";
586 print ' </table>'."\n";
587 print ' </div>'."\n";
590 print ' <div id="insb" class="ins">'."\n";
592 print ' <div id="undertext">'."\n";
593 for (my $i = $id_start; $i > $id_stop; --$i) {
594 $story_i_path = DATA_STORY_PATH.$i;
595 %new_story = read_data_file($story_i_path);
596 print ' <p class="'.(($i&1)?'br':'ni').'" id="s'.$i.'">'.html_entity_encode_dec($new_story{'content'}).'</p>'."\n";
598 print ' </div>'."\n";
600 print ' <div id="underlinks">'."\n";
601 print ' <a href="'.$_bsta_url.'">BSTA</a> |'."\n";
602 print ' <a href="'.$_twowords_url.'">Once again</a>';
603 if ($older_available) {
605 print ' <a href="'.$_older_url.'">Before</a>';
607 if ($newer_available) {
609 print ' <a href="'.$newer_url.'">Unbefore</a>';
611 if ($older_available) {
613 print '<a href="'.$_oldest_url.'">Initially</a>';
617 print ' (Entering words here is irreversible. Your actions might be remembered forever. So please be reasonable.)';
620 print ' </div>'."\n";
622 print ' </div>'."\n";
624 print_html_body_end(\*STDOUT);
625 print_html_end(\*STDOUT);