SysUtility::truncateHtml()   F
last analyzed

Complexity

Conditions 19
Paths 194

Size

Total Lines 89
Code Lines 47

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
eloc 47
dl 0
loc 89
rs 3.7333
c 2
b 0
f 0
cc 19
nc 194
nop 5

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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

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

185
            $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', /** @scrutinizer ignore-type */ '100%');
Loading history...
186
        }
187
188
        //        $form->addElement($descEditor);
189
190
        return $descEditor;
191
    }
192
193
    /**
194
     * @param $fieldname
195
     * @param $table
196
     *
197
     * @return bool
198
     */
199
    public static function fieldExists($fieldname, $table)
200
    {
201
        global $xoopsDB;
202
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");
203
204
        return ($xoopsDB->getRowsNum($result) > 0);
205
    }
206
207
    /**
208
     * @param array|string $tableName
209
     * @param int          $id_field
210
     * @param int          $id
211
     *
212
     * @return mixed
213
     */
214
    public static function cloneRecord($tableName, $id_field, $id)
215
    {
216
        $new_id = false;
217
        $table  = $GLOBALS['xoopsDB']->prefix($tableName);
218
        // copy content of the record you wish to clone
219
        $tempTable = $GLOBALS['xoopsDB']->fetchArray($GLOBALS['xoopsDB']->query("SELECT * FROM $table WHERE $id_field='$id' "), MYSQLI_ASSOC) or exit('Could not select record');
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
220
        // set the auto-incremented id's value to blank.
221
        unset($tempTable[$id_field]);
222
        // insert cloned copy of the original  record
223
        $result = $GLOBALS['xoopsDB']->queryF("INSERT INTO $table (" . implode(', ', array_keys($tempTable)) . ") VALUES ('" . implode("', '", array_values($tempTable)) . "')") or exit ($GLOBALS['xoopsDB']->error());
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
224
225
        if ($result) {
226
            // Return the new id
227
            $new_id = $GLOBALS['xoopsDB']->getInsertId();
228
        }
229
        return $new_id;
230
    }
231
232
    /**
233
     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
234
     *
235
     * @param string $folder The full path of the directory to check
236
     */
237
    public static function prepareFolder($folder)
238
    {
239
        try {
240
            if (!@\mkdir($folder) && !\is_dir($folder)) {
241
                throw new \RuntimeException(\sprintf('Unable to create the %s directory', $folder));
242
            }
243
            file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
244
        } catch (\Exception $e) {
245
            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
246
        }
247
    }
248
249
250
    /**
251
     * @param string $tablename
252
     *
253
     * @return bool
254
     */
255
    public static function tableExists($tablename)
256
    {
257
        $result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '$tablename'");
258
259
        return ($GLOBALS['xoopsDB']->getRowsNum($result) > 0) ? true : false;
260
    }
261
}
262