SysUtility::getEditor()   A
last analyzed

Complexity

Conditions 5
Paths 12

Size

Total Lines 32
Code Lines 19

Duplication

Lines 0
Ratio 0 %

Importance

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

184
            $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

184
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], /** @scrutinizer ignore-type */ '100%', '100%');
Loading history...
185
        }
186
187
        //        $form->addElement($descEditor);
188
189
        return $descEditor;
190
    }
191
192
    /**
193
     * @param $fieldname
194
     * @param $table
195
     *
196
     * @return bool
197
     */
198
    public function fieldExists($fieldname, $table)
199
    {
200
        global $xoopsDB;
201
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");
202
203
        return ($xoopsDB->getRowsNum($result) > 0);
204
    }
205
}
206