index.php ➔ xfgb_getmsg() - Code Metrics - Inspection of "3.10. FINAL" - XoopsModules25x/xfguestbook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

by Michael

created 2017-01-24 06:56 UTC

index.php ➔ xfgb_getmsg() F

↳ Parent: Project

Complexity

Conditions	16
Paths	385

Size

Total Lines	89
Code Lines	70

Duplication

Lines	5
Ratio	5.62 %

Importance

Changes

Metric	Value
cc	16
eloc	70
nc	385
nop	1
dl	5
loc	89
rs	3.7109
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

//
//  ------------------------------------------------------------------------ //
//             XF Guestbook                                                  //
// ------------------------------------------------------------------------- //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  You may not change or alter any portion of this comment or credits       //
//  of supporting developers from this source code or any supporting         //
//  source code which is considered copyrighted (c) material of the          //
//  original comment or credit authors.                                      //
//                                                                           //
//  This program is distributed in the hope that it will be useful,          //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of           //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            //
//  GNU General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write metalslugto the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
//  ------------------------------------------------------------------------ //

include __DIR__ . '/../../mainfile.php';
//include_once(XOOPS_ROOT_PATH."/modules/".$xoopsModule->dirname()."/class/msg.php");

include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->dirname() . '/class/util.php';
if (isset($_GET['msg_id'])) {

    $msg_id = (int)$_GET['msg_id'];
} elseif (isset($_POST['msg_id'])) {
    $msg_id = (int)$_POST['msg_id'];
} else {
    $msg_id = 0;
}

if (isset($_GET['op'])) {

    $op = $_GET['op'];
} elseif (isset($_POST['op'])) {
    $op = $_POST['op'];
} else {
    $op = 'show_all';
}

$msgHandler = xoops_getModuleHandler('msg');

//Admin or not
$xoopsUser ? $adminview = $xoopsUser->isAdmin() : $adminview = 0;

/**
 * @param $msg_id
 */
function delete($msg_id)
/**
 * @ignore
 */
function getUser() {

}

function getUser($id, $realm) {

}
{
    global $msgHandler, $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
    $ok = isset($_POST['ok']) ? (int)$_POST['ok'] : 0;
    if ($ok == 1) {
        $msg        = $msgHandler->get($msg_id);
        $del_msg_ok = $msgHandler->delete($msg);
        $filename   = $msg->getVar('photo');
        if ($filename !== '') {

            $filename = XOOPS_UPLOAD_PATH . '/' . $xoopsModule->getVar('dirname') . '/' . $filename;
            unlink($filename);
        }
        if ($del_msg_ok) {
            $messagesent = MD_XFGUESTBOOK_MSGDELETED;
        } else {
            $messagesent = MD_XFGUESTBOOK_ERRORDEL;
        }
        redirect_header('index.php', 2, $messagesent);
    } else {
        xoops_confirm(['op' => 'delete', 'msg_id' => $msg_id, 'ok' => 1], 'index.php', _DELETE);
    }
}

/**
 * @param $msg_id
 */
function approve($msg_id)
/**
 * @ignore
 */
function getUser() {

}

function getUser($id, $realm) {

}
{
    global $msgHandler;
function myFunction($a, $b) {
    // Do something
}

    $msg = $msgHandler->get($msg_id);
    $msg->setVar('moderate', 0);
    if (!$msgHandler->insert($msg)) {
        $messagesent = MD_XFGUESTBOOK_ERRORVALID;
    } else {
        $messagesent = MD_XFGUESTBOOK_VALIDATE;
    }
    redirect_header('index.php?op=show_waiting', 2, $messagesent);
}

/**
 * @param $msg
 */
function xfgb_getmsg($msg)
{
    global $nbmsg, $xoopsModule, $xoopsUser, $xoopsModuleConfig, $xoopsTpl, $xoopsConfig, $options, $opt, $xoopsDB;
function myFunction($a, $b) {
    // Do something
}

    $arr_country = XfguestbookUtil::getAllCountry();
    $xoopsTpl->assign('display_msg', true);
    foreach ($msg as $onemsg) {
        if ($poster = XfguestbookUtil::get_user_data($onemsg->getVar('user_id'))) {
            $a_msg = &$poster;
        } else {
            $a_msg             = [];
            $a_msg['poster']   = $onemsg->getVar('uname');
            $a_msg['rank']     = '';
            $a_msg['rank_img'] = '';
            $a_msg['avatar']   = '';
        }
        $memberHandler = xoops_getHandler('member');
        $user          = $memberHandler->getUser($onemsg->getVar('user_id'));
        // email
        if ($xoopsModuleConfig['showemail']
            || ($onemsg->getVar('email')
                && (($user->getVar('user_viewemail') == 1
                     || $onemsg->getVar('user_id') == 0)
                    && is_object($xoopsUser)))
        ) {
            $a_msg['email'] = "<a href=\"javascript:openWithSelfMain('"
                              . XOOPS_URL
                              . '/modules/xfguestbook/contact.php?msg_id='
                              . $onemsg->getVar('msg_id')
                              . '\', \'contact\', 600, 450);"><img src="'
                              . XOOPS_URL
                              . '/images/icons/email.gif" alt="'
                              . _SENDEMAILTO
                              . '" /></a>';
        }
        // url
        if ($onemsg->getVar('url')) {
            $a_msg['url'] = '<a href="' . $onemsg->getVar('url') . '" target="_blank"><img src="' . XOOPS_URL . '/images/icons/www.gif" alt="' . _VISITWEBSITE . '"></a>';
        }
        // gender
        if ($onemsg->getVar('gender') !== '') {
            $a_msg['gender'] = '<a href="index.php?op=show_gender&param=' . $onemsg->getVar('gender') . '"><img src="assets/images/' . $onemsg->getVar('gender') . '.gif"</a>';
        }
        // flag
        if ($onemsg->getVar('country') !== '') {
            if ($onemsg->getVar('country') !== 'other') {
                $flag = XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->dirname() . '/assets/images/flags/' . $onemsg->getVar('flagdir') . '/' . $onemsg->getVar('country') . '.gif';
                if (array_key_exists($onemsg->getVar('flagdir') . '/' . $onemsg->getVar('country'), $arr_country)) {
                    $country_name = $arr_country[$onemsg->getVar('flagdir') . '/' . $onemsg->getVar('country')];
                } else {
                    $country_name = '';
                }
                if (file_exists($flag)) {

                    $a_msg['country'] = '<img src="'
                                        . XOOPS_URL
                                        . '/modules/xfguestbook/assets/images/flags/'
                                        . $onemsg->getVar('flagdir')
                                        . '/'
                                        . $onemsg->getVar('country')
                                        . '.gif" alt="'
                                        . $country_name
                                        . '">';
                } else {
                    $a_msg['country'] = $country_name;
                }
                $a_msg['country'] = '<a href="index.php?op=show_country&param=' . $onemsg->getVar('flagdir') . '/' . $onemsg->getVar('country') . '">' . $a_msg['country'] . '</a>';
            } else {
                $a_msg['country'] = $onemsg->getVar('other');
            }
        }
        $a_msg['msg_id']  = $onemsg->getVar('msg_id');
        $a_msg['i']       = $nbmsg;
        $a_msg['title']   = $onemsg->getVar('title');
        $a_msg['date']    = formatTimestamp($onemsg->getVar('post_time'), 's');
        $a_msg['message'] = $onemsg->getVar('message');
        if ($options['opt_url'] == 1) {
            $a_msg['message'] = str_replace('target="_blank"', 'target="_blank" rel="nofollow"', $a_msg['message']);
        }
        $a_msg['note_msg']  = $onemsg->getVar('note');
        $a_msg['poster_ip'] = $onemsg->getVar('poster_ip');
        $a_msg['moderate']  = $onemsg->getVar('moderate');
        if (isset($country_name)) {
            $a_msg['local'] = '<a href="index.php?op=show_country&param=' . $onemsg->getVar('flagdir') . '/' . $onemsg->getVar('country') . '">' . $country_name . '</a>';
        }
        $a_msg['photo'] = $onemsg->getVar('photo');
        $xoopsTpl->append('msg', $a_msg);
        $nbmsg--;
    }
}

function xfgb_genderlist()
{
    global $options, $xoopsTpl, $xoopsModuleConfig, $xoopsModule, $msgHandler;
function myFunction($a, $b) {
    // Do something
}
    $criteria = new Criteria('moderate', 0);
    $arr_msg  = $msgHandler->countMsgByGender($criteria);
    $i        = 0;
    $gender = [];
    foreach ($arr_msg as $k => $v) {
        if ($k === 'M') {
            $gender[$i] = MD_XFGUESTBOOK_MALES . '<br>';
            $gender[$i] .= '<img src="assets/images/M.gif" alt="' . MD_XFGUESTBOOK_MALES . '"><br><br>';
            $gender[$i] .= '<a href="index.php?op=show_gender&param=M">' . $v . MD_XFGUESTBOOK_MESSAGES . '</a>';
        } elseif ($k === 'F') {
            $gender[$i] = MD_XFGUESTBOOK_FEMALES . '<br>';
            $gender[$i] .= '<img src="assets/images/F.gif" alt="' . MD_XFGUESTBOOK_FEMALES . '"><br><br>';
            $gender[$i] .= '<a href="index.php?op=show_gender&param=F">' . $v . MD_XFGUESTBOOK_MESSAGES . '</a>';
        } else {
            $gender[$i] = MD_XFGUESTBOOK_UNKNOW2 . '<br>';
            $gender[$i] .= '<img src="assets/images/U.gif"><br><br>';
            $gender[$i] .= $v . MD_XFGUESTBOOK_MESSAGES;
        }
        $i++;
    }
    $xoopsTpl->assign('gender', $gender);
    $xoopsTpl->assign('display_gender', $options['opt_gender']);
}

// end functions

// if op = show_***, functions needed

//if (substr($op, 0, 4) == 'show') {
if (0 === strpos($op, 'show')) {
    $debut = isset($_GET['debut']) ? (int)$_GET['debut'] : 0;
    $param = isset($_GET['param']) ? $_GET['param'] : '';

    include_once __DIR__ . '/class/util.php';
    $GLOBALS['xoopsOption']['template_main'] = 'xfguestbook_index.tpl';
    include_once XOOPS_ROOT_PATH . '/header.php';
    include_once XOOPS_ROOT_PATH . '/class/pagenav.php';
    include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->dirname() . '/include/config.inc.php';
    $options = getOptions();

    $criteria = new Criteria('moderate', 0);
    $nbmsg    = $msgHandler->countMsg($criteria);

    $xoopsTpl->assign('msg_message_count', sprintf(MD_XFGUESTBOOK_THEREIS, '<b>' . $nbmsg . '</b>'));
    $xoopsTpl->assign('msg_moderated', $xoopsModuleConfig['moderate']);
    $xoopsTpl->assign('msg_lang_name', $xoopsConfig['language']);
    $xoopsTpl->assign('xoops_pagetitle', $xoopsModule->name() . ' -messages');
    if ($adminview) {
        $nbwait = $msgHandler->countMsg(new Criteria('moderate', '1'));
        $xoopsTpl->assign('msg_moderate_text', sprintf(MD_XFGUESTBOOK_MODERATING, "<font class='fg2'><a href='" . XOOPS_URL . "/modules/xfguestbook/index.php?op=show_waiting'>" . $nbwait . '</a></font>'));
    }
}

switch ($op) {
    case 'delete':

        if ($adminview) {
            include_once XOOPS_ROOT_PATH . '/header.php';
            delete($msg_id);

        } else {
            redirect_header('index.php', 1, '');
        }
        break;

    case 'approve':

        if ($adminview) {
            include_once XOOPS_ROOT_PATH . '/header.php';
            approve($msg_id);

        } else {
            redirect_header('index.php', 1, '');
        }
        break;

    case 'show_stat':
        if ($options['opt_gender'] > 0) {
            xfgb_genderlist();
        }
        break;

    case 'show_waiting':

        $pagenav = new XoopsPageNav($nbwait, $xoopsModuleConfig['perpage'], $debut, 'debut', 'op=show_waiting');
        $xoopsTpl->assign('msg_page_nav', $pagenav->renderNav());
        $criteria = new Criteria('moderate', 1);
        $criteria->setOrder('DESC');
        $criteria->setLimit($xoopsModuleConfig['perpage']);
        $criteria->setStart($debut);
        $msg    =& $msgHandler->getObjects($criteria);
        $nbwait -= $debut;
        $nbmsg  = $nbwait;
        xfgb_getmsg($msg);
        break;

    case 'show_one':
        if ($adminview) {
            $criteria = new Criteria('msg_id', $msg_id);
        } else {
            $criteria = new CriteriaCompo(new Criteria('moderate', '0'));
            $criteria->add(new Criteria('msg_id', $msg_id));
        }
        $msg =& $msgHandler->getObjects($criteria);
        xfgb_getmsg($msg);
        if ($options['opt_gender'] > 0) {
            xfgb_genderlist();
        }
        break;

    case 'show_country':
        list($flagdir, $country) = explode('/', $param);
        $criteria = new CriteriaCompo(new Criteria('moderate', '0'));
        if ($flagdir == $xoopsModuleConfig['flagdir']) {
            $criteria->add(new Criteria('flagdir', $flagdir));
        }
        $criteria->add(new Criteria('country', $country));
        $nbmsg   = $msgHandler->countMsg($criteria);
        $pagenav = new XoopsPageNav($nbmsg, $xoopsModuleConfig['perpage'], $debut, 'debut', 'op=show_country&param=' . $param);
        $criteria->setOrder('DESC');
        $criteria->setLimit($xoopsModuleConfig['perpage']);
        $criteria->setStart($debut);
        $msg   =& $msgHandler->getObjects($criteria);
        $nbmsg -= $debut;
        $xoopsTpl->assign('msg_page_nav', $pagenav->renderNav());
        xfgb_getmsg($msg);
        break;

    case 'show_gender':
        $criteria = new CriteriaCompo(new Criteria('moderate', '0'));
        $criteria->add(new Criteria('gender', $param));
        $nbmsg   = $msgHandler->countMsg($criteria);
        $pagenav = new XoopsPageNav($nbmsg, $xoopsModuleConfig['perpage'], $debut, 'debut', 'op=show_gender&param=' . $param);
        $criteria->setOrder('DESC');
        $criteria->setLimit($xoopsModuleConfig['perpage']);
        $criteria->setStart($debut);
        $msg   =& $msgHandler->getObjects($criteria);
        $nbmsg -= $debut;
        $xoopsTpl->assign('msg_page_nav', $pagenav->renderNav());
        xfgb_getmsg($msg);
        if ($options['opt_gender'] > 0) {
            xfgb_genderlist();
        }
        break;

    case 'show_all':
    default:

        $pagenav = new XoopsPageNav($nbmsg, $xoopsModuleConfig['perpage'], $debut, 'debut', '');
        $xoopsTpl->assign('msg_page_nav', $pagenav->renderNav());
        $criteria = new Criteria('moderate', 0);
        $criteria->setOrder('DESC');
        $criteria->setLimit($xoopsModuleConfig['perpage']);
        $criteria->setStart($debut);
        $msg   =& $msgHandler->getObjects($criteria);
        $nbmsg -= $debut;
        xfgb_getmsg($msg);
        if ($options['opt_gender'] > 0) {
            xfgb_genderlist();
        }
        break;

    case 'cancel':

        $photos_dir     = XOOPS_UPLOAD_PATH . '/' . $xoopsModule->getVar('dirname');
        $nb_removed_tmp = XfguestbookUtil::clear_tmp_files($photos_dir);
        redirect_header('index.php', 0);
        break;
}
$sql = $xoopsDB->query('SELECT * FROM ' . $xoopsDB->prefix('xfguestbook_country') . ' ORDER BY country_name ASC');

while ($coun = $xoopsDB->fetchArray($sql)) {
    $sql2 = $xoopsDB->query('SELECT COUNT(country) tot FROM ' . $xoopsDB->prefix('xfguestbook_msg') . " WHERE country='" . $coun['country_code'] . '\'');
    list($tlocal) = $xoopsDB->fetchRow($sql2);
    $tlocal = $tlocal ?: '0';
    if ($tlocal > 0) {
        $opt['<a href="index.php?op=show_country&param=' . $xoopsModuleConfig['flagdir'] . '/' . $coun['country_code'] . '">' . $coun['country_name'] . '</a>'] = $tlocal;
    } else {
        $opt[$coun['country_name']] = $tlocal;
    }
}
$xoopsTpl->assign('country_l', $opt);

include XOOPS_ROOT_PATH . '/footer.php';


Pull Request — master (#10)

index.php ➔ xfgb_getmsg() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-06-14 00:00 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 53 and the first side effect is on line 26. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		//
3		// ------------------------------------------------------------------------ //
4		// XF Guestbook //
5		// ------------------------------------------------------------------------- //
6		// This program is free software; you can redistribute it and/or modify //
7		// it under the terms of the GNU General Public License as published by //
8		// the Free Software Foundation; either version 2 of the License, or //
9		// (at your option) any later version. //
10		// //
11		// You may not change or alter any portion of this comment or credits //
12		// of supporting developers from this source code or any supporting //
13		// source code which is considered copyrighted (c) material of the //
14		// original comment or credit authors. //
15		// //
16		// This program is distributed in the hope that it will be useful, //
17		// but WITHOUT ANY WARRANTY; without even the implied warranty of //
18		// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
19		// GNU General Public License for more details. //
20		// //
21		// You should have received a copy of the GNU General Public License //
22		// along with this program; if not, write metalslugto the Free Software //
23		// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA //
24		// ------------------------------------------------------------------------ //
25
26		include __DIR__ . '/../../mainfile.php';
27		//include_once(XOOPS_ROOT_PATH."/modules/".$xoopsModule->dirname()."/class/msg.php");
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-14 00:00 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
28		include_once XOOPS_ROOT_PATH . '/modules/' . $xoopsModule->dirname() . '/class/util.php';
29	View Code Duplication	if (isset($_GET['msg_id'])) {
		0 ignored issues – show Duplication introduced 2016-06-14 00:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
30		$msg_id = (int)$_GET['msg_id'];
31		} elseif (isset($_POST['msg_id'])) {
32		$msg_id = (int)$_POST['msg_id'];
33		} else {
34		$msg_id = 0;
35		}
36
37	View Code Duplication	if (isset($_GET['op'])) {

XoopsModules25x / xfguestbook

Pull Request — master (#10)

index.php ➔ xfgb_getmsg() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like