1 ###RUN_PERL: #!/usr/bin/perl
4 # 2words is generated from 2words.1.pl.
6 # The wordgame interface
8 # Copyright (C) 2016, 2017, 2023, 2024 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',
33 '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_CGI_PATH: CGI_PATH = /bsta/
51 ###PERL_CGI_2WORDS_PATH: CGI_2WORDS_PATH = /bsta/2words
53 ###PERL_DATA_SETTINGS_PATH: DATA_SETTINGS_PATH = /botm/data/bsta/settings
54 ###PERL_DATA_STATE_PATH: DATA_STATE_PATH = /botm/data/bsta/state
55 ###PERL_DATA_STORY_PATH: DATA_STORY_PATH = /botm/data/bsta/story
57 ###PERL_WEBSITE_NAME: WEBSITE_NAME = Bicycles on the Moon
59 ###PERL_STORY_LENGTH: STORY_LENGTH = 16
60 ###PERL_PAGE_LENGTH: PAGE_LENGTH = 16
61 ###PERL_FIRSTPAGE_LENGTH: FIRSTPAGE_LENGTH = 4
63 binmode STDIN, ':encoding(UTF-8)';
64 binmode STDOUT, ':encoding(UTF-8)';
65 binmode STDERR, ':encoding(UTF-8)';
103 delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};
104 ###PERL_SET_PATH: $ENV{'PATH'} = /usr/local/bin:/usr/bin:/bin;
106 if ($ENV{'REQUEST_METHOD'} =~ /^(HEAD|GET|POST)$/) {
110 exit fail_method($ENV{'REQUEST_METHOD'}, 'GET, POST, HEAD');
113 %http = read_header_env(\%ENV);
114 %cgi = url_query_decode($ENV{'QUERY_STRING'});
116 if ($method eq 'POST') {
117 if ($http{'content-type'} eq 'application/x-www-form-urlencoded') {
118 my %cgi_post = url_query_decode( <STDIN> );
119 %cgi = merge_settings(\%cgi, \%cgi_post);
121 # multipart not supported
123 exit fail_content_type($method, $http{'content-type'});
127 $IP = get_remote_addr();
128 $page = get_id(\%cgi);
129 if ($cgi{'words'} ne '') {
130 $words = $cgi{'words'};
133 %settings = read_data_file(DATA_SETTINGS_PATH());
134 %state = read_data_file(DATA_STATE_PATH());
135 $ong_state = int($state{'state'});
136 $cmd_clear = $settings{'password'}.' clear';
137 $cmd_clear_all = $settings{'password'}.' clearall';
140 if (open_encoded($fh, "+<:encoding(UTF-8)", DATA_STORY_PATH())) {
145 %story = read_data_file($fh);
147 if ($story{'lastip'} =~ /^.+$/) {
154 $last_letter = lc($story{'letter'});
155 $story_id = int($story{'id'});
156 $intf_pass = int($story{'pass'});
157 $intf_state = int($story{'state'});
158 $intf_mode = $intf_state & INTF_STATE->{'mode'};
159 $intf_pause = $intf_state & INTF_STATE->{'||'};
161 if ($IP ne $last_IP) {
169 ($words eq $cmd_clear) ||
170 ($words eq $cmd_clear_all) ||
174 ($words eq $cmd_clear_all) ||
179 $story{'content'} = '';
180 $story{'lastip' } = '0.0.0.0';
181 $story{'letter' } = '';
183 $story{'state' } = INTF_STATE->{'X'};
185 if ($ong_state == STATE->{'inactive'}) {
194 write_data_file($fh, \%story);
199 $message = "It's not your turn.";
201 # TODO: consider allowing non-ASCII letters in words.
202 # (not very important in English language)
203 elsif ($words =~ /^([!"\(\),\.:;\?][ \t]*)?([A-Za-z][A-Za-z'\-]*[A-Za-z']?)([!"\(\),\.:;\? \t][ \t]*)([A-Za-z][A-Za-z'\-]*[A-Za-z']?)([!"\(\),\.:;\?]?[ \t]*)$/) {
205 $first_letter = lc(substr($2, 0, 1));
206 $second_letter = lc(substr($4, 0, 1));
208 ($first_letter ne $last_letter) &&
211 $message = 'The first word must start with '.uc($last_letter).'.';
213 elsif ($first_letter eq $second_letter) {
214 $message = 'The second word can\'t also start with '.uc($first_letter).'.';
219 $story{'content'} = $story{'content'} . $words."\n";
221 $story{'lastip'} = $IP;
222 $story{'letter'} = $second_letter;
224 if ($cgi{'next'} ne '') {
226 if (split(/\r?\n/,$story{'content'}) >= (STORY_LENGTH-1)) {
227 # store finished game
228 $story_i_path = DATA_STORY_PATH.$story_id;
229 write_data_file($story_i_path, \%story);
231 $new_story{'id' } = $story_id + 1;
232 $new_story{'letter' } = '';
233 $new_story{'lastip' } = $IP;
234 $new_story{'content'} = '';
235 $new_story{'pass' } = 0;
236 $new_story{'state' } = INTF_STATE->{'X'};
237 # reset hidden interface
238 $intf_state = INTF_STATE->{'X'};
240 $intf_mode = INTF_STATE->{'X'};
242 if($ong_state == STATE->{'inactive'}) {
243 # ONG not activated yet; reset index
253 write_data_file($fh, \%new_story);
256 $message = 'To early to finish this wordgame.';
257 write_data_file($fh, \%story);
262 if ($intf_pass == 1) {
263 # hidden interface was already active; deactivate
266 if($ong_state == STATE->{'inactive'}) {
276 elsif(lc($2).' '.lc($4) eq $settings{'unlock'}) {
277 # correct password for the hidden interface!
278 if ($intf_pass != 0) {
279 $message = 'The password has already been used in this story.';
281 elsif ($ong_state != STATE->{'inactive'}) {
282 # ONG already active, nothing to do here
291 'i', # ID: tape interface
292 $time, # ONG time; not relevant
293 0, # timer; not relevant
294 0, # update; not relevant
296 \%settings, # not relevant
297 '', # %default; not relevant
298 '', # %frame_data; not relevant
299 '' # $goto_list; not relevant
305 $time, # ONG time; not relevant
306 0, # timer; not relevant
307 0, # update; not relevant
312 '' # $goto_list; not relevant
319 $time, # ONG time; might get overwritten later
330 # new state of hidden interface
332 $intf_state = INTF_STATE->{'X'};
333 $intf_mode = INTF_STATE->{'X'};
336 $story{'state'} = INTF_STATE->{'X'};
347 write_data_file($fh, \%story);
352 $message = 'Please, two words, not more, not less (some punctuation is allowed).';
358 ($ong_state == STATE->{'inactive'})
360 $intf_state = int($cgi{'s'}) & INTF_STATE->{'mask'};
361 $intf_mode = $intf_state & INTF_STATE->{'mode'};
362 $intf_pause = $intf_state & INTF_STATE->{'||'};
363 $story{'state'} = $intf_state;
371 write_data_file($fh, \%story);
373 @story_lines = split(/\r?\n/, $story{'content'});
374 if(@story_lines & 1) {
381 print "Content-type: text/html\n\n";
382 if($method eq 'HEAD') {
386 my $max_page = int(($story_id - FIRSTPAGE_LENGTH - 1) / PAGE_LENGTH) + 1;
387 my $newer_available = ($page > 0);
388 my $older_available = ($page < $max_page);
389 my $show_intf = ($intf_pass == 1) && ($ong_state == STATE->{'inactive'});
393 (($page-1) * PAGE_LENGTH ) + FIRSTPAGE_LENGTH
396 my $id_stop = $story_id-1 - (($page*PAGE_LENGTH) + FIRSTPAGE_LENGTH);
401 my $bsta_url = CGI_PATH;
402 my $twowords_url = CGI_2WORDS_PATH;
406 my $newest_url = merge_url(
407 {'path' => $twowords_url},
410 if ($newer_available) {
411 $newer_url = merge_url(
412 {'path' => $twowords_url},
416 if ($older_available) {
417 $older_url = merge_url(
418 {'path' => $twowords_url},
421 $oldest_url = merge_url(
422 {'path' => $twowords_url},
423 {'path' => $max_page}
426 my $button_4_url = merge_url(
427 {'path' => $twowords_url},
428 {'query' => {'s' => (INTF_STATE->{'>'} | $intf_pause)}}
430 my $button_3_url = merge_url(
431 {'path' => $twowords_url},
432 {'query' => {'s' => (INTF_STATE->{'<<'} | $intf_pause)}}
434 my $button_2_url = merge_url(
435 {'path' => $twowords_url},
436 {'query' => {'s' => (INTF_STATE->{'>>'} | $intf_pause)}}
438 my $button_1_url = merge_url(
439 {'path' => $twowords_url},
440 {'query' => {'s' => INTF_STATE->{'X'}}}
442 my $button_0_url = merge_url(
443 {'path' => $twowords_url},
444 {'query' => {'s' => ($intf_pause ? $intf_mode : ($intf_mode | INTF_STATE->{'||'}))}}
446 my $button_5_img = merge_url(
447 {'path' => CGI_PATH()},
448 {'path' => 'intf-20.gif'}
450 my $button_4_img = merge_url(
451 {'path' => CGI_PATH()},
452 {'path' => 'intf-10'.(($intf_mode == INTF_STATE->{'>'}) ? '_' : '').'.gif'}
454 my $button_3_img = merge_url(
455 {'path' => CGI_PATH()},
456 {'path' => 'intf-08'.(($intf_mode == INTF_STATE->{'<<'}) ? '_' : '').'.gif'}
458 my $button_2_img = merge_url(
459 {'path' => CGI_PATH()},
460 {'path' => 'intf-04'.(($intf_mode == INTF_STATE->{'>>'}) ? '_' : '').'.gif'}
462 my $button_1_img = merge_url(
463 {'path' => CGI_PATH()},
464 {'path' => 'intf-02.gif'}
466 my $button_0_img = merge_url(
467 {'path' => CGI_PATH()},
468 {'path' => 'intf-01'.($intf_pause ? '_' : '').'.gif'}
470 my $intf_img_id = '';
471 if ($intf_state == INTF_STATE->{'>'}) {
474 elsif ($intf_mode == INTF_STATE->{'<<'}) {
477 elsif ($intf_mode == INTF_STATE->{'>>'}) {
480 my $intf_img = merge_url(
481 {'path' => CGI_PATH()},
482 {'path' => 'intf-00'.$intf_img_id.'.gif'}
485 my $_bsta_url = html_entity_encode_dec($bsta_url , 1);
486 my $_twowords_url = html_entity_encode_dec($twowords_url , 1);
487 my $_newest_url = html_entity_encode_dec($newest_url , 1);
488 my $_newer_url = html_entity_encode_dec($newer_url , 1);
489 my $_older_url = html_entity_encode_dec($older_url , 1);
490 my $_oldest_url = html_entity_encode_dec($oldest_url , 1);
491 my $_button_4_url = html_entity_encode_dec($button_4_url , 1);
492 my $_button_3_url = html_entity_encode_dec($button_3_url , 1);
493 my $_button_2_url = html_entity_encode_dec($button_2_url , 1);
494 my $_button_1_url = html_entity_encode_dec($button_1_url , 1);
495 my $_button_0_url = html_entity_encode_dec($button_0_url , 1);
496 my $_button_5_img = html_entity_encode_dec($button_5_img , 1);
497 my $_button_4_img = html_entity_encode_dec($button_4_img , 1);
498 my $_button_3_img = html_entity_encode_dec($button_3_img , 1);
499 my $_button_2_img = html_entity_encode_dec($button_2_img , 1);
500 my $_button_1_img = html_entity_encode_dec($button_1_img , 1);
501 my $_button_0_img = html_entity_encode_dec($button_0_img , 1);
502 my $_intf_img = html_entity_encode_dec($intf_img , 1);
503 my $_message = html_entity_encode_dec($message , 1);
504 my $_website_name = html_entity_encode_dec(WEBSITE_NAME(), 1);
506 print_html_start(\*STDOUT);
507 print_html_head_start(\*STDOUT);
510 print ' <title>Two words • '.$_website_name.'</title>'."\n";
511 print ' <link rel="start" href="'.$_oldest_url.'">'."\n";
512 if ($older_available) {
513 print ' <link rel="prev" href="'.$_older_url.'">'."\n";
515 if ($newer_available) {
516 print ' <link rel="next" href="'.$_newer_url.'">'."\n";
519 print_html_head_end(\*STDOUT);
520 print_html_body_start(\*STDOUT);
522 print ' <div id="inst" class="ins">'."\n";
524 print ' <div id="title">'."\n";
525 print ' <h1 id="titletext">Two words</h1>'."\n";
526 print ' </div>'."\n";
529 print ' <div id="storypuzzle">'."\n";
530 for (my $i = 0; $i < @story_lines; ++$i) {
531 print ' <span class="'.($turn ? 'ni':'br').'">'.html_entity_encode_dec($story_lines[$i], 1).'</span>'."\n";
534 print ' </div>'."\n";
536 print ' <div id="command">'."\n";
537 if ($message ne '') {
538 print ' <span class="br">'.$_message.'</span>'."\n";
542 print ' <form method="post" action="'.$_twowords_url.'">'."\n";
543 if ($message eq '') {
544 if ($story{"content"} eq '') {
545 print ' Two words, please:<br>'."\n";
548 print ' Please continue, two words:<br>'."\n";
551 print ' <input class="intx" type="text" name="words">'."\n";
552 print ' <input class="inbt" type="submit" value="enter">'."\n";
553 if (@story_lines >= (STORY_LENGTH-1)) {
554 print ' <input class="inbt" type="submit" name="next" value="enter and then start a new one">'."\n";
556 print ' </form>'."\n";
559 if ($message eq '') {
560 print ' Wait for it.'."\n";
563 print ' </div>'."\n";
565 elsif ($message ne '') {
566 print ' <div id="command">'."\n";
567 print ' <span class="br">'.$_message.'</span>'."\n";
568 print ' </div>'."\n";
570 print ' </div>'."\n";
573 print ' <div id="framespace">'."\n";
574 print ' <table id="intftable" cellspacing="0" cellpadding="0">'."\n";
575 print ' <tr class="intf">'."\n";
576 print ' <td colspan="6" class="intf"><img src="'.$_intf_img.'" alt="" class="intf"></td>'."\n";
579 print ' <tr class="intf">'."\n";
580 print ' <td class="intf"><img src="'.$_button_5_img.'" alt="o" class="intf"></td>'."\n";
581 print ' <td class="intf"><a href="'.$_button_4_url.'"><img src="'.$_button_4_img.'" class="intf" alt=">"></a></td>'."\n";
582 print ' <td class="intf"><a href="'.$_button_3_url.'"><img src="'.$_button_3_img.'" class="intf" alt="<<"></a></td>'."\n";
583 print ' <td class="intf"><a href="'.$_button_2_url.'"><img src="'.$_button_2_img.'" class="intf" alt=">>"></a></td>'."\n";
584 print ' <td class="intf"><a href="'.$_button_1_url.'"><img src="'.$_button_1_img.'" class="intf" alt="^"></a></td>'."\n";
585 print ' <td class="intf"><a href="'.$_button_0_url.'"><img src="'.$_button_0_img.'" class="intf" alt="||"></a></td>'."\n";
587 print ' </table>'."\n";
588 print ' </div>'."\n";
591 print ' <div id="insb" class="ins">'."\n";
593 print ' <div id="undertext">'."\n";
594 for (my $i = $id_start; $i > $id_stop; --$i) {
595 $story_i_path = DATA_STORY_PATH.$i;
596 %new_story = read_data_file($story_i_path);
597 print ' <p class="'.(($i&1)?'br':'ni').'" id="s'.$i.'">'.html_entity_encode_dec($new_story{'content'}).'</p>'."\n";
599 print ' </div>'."\n";
601 print ' <div id="underlinks">'."\n";
602 print ' <a href="'.$_bsta_url.'">BSTA</a> |'."\n";
603 print ' <a href="'.$_twowords_url.'">Once again</a>';
604 if ($older_available) {
606 print ' <a href="'.$_older_url.'">Before</a>';
608 if ($newer_available) {
610 print ' <a href="'.$newer_url.'">Unbefore</a>';
612 if ($older_available) {
614 print '<a href="'.$_oldest_url.'">Initially</a>';
618 print ' (Entering words here is irreversible. Your actions might be remembered forever. So please be reasonable.)';
621 print ' </div>'."\n";
623 print ' </div>'."\n";
625 print_html_body_end(\*STDOUT, $ong_state == STATE->{'inactive'});
626 print_html_end(\*STDOUT);