Passed
Push — master ( 077fbd...836ec9 )
by Michael
04:09
created

SysUtility::getEditor()   A

Complexity

Conditions 4
Paths 6

Size

Total Lines 28
Code Lines 17

Duplication

Lines 0
Ratio 0 %

Importance

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

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

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