Total Complexity | 72 |
Total Lines | 394 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like XoopsGTicket often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use XoopsGTicket, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
10 | class XoopsGTicket |
||
11 | { |
||
12 | public $_errors = array(); |
||
13 | public $_latest_token = ''; |
||
14 | public $messages = array(); |
||
15 | |||
16 | /** |
||
17 | * XoopsGTicket constructor. |
||
18 | */ |
||
19 | public function __construct() |
||
20 | { |
||
21 | global $xoopsConfig; |
||
22 | |||
23 | // language file |
||
24 | if (defined('XOOPS_ROOT_PATH') && !empty($xoopsConfig['language']) && false === strpos($xoopsConfig['language'], '/')) { |
||
25 | if (file_exists(dirname(__DIR__) . '/language/' . $xoopsConfig['language'] . '/gticket_messages.phtml')) { |
||
26 | include dirname(__DIR__) . '/language/' . $xoopsConfig['language'] . '/gticket_messages.phtml'; |
||
27 | } |
||
28 | } |
||
29 | |||
30 | // default messages |
||
31 | if (empty($this->messages)) { |
||
32 | $this->messages = array( |
||
33 | 'err_general' => 'GTicket Error', |
||
34 | 'err_nostubs' => 'No stubs found', |
||
35 | 'err_noticket' => 'No ticket found', |
||
36 | 'err_nopair' => 'No valid ticket-stub pair found', |
||
37 | 'err_timeout' => 'Time out', |
||
38 | 'err_areaorref' => 'Invalid area or referer', |
||
39 | 'fmt_prompt4repost' => 'error(s) found:<br><span style="background-color:red;font-weight:bold;color:white;">%s</span><br>Confirm it.<br>And do you want to post again?', |
||
40 | 'btn_repost' => 'repost'); |
||
41 | } |
||
42 | } |
||
43 | |||
44 | // render form as plain html |
||
45 | /** |
||
46 | * @param string $salt |
||
47 | * @param int $timeout |
||
48 | * @param string $area |
||
49 | * |
||
50 | * @return string |
||
51 | */ |
||
52 | public function getTicketHtml($salt = '', $timeout = 1800, $area = '') |
||
53 | { |
||
54 | return '<input type="hidden" name="XOOPS_G_TICKET" value="' . $this->issue($salt, $timeout, $area) . '" />'; |
||
55 | } |
||
56 | |||
57 | // returns an object of XoopsFormHidden including theh ticket |
||
58 | /** |
||
59 | * @param string $salt |
||
60 | * @param int $timeout |
||
61 | * @param string $area |
||
62 | * |
||
63 | * @return XoopsFormHidden |
||
64 | */ |
||
65 | public function getTicketXoopsForm($salt = '', $timeout = 1800, $area = '') |
||
66 | { |
||
67 | return new XoopsFormHidden('XOOPS_G_TICKET', $this->issue($salt, $timeout, $area)); |
||
68 | } |
||
69 | |||
70 | // add a ticket as Hidden Element into XoopsForm |
||
71 | /** |
||
72 | * @param $form |
||
73 | * @param string $salt |
||
74 | * @param int $timeout |
||
75 | * @param string $area |
||
76 | */ |
||
77 | public function addTicketXoopsFormElement(&$form, $salt = '', $timeout = 1800, $area = '') |
||
80 | } |
||
81 | |||
82 | // returns an array for xoops_confirm() ; |
||
83 | /** |
||
84 | * @param string $salt |
||
85 | * @param int $timeout |
||
86 | * @param string $area |
||
87 | * |
||
88 | * @return array |
||
89 | */ |
||
90 | public function getTicketArray($salt = '', $timeout = 1800, $area = '') |
||
93 | } |
||
94 | |||
95 | // return GET parameter string. |
||
96 | /** |
||
97 | * @param string $salt |
||
98 | * @param bool $noamp |
||
99 | * @param int $timeout |
||
100 | * @param string $area |
||
101 | * |
||
102 | * @return string |
||
103 | */ |
||
104 | public function getTicketParamString($salt = '', $noamp = false, $timeout = 1800, $area = '') |
||
107 | } |
||
108 | |||
109 | // issue a ticket |
||
110 | /** |
||
111 | * @param string $salt |
||
112 | * @param int $timeout |
||
113 | * @param string $area |
||
114 | * |
||
115 | * @return string |
||
116 | */ |
||
117 | public function issue($salt = '', $timeout = 1800, $area = '') |
||
118 | { |
||
119 | global $xoopsModule; |
||
120 | |||
121 | if ('' === $salt) { |
||
122 | $salt = '$2y$07$' . str_replace('+', '.', base64_encode(random_bytes(16))); |
||
123 | } |
||
124 | |||
125 | // create a token |
||
126 | list($usec, $sec) = explode(' ', microtime()); |
||
127 | $appendix_salt = empty($_SERVER['PATH']) ? XOOPS_DB_NAME : $_SERVER['PATH']; |
||
128 | $token = crypt($salt . $usec . $appendix_salt . $sec, $salt); |
||
129 | $this->_latest_token = $token; |
||
130 | |||
131 | if (empty($_SESSION['XOOPS_G_STUBS'])) { |
||
132 | $_SESSION['XOOPS_G_STUBS'] = array(); |
||
133 | } |
||
134 | |||
135 | // limit max stubs 10 |
||
136 | if (count($_SESSION['XOOPS_G_STUBS']) > 10) { |
||
137 | $_SESSION['XOOPS_G_STUBS'] = array_slice($_SESSION['XOOPS_G_STUBS'], -10); |
||
138 | } |
||
139 | |||
140 | // record referer if browser send it |
||
141 | $referer = empty($_SERVER['HTTP_REFERER']) ? '' : $_SERVER['REQUEST_URI']; |
||
142 | |||
143 | // area as module's dirname |
||
144 | if (!$area && isset($xoopsModule) && is_object($xoopsModule)) { |
||
145 | $area = $xoopsModule->getVar('dirname'); |
||
146 | } |
||
147 | |||
148 | // store stub |
||
149 | $_SESSION['XOOPS_G_STUBS'][] = array( |
||
150 | 'expire' => time() + $timeout, |
||
151 | 'referer' => $referer, |
||
152 | 'area' => $area, |
||
153 | 'token' => $token); |
||
154 | |||
155 | // paid md5ed token as a ticket |
||
156 | return md5($token . XOOPS_DB_PREFIX); |
||
157 | } |
||
158 | |||
159 | // check a ticket |
||
160 | /** |
||
161 | * @param bool $post |
||
162 | * @param string $area |
||
163 | * @param bool $allow_repost |
||
164 | * |
||
165 | * @return bool |
||
166 | */ |
||
167 | public function check($post = true, $area = '', $allow_repost = true) |
||
260 | } |
||
261 | } |
||
262 | |||
263 | // draw form for repost |
||
264 | /** |
||
265 | * @param string $area |
||
266 | */ |
||
267 | public function draw_repost_form($area = '') |
||
313 | } |
||
314 | |||
315 | /** |
||
316 | * @param $key_name |
||
317 | * @param $tmp_array |
||
318 | * |
||
319 | * @return array |
||
320 | */ |
||
321 | public function extract_post_recursive($key_name, $tmp_array) |
||
347 | } |
||
348 | |||
349 | // clear all stubs |
||
350 | public function clear() |
||
351 | { |
||
352 | $_SESSION['XOOPS_G_STUBS'] = array(); |
||
353 | } |
||
354 | |||
355 | // Ticket Using |
||
356 | /** |
||
357 | * @return bool |
||
358 | */ |
||
359 | public function using() |
||
360 | { |
||
361 | if (!empty($_SESSION['XOOPS_G_STUBS'])) { |
||
362 | return true; |
||
363 | } else { |
||
364 | return false; |
||
365 | } |
||
366 | } |
||
367 | |||
368 | // return errors |
||
369 | /** |
||
370 | * @param bool $ashtml |
||
371 | * |
||
372 | * @return array|string |
||
373 | */ |
||
374 | public function getErrors($ashtml = true) |
||
386 | } |
||
387 | |||
388 | /** |
||
389 | * @param $errNo |
||
390 | * @param $errStr |
||
391 | * @param $errFile |
||
392 | * @param $errLine |
||
393 | * @return null |
||
394 | */ |
||
395 | public function errorHandler4FindOutput($errNo, $errStr, $errFile, $errLine) |
||
434 |
In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.