Utils::displayFlash() - Code Metrics - Inspection of "Merge pull request #598 from mambax7/feature/Publi..." - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 658b35...b781ca )

by Richard
created 2019-05-16 13:50 UTC
Utils::displayFlash() A

↳ Parent: Utils
Complexity

Conditions	6
Paths	5
Size

Total Lines	24
Code Lines	17
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	17
nc	5
nop	3
dl	0
loc	24
rs	9.0777
c	0
b	0
f	0
<?php

namespace XoopsModules\Publisher;

/*
 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.
 */

use Criteria;
use RuntimeException;
use Xmf\Module\Helper\Session;
use Xoops;
use Xoops\Core\Text\Sanitizer;
use XoopsBaseConfig;
use XoopsEditorHandler;
use XoopsLoad;
use XoopsLocale;
use XoopsModules\Publisher;

/**
 * @copyright       XOOPS Project (http://xoops.org)
 * @license         GNU GPL V2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package         Publisher
 * @since           1.0
 * @author          trabis <[email protected]>
 * @author          The SmartFactory <www.smartfactory.ca>
 * @author          trabis <[email protected]>
 */
class Utils
{
    /**
     * Includes scripts in HTML header
     */
    public static function cpHeader(): void
    {
        $xoops = Xoops::getInstance();
        $helper = Helper::getInstance();
        $xoops->header();

        $css = [];
        $css[] = $helper->path('css/publisher.css');
        $xoops->theme()->addBaseStylesheetAssets($css);

        $js = [];
        $js[] = $helper->path('js/funcs.js');
        $js[] = $helper->path('js/cookies.js');
        $js[] = $helper->path('js/ajaxupload.3.9.js');
        $js[] = $helper->path('js/publisher.js');
        $xoops->theme()->addBaseScriptAssets($js);
    }

    /**
     * Default sorting for a given order
     *
     * @param string $sort
     */
    public static function getOrderBy($sort): string
    {
        if (\in_array($sort, ['datesub', 'counter'])) {
            return 'DESC';
        }

        return 'ASC';
    }

    /**
     * @credits Thanks to Mithandir
     *
     * @param string $str
     * @param int    $start
     * @param int    $length
     * @param string $trimmarker
     */
    public static function substr($str, $start, $length, $trimmarker = '...'): string
    {
        // if the string is empty, let's get out ;-)
        if ('' == $str) {
            return $str;
        }

        // reverse a string that is shortened with '' as trimmarker
        $reversed_string = \strrev(XoopsLocale::substr($str, $start, $length, ''));

        // find first space in reversed string
        $position_of_space = \mb_strpos($reversed_string, ' ', 0);

        // truncate the original string to a length of $length
        // minus the position of the last space
        // plus the length of the $trimmarker
        $truncated_string = XoopsLocale::substr($str, $start, $length - $position_of_space + \mb_strlen($trimmarker), $trimmarker);

        return $truncated_string;
    }

    /**
     * @param string $document
     */
    public static function html2text($document): string
    {
        // PHP Manual:: function preg_replace
        // $document should contain an HTML document.
        // This will remove HTML tags, javascript sections
        // and white space. It will also convert some
        // common HTML entities to their text equivalent.
        // Credits : newbb2
        $search = [
            "'<script[^>]*?>.*?</script>'si", // Strip out javascript
            "'<img.*?>'si", // Strip out img tags
            "'<[\/\!]*?[^<>]*?>'si", // Strip out HTML tags
            "'([\r\n])[\s]+'", // Strip out white space
            "'&(quot|#34);'i", // Replace HTML entities
            "'&(amp|#38);'i",
            "'&(lt|#60);'i",
            "'&(gt|#62);'i",
            "'&(nbsp|#160);'i",
            "'&(iexcl|#161);'i",
            "'&(cent|#162);'i",
            "'&(pound|#163);'i",
            "'&(copy|#169);'i",
            "'&#(\d+);'e",
        ]; // evaluate as php

        $replace = [
            '',
            '',
            '',
            '\\1',
            '"',
            '&',
            '<',
            '>',
            ' ',
            \chr(161),
            \chr(162),
            \chr(163),
            \chr(169),
            'chr(\\1)',
        ];

        $text = \preg_replace($search, $replace, $document);

        return $text;
    }

    /**
     * @return string[]
     */
    public static function getAllowedImagesTypes(): array
    {
        return [
            'jpg/jpeg',
            'image/bmp',
            'image/gif',
            'image/jpeg',
            'image/jpg',
            'image/x-png',
            'image/png',
            'image/pjpeg',
        ];
    }

    /**
     * @param bool $withLink
     *
     * @return string
     */
    public static function moduleHome($withLink = true): ?string
    {
        $xoops = Xoops::getInstance();
        $helper = Helper::getInstance();

        if (!$helper->getConfig('format_breadcrumb_modname')) {
            return '';
        }

        if (!$withLink) {
            return $helper->getModule()->getVar('name');

        }

        return '<a href="' . $xoops->url(\PUBLISHER_URL) . '/">' . $helper->getModule()->getVar('name') . '</a>';
    }

    /**
     * Copy a file, or a folder and its contents
     *
     * @param string $source The source
     * @param string $dest   The destination
     *
     * @return bool Returns true on success, false on failure
     * @version     1.0.0
     *
     * @author      Aidan Lister <[email protected]>
     */
    public static function copyr($source, $dest): bool
    {
        // Simple copy for a file
        if (\is_file($source)) {
            return \copy($source, $dest);
        }

        // Make destination directory
        if (!\is_dir($dest)) {
            if (!\mkdir($dest) && !\is_dir($dest)) {
                throw new RuntimeException(\sprintf('Directory "%s" was not created', $dest));
            }
        }

        // Loop through the folder
        $dir = \dir($source);
        while (false !== $entry = $dir->read()) {
            // Skip pointers
            if ('.' === $entry || '..' === $entry) {
                continue;
            }

            // Deep copy directories
            if (\is_dir("$source/$entry") && ($dest !== "$source/$entry")) {
                self::copyr("$source/$entry", "$dest/$entry");
            } else {
                \copy("$source/$entry", "$dest/$entry");
            }
        }

        // Clean up
        $dir->close();

        return true;
    }

    /**
     * @credits Thanks to the NewBB2 Development Team
     * @param string $item
     * @param bool   $getStatus
     *
     * @return bool|int|string
     * @todo    check undefined string
     */
    public static function getPathStatus($item, $getStatus = false)
    {
        $helper = Helper::getInstance();
        if ('root' === $item) {
            $path = '';
        } else {
            $path = $item;
        }

        $thePath = self::getUploadDir(true, $path);

        if (empty($thePath)) {
            return false;
        }
        if (@\is_writable($thePath)) {
            $pathCheckResult = 1;
            $path_status = _AM_PUBLISHER_AVAILABLE;
        } elseif (!@\is_dir($thePath)) {
            $pathCheckResult = -1;
            $path_status = _AM_PUBLISHER_NOTAVAILABLE . " <a href='" . $helper->url("admin/index.php?op=createdir&amp;path={$item}") . "'>" . _AM_PUBLISHER_CREATETHEDIR . '</a>';
        } else {
            $pathCheckResult = -2;
            $path_status = \_AM_PUBLISHER_NOTWRITABLE . " <a href='" . $helper->url("admin/index.php?op=setperm&amp;path={$item}") . "'>" . _AM_SCS_SETMPERM . '</a>';

        }
        if (!$getStatus) {
            return $path_status;
        }

        return $pathCheckResult;
    }

    /**
     * @credits Thanks to the NewBB2 Development Team
     *
     * @param string $target
     */
    public static function mkdir($target): bool
    {
        // http://www.php.net/manual/en/function.mkdir.php
        // saint at corenova.com
        // bart at cdasites dot com
        if (\is_dir($target) || empty($target)) {
            return true; // best case check first
        }

        if (XoopsLoad::fileExists($target) && !\is_dir($target)) {
            return false;
        }

        if (self::mkdir(\mb_substr($target, 0, \mb_strrpos($target, '/')))) {
            if (!XoopsLoad::fileExists($target)) {
                $res = \mkdir($target, 0777); // crawl back up & create dir tree
                self::chmod($target);

                return $res;
            }
        }
        $res = \is_dir($target);

        return $res;
    }

    /**
     * @credits Thanks to the NewBB2 Development Team
     *
     * @param string $target
     * @param int    $mode
     */
    public static function chmod($target, $mode = 0777): bool
    {
        return @\chmod($target, $mode);
    }

    /**
     * @param bool $hasPath
     * @param bool|string $item
     *
     * @return string
     */
    public static function getUploadDir($hasPath = true, $item = false): ?string
    {
        $xoops = Xoops::getInstance();
        if ($item) {
            if ('root' === $item) {
                $item = '';
            } else {
                $item = $item . '/';
                $item = /** @scrutinizer ignore-type */ $item . '/';
            }
        } else {
            $item = '';
        }

        if ($hasPath) {
            return $xoops->path(\PUBLISHER_UPLOADS_PATH . '/' . $item);
        }

        return $xoops->url(\PUBLISHER_UPLOADS_URL . '/' . $item);
    }

    /**
     * @param string $item
     * @param bool   $hasPath
     */
    public static function getImageDir($item = '', $hasPath = true): string
    {
        if ($item) {
            $item = "images/{$item}";
        } else {
            $item = 'images';
        }

        return self::getUploadDir($hasPath, $item);
    }

    /**
     * @param array $errors
     */
    public static function formatErrors($errors = []): string
    {
        $ret = '';
        foreach ($errors as $value) {
            $ret .= '<br> - ' . $value;
        }

        return $ret;
    }

    /**
     * Check is current user is author of a given article
     *
     * @param object $itemObj
     */
    public static function IsUserAuthor($itemObj): bool
    {
        $xoops = Xoops::getInstance();

        return ($xoops->isUser() && \is_object($itemObj) && ($xoops->user->getVar('uid') == $itemObj->getVar('uid')));
    }

    /**
     * Check is current user is moderator of a given article
     *
     * @param Publisher\Item $itemObj
     */
    public static function IsUserModerator($itemObj): bool
    {
        $helper = Helper::getInstance();
        $categoriesGranted = $helper->getPermissionHandler()->getGrantedItems('category_moderation');

        return (\is_object($itemObj) && \in_array($itemObj->getVar('categoryid'), $categoriesGranted));
    }

    public static function IsUserAdmin(): bool
    {
        return Helper::getInstance()->isUserAdmin();
    }

    /**
     * Saves permissions for the selected category
     *
     * @param array   $groups     : group with granted permission
     * @param int $categoryid : categoryid on which we are setting permissions
     * @param string  $perm_name  : name of the permission
     *
     * @return bool : TRUE if the no errors occured
     * @todo Move to category class
     */
    public static function saveCategoryPermissions($groups, $categoryid, $perm_name): bool
    {
        $xoops = Xoops::getInstance();
        $helper = Helper::getInstance();

        $result = true;

        $module_id = $helper->getModule()->getVar('mid');
        $gpermHandler = $xoops->getHandlerGroupPermission();
        // First, if the permissions are already there, delete them
        $gpermHandler->deleteByModule($module_id, $perm_name, $categoryid);

        // Save the new permissions
        if (\count($groups) > 0) {
            foreach ($groups as $group_id) {
                $gpermHandler->addRight($perm_name, $categoryid, $group_id, $module_id);
            }
        }

        return $result;
    }

    /**
     * @param string $tablename
     * @param string $iconname
     * @param string $tabletitle
     * @param string $tabledsc
     * @param bool   $open
     */
    public static function openCollapsableBar($tablename = '', $iconname = '', $tabletitle = '', $tabledsc = '', $open = true): void
    {
        $helper = Helper::getInstance();
        $image = 'open12.gif';
        $display = 'none';
        if ($open) {
            $image = 'close12.gif';
            $display = 'block';
        }

        echo "<h3 style=\"color: #2F5376; font-weight: bold; font-size: 14px; margin: 6px 0 0 0; \"><a href='javascript:;' onclick=\"toggle('" . $tablename . "'); toggleIcon('" . $iconname . "')\";>";
        echo "<img id='" . $iconname . "' src='" . $helper->url('images/links/' . $image) . "' alt=''></a>&nbsp;" . $tabletitle . '</h3>';
        echo "<div id='" . $tablename . "' style='display: " . $display . ";'>";
        if ('' != $tabledsc) {
            echo '<span style="color: #567; margin: 3px 0 12px 0; font-size: small; display: block; ">' . $tabledsc . '</span>';
        }
    }

    /**
     * @param string $name
     * @param string $icon
     */
    public static function closeCollapsableBar($name, $icon): void
    {
        echo '</div>';

        $urls = self::getCurrentUrls();
        $path = $urls['phpself'];

        $cookie_name = $path . '_publisher_collaps_' . $name;
        $cookie_name = \str_replace('.', '_', $cookie_name);
        $cookie = self::getCookieVar($cookie_name, '');

        if ('none' === $cookie) {
            echo '
        <script type="text/javascript"><!--
        toggle("' . $name . '"); toggleIcon("' . $icon . '");
        //-->
        </script>
        ';
        }
    }

    /**
     * @param string $name
     * @param string $value
     * @param int    $time
     */
    public static function setCookieVar($name, $value, $time = 0): void
    {
        if (0 == $time) {
            $time = \time() + 3600 * 24 * 365;
        }
        \setcookie($name, $value, $time, '/');
    }

    /**
     * @param string $name
     * @param string $default
     *
     * @return string
     */
    public static function getCookieVar($name, $default = ''): ?string
    {
        if (isset($_COOKIE[$name]) && ($_COOKIE[$name] > '')) {
            return $_COOKIE[$name];
        }

        return $default;
    }

    public static function getCurrentUrls(): array
    {
        $http = false === \mb_strpos(XoopsBaseConfig::get('url'), 'https://') ? 'http://' : 'https://';
        $phpself = $_SERVER['PHP_SELF'];
        $httphost = $_SERVER['HTTP_HOST'];
        $querystring = $_SERVER['QUERY_STRING'] ?? '';

        if ('' != $querystring) {
            $querystring = '?' . $querystring;
        }

        $currenturl = $http . $httphost . $phpself . $querystring;

        $urls = [];
        $urls['http'] = $http;
        $urls['httphost'] = $httphost;
        $urls['phpself'] = $phpself;
        $urls['querystring'] = $querystring;
        $urls['full'] = $currenturl;

        return $urls;
    }

    public static function getCurrentPage(): string
    {
        $urls = self::getCurrentUrls();

        return $urls['full'];
    }

    /**
     * @param object    $categoryObj
     * @param int|array $selectedid
     * @param int       $level
     * @param string    $ret
     *
     * @todo move to ccategory class
     */
    public static function addCategoryOption($categoryObj, $selectedid = 0, $level = 0, $ret = ''): string
    {
        $helper = Helper::getInstance();

        $spaces = '';
        for ($j = 0; $j < $level; ++$j) {
            $spaces .= '--';
        }

        $ret .= "<option value='" . $categoryObj->getVar('categoryid') . "'";
        if (\is_array($selectedid) && \in_array($categoryObj->getVar('categoryid'), $selectedid)) {
            $ret .= " selected='selected'";
        } elseif ($categoryObj->getVar('categoryid') == $selectedid) {
            $ret .= " selected='selected'";
        }
        $ret .= '>' . $spaces . $categoryObj->getVar('name') . "</option>\n";

        $subCategoriesObj = $helper->getCategoryHandler()->getCategories(0, 0, $categoryObj->getVar('categoryid'));
        if (\count($subCategoriesObj) > 0) {
            ++$level;
            foreach ($subCategoriesObj as $subCategoryObj) {
                $ret .= self::addCategoryOption($subCategoryObj, $selectedid, $level);
            }
        }

        return $ret;
    }

    /**
     * @param int    $selectedid
     * @param int    $parentcategory
     * @param bool   $allCatOption
     * @param string $selectname
     *
     * @todo move to category class
     */
    public static function createCategorySelect($selectedid = 0, $parentcategory = 0, $allCatOption = true, $selectname = 'options[0]'): string
    {
        $helper = Helper::getInstance();

        $selectedid = \explode(',', $selectedid);

        $ret = "<select name='" . $selectname . "[]' multiple='multiple' size='10'>";
        if ($allCatOption) {
            $ret .= "<option value='0'";
            if (\in_array(0, $selectedid)) {
                $ret .= " selected='selected'";
            }
            $ret .= '>' . _MB_PUBLISHER_ALLCAT . '</option>';
        }

        // Creating category objects
        $categoriesObj = $helper->getCategoryHandler()->getCategories(0, 0, $parentcategory);

        if (\count($categoriesObj) > 0) {
            foreach ($categoriesObj as $catID => $categoryObj) {
                $ret .= self::addCategoryOption($categoryObj, $selectedid);
            }
        }
        $ret .= '</select>';

        return $ret;
    }

    /**
     * @param int  $selectedid
     * @param int  $parentcategory
     * @param bool $allCatOption
     *
     * @todo move to category class
     */
    public static function createCategoryOptions($selectedid = 0, $parentcategory = 0, $allCatOption = true): string
    {
        $helper = Helper::getInstance();

        $ret = '';
        if ($allCatOption) {
            $ret .= "<option value='0'";
            $ret .= '>' . _MB_PUBLISHER_ALLCAT . "</option>\n";
        }

        // Creating category objects
        $categoriesObj = $helper->getCategoryHandler()->getCategories(0, 0, $parentcategory);
        if (\count($categoriesObj) > 0) {
            foreach ($categoriesObj as $categoryObj) {
                $ret .= self::addCategoryOption($categoryObj, $selectedid);
            }
        }

        return $ret;
    }

    /**
     * @param array  $err_arr
     * @param string $reseturl
     *
     * @todo check this undefined strings
     */
    public static function renderErrors(&$err_arr, $reseturl = ''): void
    {
        if (\is_array($err_arr) && \count($err_arr) > 0) {
            echo '<div id="readOnly" class="errorMsg" style="border:1px solid #D24D00; background:#FEFECC url(' . \PUBLISHER_URL . '/images/important-32.png) no-repeat 7px 50%;color:#333;padding-left:45px;">';

            echo '<h4 style="text-align:left;margin:0; padding-top:0">' . _AM_PUBLISHER_MSG_SUBMISSION_ERR;


            if ($reseturl) {
                echo ' <a href="' . $reseturl . '">[' . _AM_PUBLISHER_TEXT_SESSION_RESET . ']</a>';

            }

            echo '</h4><ul>';

            foreach ($err_arr as $key => $error) {
                if (\is_array($error)) {
                    foreach ($error as $err) {
                        echo '<li><a href="#' . $key . '" onclick="var e = xoopsGetElementById(\'' . $key . '\'); e.focus();">' . \htmlspecialchars($err) . '</a></li>';
                    }
                } else {
                    echo '<li><a href="#' . $key . '" onclick="var e = xoopsGetElementById(\'' . $key . '\'); e.focus();">' . \htmlspecialchars($error) . '</a></li>';
                }
            }
            echo '</ul></div><br>';
        }
    }

    /**
     * Generate publisher URL
     *
     * @param string $page
     * @param array  $vars
     * @param bool   $encodeAmp
     *
     * @credit : xHelp module, developped by 3Dev
     */
    public static function makeURI($page, $vars = [], $encodeAmp = true): string
    {
        $joinStr = '';

        $amp = ($encodeAmp ? '&amp;' : '&');

        if (!\count($vars)) {
            return $page;
        }

        $qs = '';
        foreach ($vars as $key => $value) {
            $qs .= $joinStr . $key . '=' . $value;
            $joinStr = $amp;
        }

        return $page . '?' . $qs;
    }

    /**
     * @param string $subject
     */
    public static function tellafriend($subject = ''): string
    {
        $xoops = Xoops::getInstance();
        if (false !== \mb_strpos($subject, '%')) {
            $subject = \rawurldecode($subject);
        }
        $target_uri = $xoops->url($_SERVER['REQUEST_URI']);

        return $xoops->url('modules/tellafriend/index.php?target_uri=' . \rawurlencode($target_uri) . '&amp;subject=' . \rawurlencode($subject));
    }

    /**
     * @param bool $another
     * @param bool $withRedirect
     * @param      $itemObj
     *
     * @return bool|string
     */
    public static function uploadFile($another, $withRedirect, &$itemObj)
    {
        $xoops = Xoops::getInstance();

        $helper = Helper::getInstance();

        $itemid = isset($_POST['itemid']) ? (int)$_POST['itemid'] : 0;
        $uid = $xoops->isUser() ? $xoops->user->getVar('uid') : 0;
        $session = new Session();
        $session->set('publisher_file_filename', $_POST['item_file_name'] ?? '');
        $session->set('publisher_file_description', $_POST['item_file_description'] ?? '');
        $session->set('publisher_file_status', isset($_POST['item_file_status']) ? (int)$_POST['item_file_status'] : 1);
        $session->set('publisher_file_uid', $uid);
        $session->set('publisher_file_itemid', $itemid);

        if (!\is_object($itemObj)) {
            $itemObj = $helper->getItemHandler()->get($itemid);
        }

        $fileObj = $helper->getFileHandler()->create();
        $fileObj->setVar('name', $_POST['item_file_name'] ?? '');
        $fileObj->setVar('description', $_POST['item_file_description'] ?? '');
        $fileObj->setVar('status', isset($_POST['item_file_status']) ? (int)$_POST['item_file_status'] : 1);
        $fileObj->setVar('uid', $uid);
        $fileObj->setVar('itemid', $itemObj->getVar('itemid'));
        $fileObj->setVar('datesub', \time());

        // Get available mimetypes for file uploading
        $allowed_mimetypes = $helper->getMimetypeHandler()->getArrayByType();
        $allowed_mimetypes = $helper->getMimetypeHandler()->/** @scrutinizer ignore-call */ getArrayByType();
        // TODO : display the available mimetypes to the user
        $errors = [];
        /* @var Publisher\File $fileObj */
        if ($helper->getConfig('perm_upload') && \is_uploaded_file($_FILES['item_upload_file']['tmp_name'])) {
            if (!$ret = $fileObj->checkUpload('item_upload_file', $allowed_mimetypes, $errors)) {

                $errorstxt = \implode('<br>', $errors);

                $message = \sprintf(_CO_PUBLISHER_MESSAGE_FILE_ERROR, $errorstxt);
                if ($withRedirect) {
                    $xoops->redirect('file.php?op=mod&itemid=' . $itemid, 5, $message);
                } else {
                    return $message;
                }
            }
        }

        // Storing the file
        if (!$fileObj->store($allowed_mimetypes)) {
            if ($withRedirect) {
                $xoops->redirect('file.php?op=mod&itemid=' . $fileObj->getVar('itemid'), 3, _CO_PUBLISHER_FILEUPLOAD_ERROR . self::formatErrors($fileObj->getErrors()));
            } else {
                return _CO_PUBLISHER_FILEUPLOAD_ERROR . self::formatErrors($fileObj->getErrors());
            }
        }

        if ($withRedirect) {
            $redirect_page = $another ? 'file.php' : 'item.php';
            $xoops->redirect($redirect_page . '?op=mod&itemid=' . $fileObj->getVar('itemid'), 2, _CO_PUBLISHER_FILEUPLOAD_SUCCESS);
        }

        return true;
    }

    public static function newFeatureTag(): string
    {
        $ret = '<span style="padding-right: 4px; font-weight: bold; color: #ff0000;">' . _CO_PUBLISHER_NEW_FEATURE . '</span>';

        return $ret;
    }

    /**
     * Smarty truncate_tagsafe modifier plugin
     * Type:     modifier<br>
     * Name:     truncate_tagsafe<br>
     * Purpose:  Truncate a string to a certain length if necessary,
     *           optionally splitting in the middle of a word, and
     *           appending the $etc string or inserting $etc into the middle.
     *           Makes sure no tags are left half-open or half-closed
     *           (e.g. "Banana in a <a...")
     *
     * @param string
     * @param int
     * @param string
     * @param bool
     * @param bool
     * @param mixed $string
     * @param mixed $length
     * @param mixed $etc
     * @param mixed $break_words
     *
     * @return string
     * @author   Monte Ohrt <monte at ohrt dot com>, modified by Amos Robinson
     *           <amos dot robinson at gmail dot com>
     */
    public static function truncateTagSafe($string, $length = 80, $etc = '...', $break_words = false): ?string
    {
        if (0 == $length) {
            return '';
        }

        if (\mb_strlen($string) > $length) {
            $length -= \mb_strlen($etc);
            if (!$break_words) {
                $string = \preg_replace('/\s+?(\S+)?$/', '', \mb_substr($string, 0, $length + 1));
                $string = \preg_replace('/<[^>]*$/', '', $string);
                $string = self::closeTags($string);
            }

            return $string . $etc;
        }

        return $string;
    }

    /**
     * @param string $string
     *
     * @author   Monte Ohrt <monte at ohrt dot com>, modified by Amos Robinson
     *           <amos dot robinson at gmail dot com>
     */
    public static function closeTags($string): string
    {
        // match opened tags
        if (\preg_match_all('/<([a-z\:\-]+)[^\/]>/', $string, $start_tags)) {
            $start_tags = $start_tags[1];
            // match closed tags
            if (\preg_match_all('/<\/([a-z]+)>/', $string, $end_tags)) {
                $complete_tags = [];
                $end_tags = $end_tags[1];

                foreach ($start_tags as $val) {
                    $posb = \array_search($val, $end_tags);
                    if (\is_int($posb)) {
                        unset($end_tags[$posb]);
                    } else {
                        $complete_tags[] = $val;
                    }
                }
            } else {
                $complete_tags = $start_tags;
            }

            $complete_tags = \array_reverse($complete_tags);
            foreach ($complete_tags as $iValue) {
                $string .= '</' . $iValue . '>';
            }
        }

        return $string;
    }

    /**
     * @param int $itemid
     *
     * @return string
     */
    public static function ratingBar($itemid): ?string
    {
        $xoops = Xoops::getInstance();
        $helper = Helper::getInstance();
        $rating_unitwidth = 30;
        $units = 5;

        $criteria = new Criteria('itemid', $itemid);
        $ratingObjs = $helper->getRatingHandler()->getObjects($criteria);
        unset($criteria);

        $uid = $xoops->isUser() ? $xoops->user->getVar('uid') : 0;
        $count = \count($ratingObjs);
        $current_rating = 0;
        $voted = false;
        $ip = \getenv('REMOTE_ADDR');

        /* @var Publisher\Rating $ratingObj */
        foreach ($ratingObjs as $ratingObj) {
            $current_rating += $ratingObj->getVar('rate');
            if ($ratingObj->getVar('ip') == $ip || ($uid > 0 && $uid == $ratingObj->getVar('uid'))) {
                $voted = true;
            }
        }

        $tense = 1 == $count ? _MD_PUBLISHER_VOTE_lVOTE : _MD_PUBLISHER_VOTE_lVOTES; //plural form votes/vote

        // now draw the rating bar
        $rating_width = @\number_format($current_rating / $count, 2) * $rating_unitwidth;
        $rating1 = @\number_format($current_rating / $count, 1);
        $rating2 = @\number_format($current_rating / $count, 2);

        $groups = $xoops->getUserGroups();
        $gpermHandler = $helper->getGrouppermHandler();

        if (!$gpermHandler->checkRight('global', \_PUBLISHER_RATE, $groups, $helper->getModule()->getVar('mid'))) {
            $static_rater = [];
            $static_rater[] .= "\n" . '<div class="publisher_ratingblock">';
            $static_rater[] .= '<div id="unit_long' . $itemid . '">';
            $static_rater[] .= '<div id="unit_ul' . $itemid . '" class="publisher_unit-rating" style="width:' . $rating_unitwidth * $units . 'px;">';
            $static_rater[] .= '<div class="publisher_current-rating" style="width:' . $rating_width . 'px;">' . _MD_PUBLISHER_VOTE_RATING . ' ' . $rating2 . '/' . $units . '</div>';
            $static_rater[] .= '</div>';
            $static_rater[] .= '<div class="publisher_static">' . _MD_PUBLISHER_VOTE_RATING . ': <strong> ' . $rating1 . '</strong>/' . $units . ' (' . $count . ' ' . $tense . ') <br><em>' . _MD_PUBLISHER_VOTE_DISABLE . '</em></div>';
            $static_rater[] .= '</div>';
            $static_rater[] .= '</div>' . "\n\n";

            return \implode("\n", $static_rater);
        }

        $rater = '';
        $rater .= '<div class="publisher_ratingblock">';
        $rater .= '<div id="unit_long' . $itemid . '">';
        $rater .= '<div id="unit_ul' . $itemid . '" class="publisher_unit-rating" style="width:' . $rating_unitwidth * $units . 'px;">';
        $rater .= '<div class="publisher_current-rating" style="width:' . $rating_width . 'px;">' . _MD_PUBLISHER_VOTE_RATING . ' ' . $rating2 . '/' . $units . '</div>';

        for ($ncount = 1; $ncount <= $units; ++$ncount) { // loop from 1 to the number of units
            if (!$voted) { // if the user hasn't yet voted, draw the voting stars
                $rater .= '<div><a href="' . \PUBLISHER_URL . '/rate.php?itemid=' . $itemid . '&amp;rating=' . $ncount . '" title="' . $ncount . ' ' . _MD_PUBLISHER_VOTE_OUTOF . ' ' . $units . '" class="publisher_r' . $ncount . '-unit rater" rel="nofollow">' . $ncount . '</a></div>';
            }
        }

        $rater .= '  </div>';
        $rater .= '  <div';

        if ($voted) {
            $rater .= ' class="publisher_voted"';
        }

        $rater .= '>' . _MD_PUBLISHER_VOTE_RATING . ': <strong> ' . $rating1 . '</strong>/' . $units . ' (' . $count . ' ' . $tense . ')';
        $rater .= '  </div>';
        $rater .= '</div>';
        $rater .= '</div>';

        return $rater;
    }

    /**
     * @param array $allowed_editors
     */
    public static function getEditors($allowed_editors = null): array
    {
        $ret = [];
        $nohtml = false;
        $editorHandler = XoopsEditorHandler::getInstance();
        $editors = $editorHandler->getList($nohtml);
        foreach ($editors as $name => $title) {
            $key = self::stringToInt($name);
            if (\is_array($allowed_editors)) {
                //for submit page
                if (\in_array($key, $allowed_editors)) {
                    $ret[] = $name;
                }
            } else {
                //for admin permissions page
                $ret[$key]['name'] = $name;
                $ret[$key]['title'] = $title;
            }
        }

        return $ret;
    }

    /**
     * @param string $string
     * @param int    $length
     */
    public static function stringToInt($string = '', $length = 5): int
    {
        for ($i = 0, $final = '', $string = \mb_substr(\md5($string), $length); $i < $length; $final .= (int)$string[$i], ++$i) {
        }

        return (int)$final;
    }

    /**
     * @param string $item
     *
     * @return string
     */
    public static function convertCharset($item): ?string
    {
        if ('UTF-8' === XoopsLocale::getCharset()) {
            return $item;
        }

        if ('windows-1256' !== XoopsLocale::getCharset()) {
            return utf8_encode($item);
        }

        if ($unserialize = \unserialize($item)) {
            foreach ($unserialize as $key => $value) {
                $unserialize[$key] = @iconv('windows-1256', 'UTF-8', $value);
            }
            $serialize = \serialize($unserialize);

            return $serialize;
        }

        return @iconv('windows-1256', 'UTF-8', $item);
    }

    /**
     * @param string $title
     * @param bool   $withExt
     * @return string|string[]|null
     */

    /**
     * @param string $title
     * @param bool   $withExt
     * @return string|string[]|null
     */
    public static function seoTitle($title = '', $withExt = true)
    {
        /**
         * if XOOPS ML is present, let's sanitize the title with the current language
         */
        $myts = Sanitizer::getInstance();
        if (\method_exists($myts, 'formatForML')) {
            $title = $myts->formatForML($title);
        }

        // Transformation de la chaine en minuscule
        // Codage de la chaine afin d'éviter les erreurs 500 en cas de caractères imprévus
        $title = \rawurlencode(\mb_strtolower($title));

        // Transformation des ponctuations
        //                 Tab     Space      !        "        #        %        &        '        (        )        ,        /        :        ;        <        =        >        ?        @        [        \        ]        ^        {        |        }        ~       .
        $pattern = [
            '/%09/',
            '/%20/',
            '/%21/',
            '/%22/',
            '/%23/',
            '/%25/',
            '/%26/',
            '/%27/',
            '/%28/',
            '/%29/',
            '/%2C/',
            '/%2F/',
            '/%3A/',
            '/%3B/',
            '/%3C/',
            '/%3D/',
            '/%3E/',
            '/%3F/',
            '/%40/',
            '/%5B/',
            '/%5C/',
            '/%5D/',
            '/%5E/',
            '/%7B/',
            '/%7C/',
            '/%7D/',
            '/%7E/',
            "/\./",
        ];
        $rep_pat = [
            '-',
            '-',
            '',
            '',
            '',
            '-100',
            '',
            '-',
            '',
            '',
            '',
            '-',
            '',
            '',
            '',
            '-',
            '',
            '',
            '-at-',
            '',
            '-',
            '',
            '-',
            '',
            '-',
            '',
            '-',
            '',
        ];
        $title = \preg_replace($pattern, $rep_pat, $title);

        // Transformation des caractères accentués
        //                  è        é        ê        ë        ç        à        â        ä        î        ï        ù        ü        û        ô        ö
        $pattern = [
            '/%B0/',
            '/%E8/',
            '/%E9/',
            '/%EA/',
            '/%EB/',
            '/%E7/',
            '/%E0/',
            '/%E2/',
            '/%E4/',
            '/%EE/',
            '/%EF/',
            '/%F9/',
            '/%FC/',
            '/%FB/',
            '/%F4/',
            '/%F6/',
        ];
        $rep_pat = ['-', 'e', 'e', 'e', 'e', 'c', 'a', 'a', 'a', 'i', 'i', 'u', 'u', 'u', 'o', 'o'];
        $title = \preg_replace($pattern, $rep_pat, $title);

        if (\count($title) > 0) {
        if (\count(/** @scrutinizer ignore-type */ $title) > 0) {
            if ($withExt) {
                $title .= '.html';
            }

            return $title;
        }

        return '';
    }

    /**
     * seoGenUrl
     *
     * @param string  $op
     * @param int $id
     * @param string  $short_url
     *
     * @return string
     */
    public static function seoGenUrl($op, $id, $short_url = ''): ?string
    {
        $helper = Helper::getInstance();
        if ('none' !== $helper->getConfig('seo_url_rewrite')) {
            if (!empty($short_url)) {
                $short_url = $short_url . '.html';
            }

            if ('htaccess' === $helper->getConfig('seo_url_rewrite')) {
                // generate SEO url using htaccess
                return XoopsBaseConfig::get('url') . '/' . $helper->getConfig('seo_module_name') . ".${op}.${id}/${short_url}";
            }

            if ('path-info' === $helper->getConfig('seo_url_rewrite')) {
                // generate SEO url using path-info
                return $helper->url("index.php/${op}.${id}/${short_url}");
            }

            die('Unknown SEO method.');

        }
        // generate classic url
        switch ($op) {
                case 'category':
                    return $helper->url("${op}.php?categoryid=${id}");
                case 'item':
                case 'print':
                    return $helper->url("${op}.php?itemid=${id}");
                default:
                    die('Unknown SEO operation.');

            }
    }

    /**
     * @param string $url
     * @param int    $width
     * @param int    $height
     */
    public static function displayFlash($url, $width = 0, $height = 0): string
    {
        if (!$width || !$height) {
            if (!$dimension = @\getimagesize($url)) {
                return "<a href='{$url}' target='_blank'>{$url}</a>";
            }
            if (!$width) {
                $height = $dimension[1] * $width / $dimension[0];
            } elseif (!empty($height)) {
                $width = $dimension[0] * $height / $dimension[1];
            } else {
                [$width, $height] = [$dimension[0], $dimension[1]];
            }
        }

        $rp = "<object width='{$width}' height='{$height}' classid='clsid:D27CDB6E-AE6D-11cf-96B8-444553540000' codebase='http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=5,0,0,0'>";
        $rp .= "<param name='movie' value='{$url}'>";
        $rp .= "<param name='QUALITY' value='high'>";
        $rp .= "<PARAM NAME='bgcolor' VALUE='#FFFFFF'>";
        $rp .= "<param name='wmode' value='transparent'>";
        $rp .= "<embed src='{$url}' width='{$width}' height='{$height}' quality='high' bgcolor='#FFFFFF' wmode='transparent'  pluginspage='http://www.macromedia.com/go/getflashplayer' type='application/x-shockwave-flash'></embed>";
        $rp .= '</object>';

        return $rp;
    }
}

XOOPS / XoopsCore

Push — master ( 658b35...b781ca )

Utils::displayFlash() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
