Passed
Push — master ( c3fe63...2ac8fd )
by Michael
44s queued 11s
created

class/Common/SysUtility.php (4 issues)

1
<?php
2
3
namespace XoopsModules\Xsitemap\Common;
4
5
/*
6
 Utility Class Definition
7
8
 You may not change or alter any portion of this comment or credits of
9
 supporting developers from this source code or any supporting source code
10
 which is considered copyrighted (c) material of the original comment or credit
11
 authors.
12
13
 This program is distributed in the hope that it will be useful, but
14
 WITHOUT ANY WARRANTY; without even the implied warranty of
15
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16
 */
17
18
/**
19
 *
20
 * @license      https://www.fsf.org/copyleft/gpl.html GNU public license
21
 * @copyright    https://xoops.org 2000-2020 &copy; XOOPS Project
22
 * @author       ZySpec <[email protected]>
23
 * @author       Mamba <[email protected]>
24
 */
25
26
use MyTextSanitizer;
27
use XoopsFormDhtmlTextArea;
28
use XoopsFormTextArea;
29
use XoopsModules\Xsitemap\Helper;
30
31
/** @var Helper $helper */
32
33
/**
34
 * Class SysUtility
35
 */
36
class SysUtility
37
{
38
    use VersionChecks;
0 ignored issues
show
The trait XoopsModules\Xsitemap\Common\VersionChecks requires some properties which are not provided by XoopsModules\Xsitemap\Common\SysUtility: $tag_name, $prerelease
Loading history...
39
40
    //checkVerXoops, checkVerPhp Traits
41
    use ServerStats;
42
43
    // getServerStats Trait
44
    use FilesManagement;
45
46
    // Files Management Trait
47
48
    /**
49
     * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
50
     * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
51
     * www.cakephp.org
52
     *
53
     * @param string $text         String to truncate.
54
     * @param int    $length       Length of returned string, including ellipsis.
55
     * @param string $ending       Ending to be appended to the trimmed string.
56
     * @param bool   $exact        If false, $text will not be cut mid-word
57
     * @param bool   $considerHtml If true, HTML tags would be handled correctly
58
     *
59
     * @return string Trimmed string.
60
     */
61
    public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
62
    {
63
        if ($considerHtml) {
64
            // if the plain text is shorter than the maximum length, return the whole text
65
            if (mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
66
                return $text;
67
            }
68
            // splits all html-tags to scanable lines
69
            \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER);
70
            $total_length = mb_strlen($ending);
71
            $open_tags    = [];
72
            $truncate     = '';
73
            foreach ($lines as $line_matchings) {
74
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
75
                if (!empty($line_matchings[1])) {
76
                    // if it's an "empty element" with or without xhtml-conform closing slash
77
                    if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
78
                        // do nothing
79
                        // if tag is a closing tag
80
                    } elseif (\preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
81
                        // delete tag from $open_tags list
82
                        $pos = \array_search($tag_matchings[1], $open_tags, true);
83
                        if (false !== $pos) {
84
                            unset($open_tags[$pos]);
85
                        }
86
                        // if tag is an opening tag
87
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
88
                        // add tag to the beginning of $open_tags list
89
                        \array_unshift($open_tags, mb_strtolower($tag_matchings[1]));
90
                    }
91
                    // add html-tag to $truncate'd text
92
                    $truncate .= $line_matchings[1];
93
                }
94
                // calculate the length of the plain text part of the line; handle entities as one character
95
                $content_length = mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
96
                if ($total_length + $content_length > $length) {
97
                    // the number of characters which are left
98
                    $left            = $length - $total_length;
99
                    $entities_length = 0;
100
                    // search for html entities
101
                    if (\preg_match_all('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', $line_matchings[2], $entities, \PREG_OFFSET_CAPTURE)) {
102
                        // calculate the real length of all entities in the legal range
103
                        foreach ($entities[0] as $entity) {
104
                            if ($left >= $entity[1] + 1 - $entities_length) {
105
                                $left--;
106
                                $entities_length += mb_strlen($entity[0]);
107
                            } else {
108
                                // no more characters left
109
                                break;
110
                            }
111
                        }
112
                    }
113
                    $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length);
114
                    // maximum lenght is reached, so get off the loop
115
                    break;
116
                }
117
                $truncate     .= $line_matchings[2];
118
                $total_length += $content_length;
119
                // if the maximum length is reached, get off the loop
120
                if ($total_length >= $length) {
121
                    break;
122
                }
123
            }
124
        } else {
125
            if (mb_strlen($text) <= $length) {
126
                return $text;
127
            }
128
            $truncate = mb_substr($text, 0, $length - mb_strlen($ending));
129
        }
130
        // if the words shouldn't be cut in the middle...
131
        if (!$exact) {
132
            // ...search the last occurance of a space...
133
            $spacepos = mb_strrpos($truncate, ' ');
134
            if (isset($spacepos)) {
135
                // ...and cut the text in this position
136
                $truncate = mb_substr($truncate, 0, $spacepos);
137
            }
138
        }
139
        // add the defined ending to the text
140
        $truncate .= $ending;
141
        if ($considerHtml) {
142
            // close all unclosed html-tags
143
            foreach ($open_tags as $tag) {
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $open_tags does not seem to be defined for all execution paths leading up to this point.
Loading history...
144
                $truncate .= '</' . $tag . '>';
145
            }
146
        }
147
        return $truncate;
148
    }
149
150
    /**
151
     * @param \Xmf\Module\Helper $helper
152
     * @param array|null         $options
153
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor
154
     */
155
    public static function getEditor($helper = null, $options = null)
156
    {
157
        if (null === $options) {
158
            $options           = [];
159
            $options['name']   = 'Editor';
160
            $options['value']  = 'Editor';
161
            $options['rows']   = 10;
162
            $options['cols']   = '100%';
163
            $options['width']  = '100%';
164
            $options['height'] = '400px';
165
        }
166
        if (null === $helper) {
167
            $helper = Helper::getInstance();
168
        }
169
        $isAdmin = $helper->isUserAdmin();
170
        if (\class_exists('XoopsFormEditor')) {
171
            if ($isAdmin) {
172
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
173
            } else {
174
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
175
            }
176
        } else {
177
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', '100%');
0 ignored issues
show
'100%' of type string is incompatible with the type integer expected by parameter $rows of XoopsFormDhtmlTextArea::__construct(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

177
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], /** @scrutinizer ignore-type */ '100%', '100%');
Loading history...
'100%' of type string is incompatible with the type integer expected by parameter $cols of XoopsFormDhtmlTextArea::__construct(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

177
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', /** @scrutinizer ignore-type */ '100%');
Loading history...
178
        }
179
        //        $form->addElement($descEditor);
180
        return $descEditor;
181
    }
182
183
    /**
184
     * @param $fieldname
185
     * @param $table
186
     *
187
     * @return bool
188
     */
189
    public function fieldExists($fieldname, $table)
190
    {
191
        global $xoopsDB;
192
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");
193
        return ($xoopsDB->getRowsNum($result) > 0);
194
    }
195
}
196