Passed
Pull Request — master (#11)
by Michael
01:53
created

SysUtility   A

Complexity

Total Complexity 25

Size/Duplication

Total Lines 158
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 73
dl 0
loc 158
rs 10
c 1
b 0
f 0
wmc 25

3 Methods

Rating   Name   Duplication   Size   Complexity  
A getEditor() 0 26 5
A fieldExists() 0 5 1
F truncateHtml() 0 87 19
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
/** @var Helper $helper */
31
32
/**
33
 * Class SysUtility
34
 */
35
class SysUtility
36
{
37
    use VersionChecks;
0 ignored issues
show
introduced by
The trait XoopsModules\Xsitemap\Common\VersionChecks requires some properties which are not provided by XoopsModules\Xsitemap\Common\SysUtility: $tag_name, $prerelease
Loading history...
38
39
    //checkVerXoops, checkVerPhp Traits
40
    use ServerStats;
41
42
    // getServerStats Trait
43
    use FilesManagement;
44
45
    // Files Management Trait
46
47
    /**
48
     * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags
49
     * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags
50
     * www.cakephp.org
51
     *
52
     * @param string $text         String to truncate.
53
     * @param int    $length       Length of returned string, including ellipsis.
54
     * @param string $ending       Ending to be appended to the trimmed string.
55
     * @param bool   $exact        If false, $text will not be cut mid-word
56
     * @param bool   $considerHtml If true, HTML tags would be handled correctly
57
     *
58
     * @return string Trimmed string.
59
     */
60
    public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true)
61
    {
62
        if ($considerHtml) {
63
            // if the plain text is shorter than the maximum length, return the whole text
64
            if (mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) {
65
                return $text;
66
            }
67
            // splits all html-tags to scanable lines
68
            \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER);
69
            $total_length = mb_strlen($ending);
70
            $open_tags    = [];
71
            $truncate     = '';
72
            foreach ($lines as $line_matchings) {
73
                // if there is any html-tag in this line, handle it and add it (uncounted) to the output
74
                if (!empty($line_matchings[1])) {
75
                    // if it's an "empty element" with or without xhtml-conform closing slash
76
                    if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) {
77
                        // do nothing
78
                        // if tag is a closing tag
79
                    } elseif (\preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) {
80
                        // delete tag from $open_tags list
81
                        $pos = \array_search($tag_matchings[1], $open_tags, true);
82
                        if (false !== $pos) {
83
                            unset($open_tags[$pos]);
84
                        }
85
                        // if tag is an opening tag
86
                    } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) {
87
                        // add tag to the beginning of $open_tags list
88
                        \array_unshift($open_tags, mb_strtolower($tag_matchings[1]));
89
                    }
90
                    // add html-tag to $truncate'd text
91
                    $truncate .= $line_matchings[1];
92
                }
93
                // calculate the length of the plain text part of the line; handle entities as one character
94
                $content_length = mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2]));
95
                if ($total_length + $content_length > $length) {
96
                    // the number of characters which are left
97
                    $left            = $length - $total_length;
98
                    $entities_length = 0;
99
                    // search for html entities
100
                    if (\preg_match_all('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', $line_matchings[2], $entities, \PREG_OFFSET_CAPTURE)) {
101
                        // calculate the real length of all entities in the legal range
102
                        foreach ($entities[0] as $entity) {
103
                            if ($left >= $entity[1] + 1 - $entities_length) {
104
                                $left--;
105
                                $entities_length += mb_strlen($entity[0]);
106
                            } else {
107
                                // no more characters left
108
                                break;
109
                            }
110
                        }
111
                    }
112
                    $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length);
113
                    // maximum lenght is reached, so get off the loop
114
                    break;
115
                }
116
                $truncate     .= $line_matchings[2];
117
                $total_length += $content_length;
118
                // if the maximum length is reached, get off the loop
119
                if ($total_length >= $length) {
120
                    break;
121
                }
122
            }
123
        } else {
124
            if (mb_strlen($text) <= $length) {
125
                return $text;
126
            }
127
            $truncate = mb_substr($text, 0, $length - mb_strlen($ending));
128
        }
129
        // if the words shouldn't be cut in the middle...
130
        if (!$exact) {
131
            // ...search the last occurance of a space...
132
            $spacepos = mb_strrpos($truncate, ' ');
133
            if (isset($spacepos)) {
134
                // ...and cut the text in this position
135
                $truncate = mb_substr($truncate, 0, $spacepos);
136
            }
137
        }
138
        // add the defined ending to the text
139
        $truncate .= $ending;
140
        if ($considerHtml) {
141
            // close all unclosed html-tags
142
            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...
143
                $truncate .= '</' . $tag . '>';
144
            }
145
        }
146
        return $truncate;
147
    }
148
149
    /**
150
     * @param \Xmf\Module\Helper $helper
151
     * @param array|null         $options
152
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor
153
     */
154
    public static function getEditor($helper = null, $options = null)
155
    {
156
        if (null === $options) {
157
            $options           = [];
158
            $options['name']   = 'Editor';
159
            $options['value']  = 'Editor';
160
            $options['rows']   = 10;
161
            $options['cols']   = '100%';
162
            $options['width']  = '100%';
163
            $options['height'] = '400px';
164
        }
165
        if (null === $helper) {
166
            $helper = Helper::getInstance();
167
        }
168
        $isAdmin = $helper->isUserAdmin();
169
        if (\class_exists('XoopsFormEditor')) {
170
            if ($isAdmin) {
171
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea');
172
            } else {
173
                $descEditor = new \XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea');
174
            }
175
        } else {
176
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', '100%');
0 ignored issues
show
Bug introduced by
'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

176
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', /** @scrutinizer ignore-type */ '100%');
Loading history...
Bug introduced by
'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

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