chess_game()

Complexity

Conditions	91
Paths	> 20000

Size

Total Lines	397
Code Lines	208

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

<?php
function chess_game()
{
    // user input

    $game_id = (int)@$_GET['game_id'];

    $submit_move = isset($_POST['submit_move']);

    $submit_refresh = isset($_POST['submit_refresh']);

    $move = chess_sanitize(trim(@$_POST['chessmove']), 'A-Za-z0-9=-');

    $movetype = chess_sanitize(@$_POST['movetype']);

    $confirm = isset($_POST['confirm']) ? 1 : 0;

    $move_explain = chess_sanitize(trim(@$_POST['move_explain']), 'A-Za-z0-9 .,;:=()[]*?!-');

    $arbiter_explain = chess_sanitize(trim(@$_POST['arbiter_explain']), 'A-Za-z0-9 .,;:=()[]*?!-');

    $orientation = chess_sanitize(@$_POST['orientation']);

    $show_arbiter_ctrl = isset($_POST['show_arbiter_ctrl']);

    $submit_arbitrate = isset($_POST['submit_arbitrate']);

    $arbiter_action = chess_sanitize(@$_POST['arbiter_action']);

    // If form-submit, check security token.

    if (($submit_move || $submit_refresh || $submit_arbitrate || $show_arbiter_ctrl) && is_object($GLOBALS['xoopsSecurity']) && !$GLOBALS['xoopsSecurity']->check()) {
        redirect_header(
            XOOPS_URL . '/modules/chess/',
            _CHESS_REDIRECT_DELAY_FAILURE,
            _MD_CHESS_TOKEN_ERROR . '<br>' . implode('<br>', $GLOBALS['xoopsSecurity']->getErrors())
        );
    }

    // Fetch the game data from the database.

    $gamedata = chess_get_game($game_id);

    if (false === $gamedata) {

The condition false === $gamedata is always false.

        redirect_header(XOOPS_URL . '/modules/chess/', _CHESS_REDIRECT_DELAY_FAILURE, _MD_CHESS_GAME_NOT_FOUND);
    }

    $gamedata_updated = false;

    $move_performed        = false; // status result from move-handler
    $move_result_text      = '';    // text result from move-handler
    $draw_claim_error_text = '';    // text describing invalid draw-claim
    $notify                = '';    // text description of action for notification
    $delete_game           = false;

    global $xoopsUser;

    $uid = $xoopsUser ? $xoopsUser->getVar('uid') : 0;

    $selfplay = $gamedata['white_uid'] == $gamedata['black_uid'];

    if ($selfplay) {
        if ($uid == $gamedata['white_uid']) {
            $user_color = $gamedata['fen_active_color']; // current user is either player, so consider him active player
        } else {
            $user_color = '';                            // current user is not a player
        }
        // not self-play
    } else {
        if ($uid == $gamedata['white_uid']) {
            $user_color = 'w'; // current user is white
        } elseif ($uid == $gamedata['black_uid']) {
            $user_color = 'b'; // current user is black
        } else {
            $user_color = '';  // current user is not a player
        }
    }

    // Determine whether current user is a player in the current game, and whether it's his move.

    $user_is_player = 'w' == $user_color || 'b' == $user_color;

    $user_is_player_to_move = $user_color == $gamedata['fen_active_color'];

    $user_color_name = 'w' == $user_color ? _MD_CHESS_WHITE : _MD_CHESS_BLACK;

    if ($submit_move && !$gamedata['suspended']) {
        // If the player has changed his confirm-move preference, it needs to be updated in the database.

        // For a self-play game, the white and black confirm-move preferences are kept the same, to avoid confusion.

        if ($user_is_player) {
            if ('w' == $user_color && $gamedata['white_confirm'] != $confirm) {
                $gamedata['white_confirm'] = $confirm;

                if ($selfplay) {
                    $gamedata['black_confirm'] = $confirm;
                }

                $gamedata_updated = true;
            } elseif ('b' == $user_color && $gamedata['black_confirm'] != $confirm) {
                $gamedata['black_confirm'] = $confirm;

                if ($selfplay) {
                    $gamedata['white_confirm'] = $confirm;
                }

                $gamedata_updated = true;
            }
        }

        switch ($movetype) {
            default:
            case _CHESS_MOVETYPE_NORMAL:
                if ($user_is_player_to_move && $gamedata['offer_draw'] != $user_color) {
                    [$move_performed, $move_result_text] = chess_move($gamedata, $move);

                    if ($move_performed) {
                        if ($selfplay) { // If self-play, the current user's color switches.
                            $user_color = $gamedata['fen_active_color'];
                        }

                        $gamedata['offer_draw'] = '';

                        $gamedata_updated = true;

                        $notify = "$user_color_name: $move";
                    }
                }
                break;
            case _CHESS_MOVETYPE_CLAIM_DRAW_3:
            case _CHESS_MOVETYPE_CLAIM_DRAW_50:
                if ($user_is_player_to_move && $gamedata['offer_draw'] != $user_color) {
                    if (!empty($move)) {
                        [$move_performed, $move_result_text] = chess_move($gamedata, $move);

                        #var_dump('chess_game', $move_performed, $move_result_text);#*#DEBUG#

                        if ($move_performed) {
                            if ($selfplay) { // If self-play, the current user's color switches.
                                $user_color = $gamedata['fen_active_color'];
                            }

                            $gamedata['offer_draw'] = '';

                            $gamedata_updated = true;

                            $notify = "$user_color_name: $move";
                        } else {
                            break; // move invalid, so don't bother checking draw-claim
                        }
                    }

                    [$draw_claim_valid, $draw_claim_text] = _CHESS_MOVETYPE_CLAIM_DRAW_3 == $movetype ? chess_is_draw_threefold_repetition($gamedata) : chess_is_draw_50_move_rule($gamedata);

                    #var_dump('chess_game', $draw_claim_valid, $draw_claim_text);#*#DEBUG#

                    if ($draw_claim_valid) {
                        $gamedata['offer_draw'] = '';

                        $gamedata['pgn_result'] = '1/2-1/2';

                        $comment = '{' . $draw_claim_text . '}';

                        $gamedata['pgn_movetext'] = str_replace('*', "{$gamedata['pgn_result']} $comment", $gamedata['pgn_movetext']);

                        $gamedata_updated = true;

                        $notify = !empty($move) ? "$user_color_name: $move: $draw_claim_text" : "$user_color_name: $draw_claim_text";
                    } else {
                        $draw_claim_error_text = $draw_claim_text;
                    }
                }
                break;
            case _CHESS_MOVETYPE_RESIGN:
                if ($user_is_player) {
                    $gamedata['offer_draw'] = '';

                    $gamedata['pgn_result'] = 'w' == $user_color ? '0-1' : '1-0';

                    $comment = '{' . $user_color_name . ' ' . _MD_CHESS_RESIGNED . '}';

                    $gamedata['pgn_movetext'] = str_replace('*', "{$gamedata['pgn_result']} $comment", $gamedata['pgn_movetext']);

                    $gamedata_updated = true;

                    $notify = "$user_color_name " . _MD_CHESS_RESIGNED;
                }
                break;
            case _CHESS_MOVETYPE_OFFER_DRAW:
                if ($user_is_player && empty($gamedata['offer_draw']) && !$selfplay) {
                    $gamedata['offer_draw'] = $user_color;

                    $gamedata_updated = true;

                    $notify = "$user_color_name " . _MD_CHESS_OFFERED_DRAW;
                }
                break;
            case _CHESS_MOVETYPE_ACCEPT_DRAW:
                if ($user_is_player && !empty($gamedata['offer_draw']) && $gamedata['offer_draw'] != $user_color && !$selfplay) {
                    $gamedata['offer_draw'] = '';

                    $gamedata['pgn_result'] = '1/2-1/2';

                    $comment = '{' . _MD_CHESS_DRAW_BY_AGREEMENT . '}';

                    $gamedata['pgn_movetext'] = str_replace('*', "{$gamedata['pgn_result']} $comment", $gamedata['pgn_movetext']);

                    $gamedata_updated = true;

                    $notify = "$user_color_name " . _MD_CHESS_ACCEPTED_DRAW;
                }

            // no break
            case _CHESS_MOVETYPE_REJECT_DRAW:
                if ($user_is_player && !empty($gamedata['offer_draw']) && $gamedata['offer_draw'] != $user_color && !$selfplay) {
                    $gamedata['offer_draw'] = '';

                    $gamedata_updated = true;

                    $notify = "$user_color_name " . _MD_CHESS_REJECTED_DRAW;
                }
                break;
            case _CHESS_MOVETYPE_RESTART:
                if ($user_is_player && $selfplay) {
                    // instantiate a ChessGame to get a "fresh" gamestate

                    $chessgame = new Chess\ChessGame($gamedata['pgn_fen']);

                    $new_gamestate = $chessgame->gamestate();

                    // update the game data

                    $gamedata['fen_piece_placement'] = $new_gamestate['fen_piece_placement'];

                    $gamedata['fen_active_color'] = $new_gamestate['fen_active_color'];

                    $gamedata['fen_castling_availability'] = $new_gamestate['fen_castling_availability'];

                    $gamedata['fen_en_passant_target_square'] = $new_gamestate['fen_en_passant_target_square'];

                    $gamedata['fen_halfmove_clock'] = $new_gamestate['fen_halfmove_clock'];

                    $gamedata['fen_fullmove_number'] = $new_gamestate['fen_fullmove_number'];

                    $gamedata['pgn_fen'] = $new_gamestate['pgn_fen'];

                    $gamedata['pgn_result'] = $new_gamestate['pgn_result'];

                    $gamedata['pgn_movetext'] = $new_gamestate['pgn_movetext'];

                    // update user color

                    $user_color = $gamedata['fen_active_color'];

                    $gamedata_updated = true;
                }
                break;
            case _CHESS_MOVETYPE_DELETE:
                if ($user_is_player && ($selfplay || chess_can_delete())) {
                    $delete_game = true; // must defer actual deletion until after notifications are sent
                    $notify      = eval('return \'' . _MD_CHESS_DELETED_GAME . '\';'); // eval references $username

The use of eval() is discouraged.

                }
                break;
            case _CHESS_MOVETYPE_WANT_ARBITRATION:
                if ($user_is_player) {
                    // Ensure that $move_explain does not contain separator $sep.

                    $sep = '|';

                    $move_explain = str_replace($sep, '_', $move_explain);

                    $gamedata['suspended'] = implode($sep, [date('Y-m-d H:i:s'), $uid, _CHESS_MOVETYPE_WANT_ARBITRATION, $move_explain]);

                    $gamedata_updated = true;

                    $notify = "$user_color_name " . _MD_CHESS_RQSTED_ARBT . ' ' . _MD_CHESS_BEEN_SUSPENDED;
                }
                break;
        }
    }

    // If board orientation setting uninitialized or invalid, set it to the appropriate default.

    if (!in_array($orientation, [_CHESS_ORIENTATION_ACTIVE, _CHESS_ORIENTATION_WHITE, _CHESS_ORIENTATION_BLACK])) {
        if ($user_is_player && 'b' == $user_color) {
            $orientation = _CHESS_ORIENTATION_BLACK;
        } else {
            $orientation = _CHESS_ORIENTATION_WHITE;
        }
    }

    // Determine if user is a valid arbiter.

    global $xoopsModule;

    $is_arbiter = is_object($xoopsUser) && $xoopsUser->isAdmin($xoopsModule->getVar('mid'));

    // If arbiter action was submitted, and user is a valid arbiter, process the action.

    if ($submit_arbitrate && $is_arbiter) {
        $username = $xoopsUser ? $xoopsUser->getVar('uname') : '*unknown*';

$xoopsUser is of type object, thus it always evaluated to true.

The assignment to $username is dead and can be removed.

        switch ($arbiter_action) {
            case _CHESS_ARBITER_RESUME:
                if ($gamedata['suspended'] && '*' == $gamedata['pgn_result']) {
                    $gamedata['suspended'] = '';

                    $gamedata_updated = true;

                    $notify = eval('return \'' . _MD_CHESS_RESUMED_PLAY . '\';'); // eval references $username

The use of eval() is discouraged.

                }
                break;
            case _CHESS_ARBITER_DRAW:
                if ($gamedata['suspended'] && '*' == $gamedata['pgn_result']) {
                    $gamedata['offer_draw'] = '';

                    $gamedata['pgn_result'] = '1/2-1/2';

                    $arbiter_explain = str_replace('{', '(', $arbiter_explain);

                    $arbiter_explain = str_replace('}', ')', $arbiter_explain);

                    $comment = '{' . sprintf(_MD_CHESS_DRAW_DECLARED, $arbiter_explain) . '}';

                    $gamedata['pgn_movetext'] = str_replace('*', "{$gamedata['pgn_result']} $comment", $gamedata['pgn_movetext']);

                    $gamedata['suspended'] = '';

                    $gamedata_updated = true;

                    $notify = eval('return \'' . _MD_CHESS_DECLARED_DRAW . '\';'); // eval references $username

The use of eval() is discouraged.

                }
                break;
            case _CHESS_ARBITER_DELETE:
                if ($gamedata['suspended']) {
                    $delete_game = true; // must defer actual deletion until after notifications are sent
                    $notify      = eval('return \'' . _MD_CHESS_DELETED_GAME . '\';'); // eval references $username

The use of eval() is discouraged.

                }
                break;
            case _CHESS_ARBITER_SUSPEND:
                if (!$gamedata['suspended'] && '*' == $gamedata['pgn_result']) {
                    // Ensure that $arbiter_explain does not contain separator $sep.

                    $sep = '|';

                    $arbiter_explain = str_replace($sep, '_', $arbiter_explain);

                    $gamedata['suspended'] = implode('|', [date('Y-m-d H:i:s'), $uid, _CHESS_MOVETYPE_ARBITER_SUSPEND, $arbiter_explain]);

                    $gamedata_updated = true;

                    $notify = eval('return \'' . _MD_CHESS_SUSPENDED_PLAY . '\';'); // eval references $username

The use of eval() is discouraged.

                }
                break;
            default:
                break;
        }
    }

    // Store the updated game data in the database.

    if ($gamedata_updated) {
        chess_put_game($game_id, $gamedata);
    }

    // Display the (possibly updated) board.

    if (!$delete_game) {
        chess_show_board($gamedata, $orientation, $user_color, $move_performed, $move_result_text, $draw_claim_error_text, $show_arbiter_ctrl && $is_arbiter);
    }

    // If a move (or other action) was made, notify any subscribers.

    if (!empty($notify)) {
        $notificationHandler = xoops_getHandler('notification');

        $notificationHandler->triggerEvent('game', $game_id, 'notify_game_move', ['CHESS_ACTION' => $notify]);

The method triggerEvent() does not exist on XoopsObjectHandler. It seems like you code against a sub-type of XoopsObjectHandler such as XoopsNotificationHandler or XoopsPersistableObjectHandler.

        // admin notifications

        if (_CHESS_MOVETYPE_WANT_ARBITRATION == $movetype) {
            $event = 'notify_request_arbitration';

            $username = $xoopsUser ? $xoopsUser->getVar('uname') : '(' . _MD_CHESS_UNKNOWN . ')';

            $extra_tags = ['CHESS_REQUESTOR' => $username, 'CHESS_GAME_ID' => $game_id, 'CHESS_EXPLAIN' => $move_explain];

            $notificationHandler->triggerEvent('global', 0, $event, $extra_tags);
        }
    }

    // Handle delete-game action.

    if ($delete_game) {
        chess_delete_game($game_id);

        redirect_header(XOOPS_URL . '/modules/chess/', _CHESS_REDIRECT_DELAY_SUCCESS, _MD_CHESS_GAME_DELETED);
    }