XoopsModules25x / xoopspoll

admin/utility.php

<?php declare(strict_types=1);
/*
               XOOPS - PHP Content Management System
                   Copyright (c) 2000-2020 XOOPS.org
                      <https://xoops.org>
 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 to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

/**
 * Administration menu for the XoopsPoll Module
 *
 * @copyright ::  {@link https://xoops.org/ XOOPS Project}
 * @license   :: {@link https://www.gnu.org/licenses/gpl-2.0.html GNU GPL 2.0 or later}
 * @subpackage:: admin
 * @since     :: 1.40
 * @author    :: XOOPS Module Team
 */

use Xmf\Module\Admin;
use Xmf\Request;
use XoopsModules\Xoopspoll\{
    Constants,
    Helper,
    Utility
};

require_once __DIR__ . '/admin_header.php';

$helper = Helper::getInstance();

$op = Request::getString('op', 'list');
switch ($op) {
    case 'list':
    default:
        xoops_cp_header();
        $adminObject = Admin::getInstance();

        $GLOBALS['xoopsTpl']->assign('navigation', $adminObject->displayNavigation(basename(__FILE__)));

        $adminObject->addItemButton(_AM_XOOPSPOLL_IMPORT_UMFRAGE, 'utility.php' . '?op=umfrage', $icon = 'download');
        $GLOBALS['xoopsTpl']->assign('addPollButton', $adminObject->displayButton('left'));

        $GLOBALS['xoopsTpl']->assign('umfrageIntro', _AM_XOOPSPOLL_UMFRAGE_INTRO);
        $GLOBALS['xoopsTpl']->display($helper->path('templates/admin/xoopspoll_utility.tpl'));

        require_once __DIR__ . '/admin_header.php';
        break;
    /* Import data from umfrage */
    case 'umfrage':
        $ok = Request::getString('ok', Constants::CONFIRM_NOT_OK, 'POST');
        if ($ok) {
            if (!$GLOBALS['xoopsSecurity']->check()) {
                redirect_header($_SERVER['SCRIPT_NAME'], Constants::REDIRECT_DELAY_MEDIUM, implode('<br>', $GLOBALS['xoopsSecurity']->getErrors()));
            }
            // first check to see if umfrage module is installed and active
            /** @var \XoopsModuleHandler $moduleHandler */
            $moduleHandler = xoops_getHandler('module');
            $umModule      = $moduleHandler->getByDirname('umfrage');

            try {
                if (false !== $umModule && $umModule->isactive()) {
                    // make sure the umfrage database tables exist
                    /** @var \XoopsConfigHandler $configHandler */
                    $configHandler  = xoops_getHandler('config');
                    $umModuleConfig = $configHandler->getConfigsByCat(0, $umModule->getVar('mid'));
                    $success        = false;
                    $umTables       = &$umModule->getInfo('tables');
                    foreach ($umTables as $umTable) {
                        $s = Utility::dbTableExists($GLOBALS['xoopsDB'], $umTable);
                        if (!$s) {
                            throw new Exception("Could not find the umfrage db table ({$umTable})");
                        }
                    }

                    //setup poll objects for both umfrage and xoopspoll
                    require_once $GLOBALS['xoops']->path('modules/umfrage/class/umfrage.php');
                    require_once $GLOBALS['xoops']->path('modules/umfrage/class/umfrageoption.php');
                    require_once $GLOBALS['xoops']->path('modules/umfrage/class/umfragelog.php');

                    $xpHandler    = $helper->getHandler('Poll');
                    $xpOptHandler = $helper->getHandler('Option');
                    $xpLogHandler = $helper->getHandler('Log');

                    // maps umfrage_desc : polltype to xoopspoll_desc : visibility
                    $typeToVisMap = [
                        1 => Constants::HIDE_NEVER,
                        2 => Constants::HIDE_ALWAYS,
                        3 => Constants::HIDE_VOTED,
                    ];

                    $err                = [];
                    $umContainer        = new Umfrage();

The type Umfrage was not found. Maybe you did not declare it correctly or list all dependencies?

                    $umOptContainer     = new UmfrageOption();

The type UmfrageOption was not found. Maybe you did not declare it correctly or list all dependencies?

                    $umLogContainer     = new UmfrageLog();

The type UmfrageLog was not found. Maybe you did not declare it correctly or list all dependencies?

                    $allUmfragePollObjs = $umContainer->getAll();
                    foreach ($allUmfragePollObjs as $umPollObj) {
                        // make sure we don't have this question already (pretty strict comparison)
                        $criteria = new \CriteriaCompo();
                        $criteria->add(new \Criteria('question', trim($umPollObj->getVar('question')), '='));
                        $criteria->setLimit(1);
                        $pollExists = $xpHandler->getCount($criteria);
                        if (0 === $pollExists) {
                            // set the visibility for the poll
                            if (array_key_exists((int)$umPollObj->getVar('polltype'), $typeToVisMap)) {
                                $visibility = $typeToVisMap[$umPollObj->getVar('polltype')];
                            } else {
                                $visibility = Constants::HIDE_END;
                            }
                            // save the poll into Xoopspoll database
                            $xpValues = [
                                'question'    => $umPollObj->getVar('question'),
                                'description' => $umPollObj->getVar('description'),
                                'user_id'     => $umPollObj->getVar('user_id'),
                                'start_time'  => $umPollObj->getVar('start_time'),
                                'end_time'    => $umPollObj->getVar('end_time'),
                                'votes'       => (int)$umPollObj->getVar('votes'),
                                'voters'      => (int)$umPollObj->getVar('voters'),
                                'multiple'    => $umPollObj->getVar('multiple'),
                                'multilimit'  => $umPollObj->getVar('multilimit'),
                                'display'     => $umPollObj->getVar('display'),
                                'visibility'  => $visibility,
                                'weight'      => $umPollObj->getVar('weight'),
                                'mail_status' => $umPollObj->getVar('mail_status'),
                                'mail_voter'  => $umPollObj->getVar('mail_voter'),
                            ];
                            $xpObj    = $xpHandler->create();
                            $xpObj->setVars($xpValues);
                            $newXpId = $xpHandler->insert($xpObj);

                            if ($newXpId) {
                                $optionIdMap = [];
                                /* get the options for this poll and insert them */
                                $umOptObjs = $umOptContainer->getAllByPollId($umPollObj->getVar('poll_id'));
                                if (!$umOptObjs) {
                                    throw new Exception('Could not find options for the ' . $umPollObj->getVar('question') . ' poll.');
                                }
                                foreach ($umOptObjs as $umOptObj) {
                                    $optValues = [
                                        'poll_id'      => $newXpId,
                                        'option_text'  => $umOptObj->getVar('option_text'),
                                        'option_count' => $umOptObj->getVar('option_count'),
                                        'option_color' => $umOptObj->getVar('option_color'),
                                    ];
                                    $xpOptObj  = $xpOptHandler->create();
                                    $xpOptObj->setVars($optValues);
                                    $newXpOptId = $xpOptHandler->insert($xpOptObj);

                                    if ($newXpOptId) {
                                        $newOptId               = $newXpOptId;
                                        $oldOptId               = $umOptObj->getVar('option_id');
                                        $optionIdMap[$oldOptId] = $newOptId;
                                    } else {
                                        throw new Exception(sprintf(_AM_XOOPSPOLL_OPTION_FAILED, $umOptObj->getVar('option_text'), $umPollObj->getVar('question'), '<br>' . $xpOptObj->getHtmlErrors()));
                                    }
                                }
                                // now update the log for this poll
                                $allUmfrageLogObjs = $umLogContainer->getAllByPollId($umPollObj->getVar('poll_id'));
                                foreach ($allUmfrageLogObjs as $umLogObj) {
                                    $logValues = [
                                        'poll_id'   => $newXpId,
                                        'option_id' => $optionIdMap[$umLogObj->getVar('option_id')],
                                        'ip'        => $umLogObj->getVar('ip'),
                                        'user_id'   => $umLogObj->getVar('user_id'),
                                        'time'      => $umLogObj->getVar('time'),
                                    ];
                                    $xpLogObj  = $xpLogHandler->create();
                                    $xpLogObj->setVars($logValues);
                                    $newLogId = $xpLogHandler->insert($xpLogObj);
                                    if (!$newLogId) {
                                        throw new Exception(sprintf(_AM_XOOPSPOLL_LOG_FAILED, $umPollObj->getVar('question') . '<br>' . $xpLogObj->getHtmlErrors()));
                                    }
                                }
                                unset($optionIdMap, $umOptObjs, $allUmfrageLogObjs);
                            } else {
                                throw new Exception(sprintf(_AM_XOOPSPOLL_QUESTION_FAILED, $umPollObj->getVar('question'), '<br>' . $xpObj->getHtmlErrors()));
                            }
                        } else {
                            throw new Exception(sprintf(_AM_XOOPSPOLL_QUESTION_IMPORT_FAILED, $umPollObj->getVar('question'), '<br>' . $umPollObj->getHtmlErrors()));
                        }
                        unset($criteria, $umOptObjs);
                    }
                    redirect_header('index.php', Constants::REDIRECT_DELAY_MEDIUM, sprintf(_AM_XOOPSPOLL_IMPORT_SUCCESS, count($allUmfragePollObjs)));
                } else {
                    throw new Exception(_AM_XOOPSPOLL_UMFRAGE_FAILED);
                }
            } catch (\Exception $e) {
                xoops_cp_header();
                $adminObject = Admin::getInstance();
                echo $adminObject->displayNavigation(basename(__FILE__));
                echo "<div class='floatcenter1'>" . xoops_error($e->getMessage(), _AM_XOOPSPOLL_IMPORT_FAILED) . "</div>\n";

Are you sure the usage of xoops_error($e->getMessage(), _AM_XOOPSPOLL_IMPORT_FAILED) is correct as it seems to always return null.

Are you sure xoops_error($e->getMessage(), _AM_XOOPSPOLL_IMPORT_FAILED) of type void can be used in concatenation?

                require_once __DIR__ . '/admin_footer.php';
                exit();
            }
        } else {
            xoops_cp_header();
            $adminObject = Admin::getInstance();
            echo $adminObject->displayNavigation(basename(__FILE__));
            xoops_confirm(['op' => 'umfrage', 'ok' => 1], $_SERVER['SCRIPT_NAME'], _AM_XOOPSPOLL_RUSUREUMFRAGE);
            require_once __DIR__ . '/admin_footer.php';
            exit();
        }
        break;
}
require_once __DIR__ . '/admin_footer.php';