@@ -5,12 +5,12 @@ |
||
5 | 5 | // @codingStandardsIgnoreFile |
6 | 6 | |
7 | 7 | /** |
8 | - * This interface exists to provide backwards compatibility with PHP 5.3 |
|
9 | - * |
|
10 | - * This should _not_ be used by any third-party code. |
|
11 | - * |
|
12 | - * @ignore |
|
13 | - */ |
|
8 | + * This interface exists to provide backwards compatibility with PHP 5.3 |
|
9 | + * |
|
10 | + * This should _not_ be used by any third-party code. |
|
11 | + * |
|
12 | + * @ignore |
|
13 | + */ |
|
14 | 14 | if (interface_exists('JsonSerializable')) { |
15 | 15 | interface JsonSerializable extends \JsonSerializable |
16 | 16 | { |
@@ -9,780 +9,780 @@ |
||
9 | 9 | * @author Roman Ožana <[email protected]> |
10 | 10 | */ |
11 | 11 | class Emogrifier { |
12 | - /** |
|
13 | - * @var string |
|
14 | - */ |
|
15 | - const ENCODING = 'UTF-8'; |
|
16 | - |
|
17 | - /** |
|
18 | - * @var integer |
|
19 | - */ |
|
20 | - const CACHE_KEY_CSS = 0; |
|
21 | - |
|
22 | - /** |
|
23 | - * @var integer |
|
24 | - */ |
|
25 | - const CACHE_KEY_SELECTOR = 1; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var integer |
|
29 | - */ |
|
30 | - const CACHE_KEY_XPATH = 2; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var integer |
|
34 | - */ |
|
35 | - const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
36 | - |
|
37 | - /** |
|
38 | - * for calculating nth-of-type and nth-child selectors. |
|
39 | - * |
|
40 | - * @var integer |
|
41 | - */ |
|
42 | - const INDEX = 0; |
|
43 | - |
|
44 | - /** |
|
45 | - * for calculating nth-of-type and nth-child selectors. |
|
46 | - * |
|
47 | - * @var integer |
|
48 | - */ |
|
49 | - const MULTIPLIER = 1; |
|
50 | - |
|
51 | - /** |
|
52 | - * @var string |
|
53 | - */ |
|
54 | - const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
55 | - |
|
56 | - /** |
|
57 | - * @var string |
|
58 | - */ |
|
59 | - const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
60 | - |
|
61 | - /** |
|
62 | - * @var string |
|
63 | - */ |
|
64 | - private $html = ''; |
|
65 | - |
|
66 | - /** |
|
67 | - * @var string |
|
68 | - */ |
|
69 | - private $css = ''; |
|
70 | - |
|
71 | - /** |
|
72 | - * @var array<string> |
|
73 | - */ |
|
74 | - private $unprocessableHtmlTags = array('wbr'); |
|
75 | - |
|
76 | - /** |
|
77 | - * @var array<array> |
|
78 | - */ |
|
79 | - private $caches = array( |
|
80 | - self::CACHE_KEY_CSS => array(), |
|
81 | - self::CACHE_KEY_SELECTOR => array(), |
|
82 | - self::CACHE_KEY_XPATH => array(), |
|
83 | - self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
84 | - ); |
|
85 | - |
|
86 | - /** |
|
87 | - * the visited nodes with the XPath paths as array keys. |
|
88 | - * |
|
89 | - * @var array<\DOMNode> |
|
90 | - */ |
|
91 | - private $visitedNodes = array(); |
|
92 | - |
|
93 | - /** |
|
94 | - * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
95 | - * as key/value pairs for the inner array. |
|
96 | - * |
|
97 | - * @var array<array><string> |
|
98 | - */ |
|
99 | - private $styleAttributesForNodes = array(); |
|
100 | - |
|
101 | - /** |
|
102 | - * This attribute applies to the case where you want to preserve your original text encoding. |
|
103 | - * |
|
104 | - * By default, emogrifier translates your text into HTML entities for two reasons: |
|
105 | - * |
|
106 | - * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
107 | - * |
|
108 | - * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
109 | - * |
|
110 | - * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
111 | - * |
|
112 | - * @var boolean |
|
113 | - */ |
|
114 | - public $preserveEncoding = false; |
|
115 | - |
|
116 | - public static $_media = ''; |
|
117 | - |
|
118 | - /** |
|
119 | - * The constructor. |
|
120 | - * |
|
121 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
122 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
123 | - */ |
|
124 | - public function __construct($html = '', $css = '') { |
|
125 | - $this->setHtml($html); |
|
126 | - $this->setCss($css); |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * The destructor. |
|
131 | - */ |
|
132 | - public function __destruct() { |
|
133 | - $this->purgeVisitedNodes(); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Sets the HTML to emogrify. |
|
138 | - * |
|
139 | - * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
140 | - */ |
|
141 | - public function setHtml($html = '') { |
|
142 | - $this->html = $html; |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Sets the CSS to merge with the HTML. |
|
147 | - * |
|
148 | - * @param string $css the CSS to merge, must be UTF-8-encoded |
|
149 | - */ |
|
150 | - public function setCss($css = '') { |
|
151 | - $this->css = $css; |
|
152 | - } |
|
153 | - |
|
154 | - /** |
|
155 | - * Clears all caches. |
|
156 | - */ |
|
157 | - private function clearAllCaches() { |
|
158 | - $this->clearCache(self::CACHE_KEY_CSS); |
|
159 | - $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
160 | - $this->clearCache(self::CACHE_KEY_XPATH); |
|
161 | - $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * Clears a single cache by key. |
|
166 | - * |
|
167 | - * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
168 | - * |
|
169 | - * @throws InvalidArgumentException |
|
170 | - */ |
|
171 | - private function clearCache($key) { |
|
172 | - $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
173 | - if (!in_array($key, $allowedCacheKeys, true)) { |
|
174 | - throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
175 | - } |
|
176 | - |
|
177 | - $this->caches[$key] = array(); |
|
178 | - } |
|
179 | - |
|
180 | - /** |
|
181 | - * Purges the visited nodes. |
|
182 | - */ |
|
183 | - private function purgeVisitedNodes() { |
|
184 | - $this->visitedNodes = array(); |
|
185 | - $this->styleAttributesForNodes = array(); |
|
186 | - } |
|
187 | - |
|
188 | - /** |
|
189 | - * Marks a tag for removal. |
|
190 | - * |
|
191 | - * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
192 | - * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
193 | - * |
|
194 | - * Note: The tags will not be removed if they have any content. |
|
195 | - * |
|
196 | - * @param string $tagName the tag name, e.g., "p" |
|
197 | - */ |
|
198 | - public function addUnprocessableHtmlTag($tagName) { |
|
199 | - $this->unprocessableHtmlTags[] = $tagName; |
|
200 | - } |
|
201 | - |
|
202 | - /** |
|
203 | - * Drops a tag from the removal list. |
|
204 | - * |
|
205 | - * @param string $tagName the tag name, e.g., "p" |
|
206 | - */ |
|
207 | - public function removeUnprocessableHtmlTag($tagName) { |
|
208 | - $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
209 | - if ($key !== false) { |
|
210 | - unset($this->unprocessableHtmlTags[$key]); |
|
211 | - } |
|
212 | - } |
|
213 | - |
|
214 | - /** |
|
215 | - * Applies the CSS you submit to the HTML you submit. |
|
216 | - * |
|
217 | - * This method places the CSS inline. |
|
218 | - * |
|
219 | - * @return string |
|
220 | - * |
|
221 | - * @throws BadMethodCallException |
|
222 | - */ |
|
223 | - public function emogrify() { |
|
224 | - if ($this->html === '') { |
|
225 | - throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
226 | - } |
|
227 | - |
|
228 | - $xmlDocument = $this->createXmlDocument(); |
|
229 | - $xpath = new DOMXPath($xmlDocument); |
|
230 | - $this->clearAllCaches(); |
|
231 | - |
|
232 | - // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
233 | - // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
234 | - // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
235 | - $this->purgeVisitedNodes(); |
|
236 | - |
|
237 | - $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
238 | - if ($nodesWithStyleAttributes !== false) { |
|
239 | - /** @var $nodeWithStyleAttribute DOMNode */ |
|
240 | - foreach ($nodesWithStyleAttributes as $node) { |
|
241 | - $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
242 | - |
|
243 | - // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
244 | - $nodePath = $node->getNodePath(); |
|
245 | - if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
246 | - $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
247 | - $this->visitedNodes[$nodePath] = $node; |
|
248 | - } |
|
249 | - |
|
250 | - $node->setAttribute('style', $normalizedOriginalStyle); |
|
251 | - } |
|
252 | - } |
|
253 | - |
|
254 | - // grab any existing style blocks from the html and append them to the existing CSS |
|
255 | - // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
256 | - $allCss = $this->css; |
|
257 | - |
|
258 | - $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
259 | - |
|
260 | - $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
261 | - self::$_media = ''; // reset |
|
262 | - |
|
263 | - $cssKey = md5($cssParts['css']); |
|
264 | - if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
265 | - // process the CSS file for selectors and definitions |
|
266 | - preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
267 | - |
|
268 | - $allSelectors = array(); |
|
269 | - foreach ($matches as $key => $selectorString) { |
|
270 | - // if there is a blank definition, skip |
|
271 | - if (!strlen(trim($selectorString[2]))) { |
|
272 | - continue; |
|
273 | - } |
|
274 | - |
|
275 | - // else split by commas and duplicate attributes so we can sort by selector precedence |
|
276 | - $selectors = explode(',', $selectorString[1]); |
|
277 | - foreach ($selectors as $selector) { |
|
278 | - // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
279 | - if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
280 | - continue; |
|
281 | - } |
|
282 | - |
|
283 | - $allSelectors[] = array('selector' => trim($selector), |
|
284 | - 'attributes' => trim($selectorString[2]), |
|
285 | - // keep track of where it appears in the file, since order is important |
|
286 | - 'line' => $key, |
|
287 | - ); |
|
288 | - } |
|
289 | - } |
|
290 | - |
|
291 | - // now sort the selectors by precedence |
|
292 | - usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
293 | - |
|
294 | - $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
295 | - } |
|
296 | - |
|
297 | - foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
298 | - // query the body for the xpath selector |
|
299 | - $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
300 | - |
|
301 | - /** @var $node \DOMNode */ |
|
302 | - foreach ($nodesMatchingCssSelectors as $node) { |
|
303 | - // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
304 | - if ($node->hasAttribute('style')) { |
|
305 | - // break it up into an associative array |
|
306 | - $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
307 | - } else { |
|
308 | - $oldStyleDeclarations = array(); |
|
309 | - } |
|
310 | - $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
311 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
312 | - } |
|
313 | - } |
|
314 | - |
|
315 | - // now iterate through the nodes that contained inline styles in the original HTML |
|
316 | - foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
317 | - $node = $this->visitedNodes[$nodePath]; |
|
318 | - $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
319 | - $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
320 | - } |
|
321 | - |
|
322 | - // This removes styles from your email that contain display:none. |
|
323 | - // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
324 | - // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
325 | - // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
326 | - $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
327 | - // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
328 | - // we don't try to call removeChild on a nonexistent child node |
|
329 | - if ($nodesWithStyleDisplayNone->length > 0) { |
|
330 | - /** @var $node \DOMNode */ |
|
331 | - foreach ($nodesWithStyleDisplayNone as $node) { |
|
332 | - if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
333 | - $node->parentNode->removeChild($node); |
|
334 | - } |
|
335 | - } |
|
336 | - } |
|
337 | - |
|
338 | - $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
339 | - |
|
340 | - if ($this->preserveEncoding) { |
|
341 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
342 | - return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
343 | - } else { |
|
344 | - return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
345 | - } |
|
346 | - } else { |
|
347 | - return $xmlDocument->saveHTML(); |
|
348 | - } |
|
349 | - } |
|
350 | - |
|
351 | - public function strtolower(array $m) { |
|
352 | - return strtolower($m[0]); |
|
353 | - } |
|
354 | - |
|
355 | - |
|
356 | - /** |
|
357 | - * This method merges old or existing name/value array with new name/value array. |
|
358 | - * and then generates a string of the combined style suitable for placing inline. |
|
359 | - * This becomes the single point for CSS string generation allowing for consistent. |
|
360 | - * CSS output no matter where the CSS originally came from. |
|
361 | - * @param array $oldStyles |
|
362 | - * @param array $newStyles |
|
363 | - * @return string |
|
364 | - */ |
|
365 | - private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
366 | - $combinedStyles = array_merge($oldStyles, $newStyles); |
|
367 | - $style = ''; |
|
368 | - foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
369 | - $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
370 | - } |
|
371 | - return trim($style); |
|
372 | - } |
|
373 | - |
|
374 | - |
|
375 | - /** |
|
376 | - * Copies the media part from CSS array parts to $xmlDocument. |
|
377 | - * |
|
378 | - * @param array $cssParts |
|
379 | - * @param DOMDocument $xmlDocument |
|
380 | - */ |
|
381 | - public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
382 | - if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
383 | - $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
384 | - } |
|
385 | - } |
|
386 | - |
|
387 | - /** |
|
388 | - * Returns CSS content. |
|
389 | - * |
|
390 | - * @param DOMXPath $xpath |
|
391 | - * @return string |
|
392 | - */ |
|
393 | - private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
394 | - $styleNodes = $xpath->query('//style'); |
|
395 | - |
|
396 | - if ($styleNodes === false) { |
|
397 | - return ''; |
|
398 | - } |
|
399 | - |
|
400 | - $css = ''; |
|
401 | - /** @var $styleNode DOMNode */ |
|
402 | - foreach ($styleNodes as $styleNode) { |
|
403 | - $css .= "\n\n" . $styleNode->nodeValue; |
|
404 | - $styleNode->parentNode->removeChild($styleNode); |
|
405 | - } |
|
406 | - |
|
407 | - return $css; |
|
408 | - } |
|
409 | - |
|
410 | - /** |
|
411 | - * Adds a style element with $css to $document. |
|
412 | - * |
|
413 | - * @param DOMDocument $document |
|
414 | - * @param string $css |
|
415 | - */ |
|
416 | - private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
417 | - $styleElement = $document->createElement('style', $css); |
|
418 | - $styleAttribute = $document->createAttribute('type'); |
|
419 | - $styleAttribute->value = 'text/css'; |
|
420 | - $styleElement->appendChild($styleAttribute); |
|
421 | - |
|
422 | - $head = $this->getOrCreateHeadElement($document); |
|
423 | - $head->appendChild($styleElement); |
|
424 | - } |
|
425 | - |
|
426 | - /** |
|
427 | - * Returns the existing or creates a new head element in $document. |
|
428 | - * |
|
429 | - * @param DOMDocument $document |
|
430 | - * @return DOMNode the head element |
|
431 | - */ |
|
432 | - private function getOrCreateHeadElement(DOMDocument $document) { |
|
433 | - $head = $document->getElementsByTagName('head')->item(0); |
|
434 | - |
|
435 | - if ($head === null) { |
|
436 | - $head = $document->createElement('head'); |
|
437 | - $html = $document->getElementsByTagName('html')->item(0); |
|
438 | - $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
439 | - } |
|
440 | - |
|
441 | - return $head; |
|
442 | - } |
|
443 | - |
|
444 | - /** |
|
445 | - * Splits input CSS code to an array where: |
|
446 | - * |
|
447 | - * - key "css" will be contains clean CSS code. |
|
448 | - * - key "media" will be contains all valuable media queries. |
|
449 | - * |
|
450 | - * Example: |
|
451 | - * |
|
452 | - * The CSS code. |
|
453 | - * |
|
454 | - * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
455 | - * |
|
456 | - * will be parsed into the following array: |
|
457 | - * |
|
458 | - * "css" => "h1 { color:red; }" |
|
459 | - * "media" => "@media { h1 {}}" |
|
460 | - * |
|
461 | - * @param string $css |
|
462 | - * @return array |
|
463 | - */ |
|
464 | - private function splitCssAndMediaQuery($css) { |
|
465 | - $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
466 | - |
|
467 | - // filter the CSS |
|
468 | - $search = array( |
|
469 | - // get rid of css comment code |
|
470 | - '/\\/\\*.*\\*\\//sU', |
|
471 | - // strip out any import directives |
|
472 | - '/^\\s*@import\\s[^;]+;/misU', |
|
473 | - // strip remains media enclosures |
|
474 | - '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
475 | - ); |
|
476 | - |
|
477 | - $replace = array( |
|
478 | - '', |
|
479 | - '', |
|
480 | - '', |
|
481 | - ); |
|
482 | - |
|
483 | - // clean CSS before output |
|
484 | - $css = preg_replace($search, $replace, $css); |
|
485 | - |
|
486 | - return array('css' => $css, 'media' => self::$_media); |
|
487 | - } |
|
488 | - |
|
489 | - private function _media_concat( $matches ) { |
|
490 | - self::$_media .= $matches[0]; |
|
491 | - } |
|
492 | - |
|
493 | - /** |
|
494 | - * Creates a DOMDocument instance with the current HTML. |
|
495 | - * |
|
496 | - * @return DOMDocument |
|
497 | - */ |
|
498 | - private function createXmlDocument() { |
|
499 | - $xmlDocument = new DOMDocument; |
|
500 | - $xmlDocument->encoding = self::ENCODING; |
|
501 | - $xmlDocument->strictErrorChecking = false; |
|
502 | - $xmlDocument->formatOutput = true; |
|
503 | - $libXmlState = libxml_use_internal_errors(true); |
|
504 | - $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
505 | - libxml_clear_errors(); |
|
506 | - libxml_use_internal_errors($libXmlState); |
|
507 | - $xmlDocument->normalizeDocument(); |
|
508 | - |
|
509 | - return $xmlDocument; |
|
510 | - } |
|
511 | - |
|
512 | - /** |
|
513 | - * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
514 | - * |
|
515 | - * @return string the unified HTML |
|
516 | - * |
|
517 | - * @throws BadMethodCallException |
|
518 | - */ |
|
519 | - private function getUnifiedHtml() { |
|
520 | - if (!empty($this->unprocessableHtmlTags)) { |
|
521 | - $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
522 | - $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
523 | - } else { |
|
524 | - $bodyWithoutUnprocessableTags = $this->html; |
|
525 | - } |
|
526 | - |
|
527 | - if ( function_exists( 'mb_convert_encoding' ) ) { |
|
528 | - return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
529 | - } else { |
|
530 | - return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
531 | - } |
|
532 | - } |
|
533 | - |
|
534 | - /** |
|
535 | - * @param array $a |
|
536 | - * @param array $b |
|
537 | - * |
|
538 | - * @return integer |
|
539 | - */ |
|
540 | - private function sortBySelectorPrecedence(array $a, array $b) { |
|
541 | - $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
542 | - $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
543 | - |
|
544 | - // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
545 | - // selectors with greater precedence get sorted last. |
|
546 | - // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
547 | - // arithmetic operators. |
|
548 | - // @see http://forge.typo3.org/issues/55605 |
|
549 | - $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
550 | - $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
551 | - return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
552 | - } |
|
553 | - |
|
554 | - /** |
|
555 | - * @param string $selector |
|
556 | - * |
|
557 | - * @return integer |
|
558 | - */ |
|
559 | - private function getCssSelectorPrecedence($selector) { |
|
560 | - $selectorKey = md5($selector); |
|
561 | - if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
562 | - $precedence = 0; |
|
563 | - $value = 100; |
|
564 | - // ids: worth 100, classes: worth 10, elements: worth 1 |
|
565 | - $search = array('\\#','\\.',''); |
|
566 | - |
|
567 | - foreach ($search as $s) { |
|
568 | - if (trim($selector == '')) { |
|
569 | - break; |
|
570 | - } |
|
571 | - $number = 0; |
|
572 | - $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
573 | - $precedence += ($value * $number); |
|
574 | - $value /= 10; |
|
575 | - } |
|
576 | - $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
577 | - } |
|
578 | - |
|
579 | - return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
580 | - } |
|
581 | - |
|
582 | - /** |
|
583 | - * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
584 | - * |
|
585 | - * @see http://plasmasturm.org/log/444/ |
|
586 | - * |
|
587 | - * @param string $paramCssSelector |
|
588 | - * |
|
589 | - * @return string |
|
590 | - */ |
|
591 | - private function translateCssToXpath($paramCssSelector) { |
|
592 | - $cssSelector = ' ' . $paramCssSelector . ' '; |
|
593 | - $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
594 | - $cssSelector = trim($cssSelector); |
|
595 | - $xpathKey = md5($cssSelector); |
|
596 | - if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
597 | - // returns an Xpath selector |
|
598 | - $search = array( |
|
599 | - // Matches any element that is a child of parent. |
|
600 | - '/\\s+>\\s+/', |
|
601 | - // Matches any element that is an adjacent sibling. |
|
602 | - '/\\s+\\+\\s+/', |
|
603 | - // Matches any element that is a descendant of an parent element element. |
|
604 | - '/\\s+/', |
|
605 | - // first-child pseudo-selector |
|
606 | - '/([^\\/]+):first-child/i', |
|
607 | - // last-child pseudo-selector |
|
608 | - '/([^\\/]+):last-child/i', |
|
609 | - // Matches attribute only selector |
|
610 | - '/^\\[(\\w+)\\]/', |
|
611 | - // Matches element with attribute |
|
612 | - '/(\\w)\\[(\\w+)\\]/', |
|
613 | - // Matches element with EXACT attribute |
|
614 | - '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
615 | - ); |
|
616 | - $replace = array( |
|
617 | - '/', |
|
618 | - '/following-sibling::*[1]/self::', |
|
619 | - '//', |
|
620 | - '*[1]/self::\\1', |
|
621 | - '*[last()]/self::\\1', |
|
622 | - '*[@\\1]', |
|
623 | - '\\1[@\\2]', |
|
624 | - '\\1[@\\2="\\3"]', |
|
625 | - ); |
|
626 | - |
|
627 | - $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
628 | - |
|
629 | - $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
630 | - $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
631 | - |
|
632 | - // Advanced selectors are going to require a bit more advanced emogrification. |
|
633 | - // When we required PHP 5.3, we could do this with closures. |
|
634 | - $cssSelector = preg_replace_callback( |
|
635 | - '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
636 | - array($this, 'translateNthChild'), $cssSelector |
|
637 | - ); |
|
638 | - $cssSelector = preg_replace_callback( |
|
639 | - '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
640 | - array($this, 'translateNthOfType'), $cssSelector |
|
641 | - ); |
|
642 | - |
|
643 | - $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
644 | - } |
|
645 | - return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
646 | - } |
|
647 | - |
|
648 | - /** |
|
649 | - * @param array $match |
|
650 | - * |
|
651 | - * @return string |
|
652 | - */ |
|
653 | - private function matchIdAttributes(array $match) { |
|
654 | - return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
655 | - } |
|
656 | - |
|
657 | - /** |
|
658 | - * @param array $match |
|
659 | - * |
|
660 | - * @return string |
|
661 | - */ |
|
662 | - private function matchClassAttributes(array $match) { |
|
663 | - return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
664 | - implode( |
|
665 | - '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
666 | - explode('.', substr($match[2], 1)) |
|
667 | - ) . '"," "))]'; |
|
668 | - } |
|
669 | - |
|
670 | - /** |
|
671 | - * @param array $match |
|
672 | - * |
|
673 | - * @return string |
|
674 | - */ |
|
675 | - private function translateNthChild(array $match) { |
|
676 | - $result = $this->parseNth($match); |
|
677 | - |
|
678 | - if (isset($result[self::MULTIPLIER])) { |
|
679 | - if ($result[self::MULTIPLIER] < 0) { |
|
680 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
681 | - return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
682 | - } else { |
|
683 | - return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
684 | - } |
|
685 | - } else { |
|
686 | - return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
687 | - } |
|
688 | - } |
|
689 | - |
|
690 | - /** |
|
691 | - * @param array $match |
|
692 | - * |
|
693 | - * @return string |
|
694 | - */ |
|
695 | - private function translateNthOfType(array $match) { |
|
696 | - $result = $this->parseNth($match); |
|
697 | - |
|
698 | - if (isset($result[self::MULTIPLIER])) { |
|
699 | - if ($result[self::MULTIPLIER] < 0) { |
|
700 | - $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
701 | - return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
702 | - } else { |
|
703 | - return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
704 | - } |
|
705 | - } else { |
|
706 | - return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
707 | - } |
|
708 | - } |
|
709 | - |
|
710 | - /** |
|
711 | - * @param array $match |
|
712 | - * |
|
713 | - * @return array |
|
714 | - */ |
|
715 | - private function parseNth(array $match) { |
|
716 | - if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
717 | - $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
718 | - return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
719 | - } elseif (stripos($match[2], 'n') === false) { |
|
720 | - // if there is a multiplier |
|
721 | - $index = intval(str_replace(' ', '', $match[2])); |
|
722 | - return array(self::INDEX => $index); |
|
723 | - } else { |
|
724 | - if (isset($match[3])) { |
|
725 | - $multipleTerm = str_replace($match[3], '', $match[2]); |
|
726 | - $index = intval(str_replace(' ', '', $match[3])); |
|
727 | - } else { |
|
728 | - $multipleTerm = $match[2]; |
|
729 | - $index = 0; |
|
730 | - } |
|
731 | - |
|
732 | - $multiplier = str_ireplace('n', '', $multipleTerm); |
|
733 | - |
|
734 | - if (!strlen($multiplier)) { |
|
735 | - $multiplier = 1; |
|
736 | - } elseif ($multiplier == 0) { |
|
737 | - return array(self::INDEX => $index); |
|
738 | - } else { |
|
739 | - $multiplier = intval($multiplier); |
|
740 | - } |
|
741 | - |
|
742 | - while ($index < 0) { |
|
743 | - $index += abs($multiplier); |
|
744 | - } |
|
745 | - |
|
746 | - return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
747 | - } |
|
748 | - } |
|
749 | - |
|
750 | - /** |
|
751 | - * Parses a CSS declaration block into property name/value pairs. |
|
752 | - * |
|
753 | - * Example: |
|
754 | - * |
|
755 | - * The declaration block. |
|
756 | - * |
|
757 | - * "color: #000; font-weight: bold;". |
|
758 | - * |
|
759 | - * will be parsed into the following array: |
|
760 | - * |
|
761 | - * "color" => "#000" |
|
762 | - * "font-weight" => "bold" |
|
763 | - * |
|
764 | - * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
765 | - * |
|
766 | - * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
767 | - */ |
|
768 | - private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
769 | - if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
770 | - return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
771 | - } |
|
772 | - |
|
773 | - $properties = array(); |
|
774 | - $declarations = explode(';', $cssDeclarationBlock); |
|
775 | - foreach ($declarations as $declaration) { |
|
776 | - $matches = array(); |
|
777 | - if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
778 | - continue; |
|
779 | - } |
|
780 | - $propertyName = strtolower($matches[1]); |
|
781 | - $propertyValue = $matches[2]; |
|
782 | - $properties[$propertyName] = $propertyValue; |
|
783 | - } |
|
784 | - $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
785 | - |
|
786 | - return $properties; |
|
787 | - } |
|
12 | + /** |
|
13 | + * @var string |
|
14 | + */ |
|
15 | + const ENCODING = 'UTF-8'; |
|
16 | + |
|
17 | + /** |
|
18 | + * @var integer |
|
19 | + */ |
|
20 | + const CACHE_KEY_CSS = 0; |
|
21 | + |
|
22 | + /** |
|
23 | + * @var integer |
|
24 | + */ |
|
25 | + const CACHE_KEY_SELECTOR = 1; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var integer |
|
29 | + */ |
|
30 | + const CACHE_KEY_XPATH = 2; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var integer |
|
34 | + */ |
|
35 | + const CACHE_KEY_CSS_DECLARATION_BLOCK = 3; |
|
36 | + |
|
37 | + /** |
|
38 | + * for calculating nth-of-type and nth-child selectors. |
|
39 | + * |
|
40 | + * @var integer |
|
41 | + */ |
|
42 | + const INDEX = 0; |
|
43 | + |
|
44 | + /** |
|
45 | + * for calculating nth-of-type and nth-child selectors. |
|
46 | + * |
|
47 | + * @var integer |
|
48 | + */ |
|
49 | + const MULTIPLIER = 1; |
|
50 | + |
|
51 | + /** |
|
52 | + * @var string |
|
53 | + */ |
|
54 | + const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/'; |
|
55 | + |
|
56 | + /** |
|
57 | + * @var string |
|
58 | + */ |
|
59 | + const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/'; |
|
60 | + |
|
61 | + /** |
|
62 | + * @var string |
|
63 | + */ |
|
64 | + private $html = ''; |
|
65 | + |
|
66 | + /** |
|
67 | + * @var string |
|
68 | + */ |
|
69 | + private $css = ''; |
|
70 | + |
|
71 | + /** |
|
72 | + * @var array<string> |
|
73 | + */ |
|
74 | + private $unprocessableHtmlTags = array('wbr'); |
|
75 | + |
|
76 | + /** |
|
77 | + * @var array<array> |
|
78 | + */ |
|
79 | + private $caches = array( |
|
80 | + self::CACHE_KEY_CSS => array(), |
|
81 | + self::CACHE_KEY_SELECTOR => array(), |
|
82 | + self::CACHE_KEY_XPATH => array(), |
|
83 | + self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(), |
|
84 | + ); |
|
85 | + |
|
86 | + /** |
|
87 | + * the visited nodes with the XPath paths as array keys. |
|
88 | + * |
|
89 | + * @var array<\DOMNode> |
|
90 | + */ |
|
91 | + private $visitedNodes = array(); |
|
92 | + |
|
93 | + /** |
|
94 | + * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values. |
|
95 | + * as key/value pairs for the inner array. |
|
96 | + * |
|
97 | + * @var array<array><string> |
|
98 | + */ |
|
99 | + private $styleAttributesForNodes = array(); |
|
100 | + |
|
101 | + /** |
|
102 | + * This attribute applies to the case where you want to preserve your original text encoding. |
|
103 | + * |
|
104 | + * By default, emogrifier translates your text into HTML entities for two reasons: |
|
105 | + * |
|
106 | + * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email. |
|
107 | + * |
|
108 | + * 2. It translates any illegal XML characters that DOMDocument cannot work with. |
|
109 | + * |
|
110 | + * If you would like to preserve your original encoding, set this attribute to TRUE. |
|
111 | + * |
|
112 | + * @var boolean |
|
113 | + */ |
|
114 | + public $preserveEncoding = false; |
|
115 | + |
|
116 | + public static $_media = ''; |
|
117 | + |
|
118 | + /** |
|
119 | + * The constructor. |
|
120 | + * |
|
121 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
122 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
123 | + */ |
|
124 | + public function __construct($html = '', $css = '') { |
|
125 | + $this->setHtml($html); |
|
126 | + $this->setCss($css); |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * The destructor. |
|
131 | + */ |
|
132 | + public function __destruct() { |
|
133 | + $this->purgeVisitedNodes(); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Sets the HTML to emogrify. |
|
138 | + * |
|
139 | + * @param string $html the HTML to emogrify, must be UTF-8-encoded |
|
140 | + */ |
|
141 | + public function setHtml($html = '') { |
|
142 | + $this->html = $html; |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Sets the CSS to merge with the HTML. |
|
147 | + * |
|
148 | + * @param string $css the CSS to merge, must be UTF-8-encoded |
|
149 | + */ |
|
150 | + public function setCss($css = '') { |
|
151 | + $this->css = $css; |
|
152 | + } |
|
153 | + |
|
154 | + /** |
|
155 | + * Clears all caches. |
|
156 | + */ |
|
157 | + private function clearAllCaches() { |
|
158 | + $this->clearCache(self::CACHE_KEY_CSS); |
|
159 | + $this->clearCache(self::CACHE_KEY_SELECTOR); |
|
160 | + $this->clearCache(self::CACHE_KEY_XPATH); |
|
161 | + $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * Clears a single cache by key. |
|
166 | + * |
|
167 | + * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK |
|
168 | + * |
|
169 | + * @throws InvalidArgumentException |
|
170 | + */ |
|
171 | + private function clearCache($key) { |
|
172 | + $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK); |
|
173 | + if (!in_array($key, $allowedCacheKeys, true)) { |
|
174 | + throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035); |
|
175 | + } |
|
176 | + |
|
177 | + $this->caches[$key] = array(); |
|
178 | + } |
|
179 | + |
|
180 | + /** |
|
181 | + * Purges the visited nodes. |
|
182 | + */ |
|
183 | + private function purgeVisitedNodes() { |
|
184 | + $this->visitedNodes = array(); |
|
185 | + $this->styleAttributesForNodes = array(); |
|
186 | + } |
|
187 | + |
|
188 | + /** |
|
189 | + * Marks a tag for removal. |
|
190 | + * |
|
191 | + * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them. |
|
192 | + * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document. |
|
193 | + * |
|
194 | + * Note: The tags will not be removed if they have any content. |
|
195 | + * |
|
196 | + * @param string $tagName the tag name, e.g., "p" |
|
197 | + */ |
|
198 | + public function addUnprocessableHtmlTag($tagName) { |
|
199 | + $this->unprocessableHtmlTags[] = $tagName; |
|
200 | + } |
|
201 | + |
|
202 | + /** |
|
203 | + * Drops a tag from the removal list. |
|
204 | + * |
|
205 | + * @param string $tagName the tag name, e.g., "p" |
|
206 | + */ |
|
207 | + public function removeUnprocessableHtmlTag($tagName) { |
|
208 | + $key = array_search($tagName, $this->unprocessableHtmlTags, true); |
|
209 | + if ($key !== false) { |
|
210 | + unset($this->unprocessableHtmlTags[$key]); |
|
211 | + } |
|
212 | + } |
|
213 | + |
|
214 | + /** |
|
215 | + * Applies the CSS you submit to the HTML you submit. |
|
216 | + * |
|
217 | + * This method places the CSS inline. |
|
218 | + * |
|
219 | + * @return string |
|
220 | + * |
|
221 | + * @throws BadMethodCallException |
|
222 | + */ |
|
223 | + public function emogrify() { |
|
224 | + if ($this->html === '') { |
|
225 | + throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096); |
|
226 | + } |
|
227 | + |
|
228 | + $xmlDocument = $this->createXmlDocument(); |
|
229 | + $xpath = new DOMXPath($xmlDocument); |
|
230 | + $this->clearAllCaches(); |
|
231 | + |
|
232 | + // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none'); |
|
233 | + // we wouldn't have to do this if DOMXPath supported XPath 2.0. |
|
234 | + // also store a reference of nodes with existing inline styles so we don't overwrite them |
|
235 | + $this->purgeVisitedNodes(); |
|
236 | + |
|
237 | + $nodesWithStyleAttributes = $xpath->query('//*[@style]'); |
|
238 | + if ($nodesWithStyleAttributes !== false) { |
|
239 | + /** @var $nodeWithStyleAttribute DOMNode */ |
|
240 | + foreach ($nodesWithStyleAttributes as $node) { |
|
241 | + $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') ); |
|
242 | + |
|
243 | + // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles |
|
244 | + $nodePath = $node->getNodePath(); |
|
245 | + if (!isset($this->styleAttributesForNodes[$nodePath])) { |
|
246 | + $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle); |
|
247 | + $this->visitedNodes[$nodePath] = $node; |
|
248 | + } |
|
249 | + |
|
250 | + $node->setAttribute('style', $normalizedOriginalStyle); |
|
251 | + } |
|
252 | + } |
|
253 | + |
|
254 | + // grab any existing style blocks from the html and append them to the existing CSS |
|
255 | + // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) |
|
256 | + $allCss = $this->css; |
|
257 | + |
|
258 | + $allCss .= $this->getCssFromAllStyleNodes($xpath); |
|
259 | + |
|
260 | + $cssParts = $this->splitCssAndMediaQuery($allCss); |
|
261 | + self::$_media = ''; // reset |
|
262 | + |
|
263 | + $cssKey = md5($cssParts['css']); |
|
264 | + if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) { |
|
265 | + // process the CSS file for selectors and definitions |
|
266 | + preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER); |
|
267 | + |
|
268 | + $allSelectors = array(); |
|
269 | + foreach ($matches as $key => $selectorString) { |
|
270 | + // if there is a blank definition, skip |
|
271 | + if (!strlen(trim($selectorString[2]))) { |
|
272 | + continue; |
|
273 | + } |
|
274 | + |
|
275 | + // else split by commas and duplicate attributes so we can sort by selector precedence |
|
276 | + $selectors = explode(',', $selectorString[1]); |
|
277 | + foreach ($selectors as $selector) { |
|
278 | + // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes |
|
279 | + if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) { |
|
280 | + continue; |
|
281 | + } |
|
282 | + |
|
283 | + $allSelectors[] = array('selector' => trim($selector), |
|
284 | + 'attributes' => trim($selectorString[2]), |
|
285 | + // keep track of where it appears in the file, since order is important |
|
286 | + 'line' => $key, |
|
287 | + ); |
|
288 | + } |
|
289 | + } |
|
290 | + |
|
291 | + // now sort the selectors by precedence |
|
292 | + usort($allSelectors, array($this,'sortBySelectorPrecedence')); |
|
293 | + |
|
294 | + $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors; |
|
295 | + } |
|
296 | + |
|
297 | + foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) { |
|
298 | + // query the body for the xpath selector |
|
299 | + $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector'])); |
|
300 | + |
|
301 | + /** @var $node \DOMNode */ |
|
302 | + foreach ($nodesMatchingCssSelectors as $node) { |
|
303 | + // if it has a style attribute, get it, process it, and append (overwrite) new stuff |
|
304 | + if ($node->hasAttribute('style')) { |
|
305 | + // break it up into an associative array |
|
306 | + $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
307 | + } else { |
|
308 | + $oldStyleDeclarations = array(); |
|
309 | + } |
|
310 | + $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']); |
|
311 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations)); |
|
312 | + } |
|
313 | + } |
|
314 | + |
|
315 | + // now iterate through the nodes that contained inline styles in the original HTML |
|
316 | + foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { |
|
317 | + $node = $this->visitedNodes[$nodePath]; |
|
318 | + $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style')); |
|
319 | + $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode)); |
|
320 | + } |
|
321 | + |
|
322 | + // This removes styles from your email that contain display:none. |
|
323 | + // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0, |
|
324 | + // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need |
|
325 | + // to translate() the letters that would be in 'NONE' ("NOE") to lowercase. |
|
326 | + $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]'); |
|
327 | + // The checks on parentNode and is_callable below ensure that if we've deleted the parent node, |
|
328 | + // we don't try to call removeChild on a nonexistent child node |
|
329 | + if ($nodesWithStyleDisplayNone->length > 0) { |
|
330 | + /** @var $node \DOMNode */ |
|
331 | + foreach ($nodesWithStyleDisplayNone as $node) { |
|
332 | + if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) { |
|
333 | + $node->parentNode->removeChild($node); |
|
334 | + } |
|
335 | + } |
|
336 | + } |
|
337 | + |
|
338 | + $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument); |
|
339 | + |
|
340 | + if ($this->preserveEncoding) { |
|
341 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
342 | + return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' ); |
|
343 | + } else { |
|
344 | + return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) ); |
|
345 | + } |
|
346 | + } else { |
|
347 | + return $xmlDocument->saveHTML(); |
|
348 | + } |
|
349 | + } |
|
350 | + |
|
351 | + public function strtolower(array $m) { |
|
352 | + return strtolower($m[0]); |
|
353 | + } |
|
354 | + |
|
355 | + |
|
356 | + /** |
|
357 | + * This method merges old or existing name/value array with new name/value array. |
|
358 | + * and then generates a string of the combined style suitable for placing inline. |
|
359 | + * This becomes the single point for CSS string generation allowing for consistent. |
|
360 | + * CSS output no matter where the CSS originally came from. |
|
361 | + * @param array $oldStyles |
|
362 | + * @param array $newStyles |
|
363 | + * @return string |
|
364 | + */ |
|
365 | + private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) { |
|
366 | + $combinedStyles = array_merge($oldStyles, $newStyles); |
|
367 | + $style = ''; |
|
368 | + foreach ($combinedStyles as $attributeName => $attributeValue) { |
|
369 | + $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; '); |
|
370 | + } |
|
371 | + return trim($style); |
|
372 | + } |
|
373 | + |
|
374 | + |
|
375 | + /** |
|
376 | + * Copies the media part from CSS array parts to $xmlDocument. |
|
377 | + * |
|
378 | + * @param array $cssParts |
|
379 | + * @param DOMDocument $xmlDocument |
|
380 | + */ |
|
381 | + public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) { |
|
382 | + if (isset($cssParts['media']) && $cssParts['media'] !== '') { |
|
383 | + $this->addStyleElementToDocument($xmlDocument, $cssParts['media']); |
|
384 | + } |
|
385 | + } |
|
386 | + |
|
387 | + /** |
|
388 | + * Returns CSS content. |
|
389 | + * |
|
390 | + * @param DOMXPath $xpath |
|
391 | + * @return string |
|
392 | + */ |
|
393 | + private function getCssFromAllStyleNodes(DOMXPath $xpath) { |
|
394 | + $styleNodes = $xpath->query('//style'); |
|
395 | + |
|
396 | + if ($styleNodes === false) { |
|
397 | + return ''; |
|
398 | + } |
|
399 | + |
|
400 | + $css = ''; |
|
401 | + /** @var $styleNode DOMNode */ |
|
402 | + foreach ($styleNodes as $styleNode) { |
|
403 | + $css .= "\n\n" . $styleNode->nodeValue; |
|
404 | + $styleNode->parentNode->removeChild($styleNode); |
|
405 | + } |
|
406 | + |
|
407 | + return $css; |
|
408 | + } |
|
409 | + |
|
410 | + /** |
|
411 | + * Adds a style element with $css to $document. |
|
412 | + * |
|
413 | + * @param DOMDocument $document |
|
414 | + * @param string $css |
|
415 | + */ |
|
416 | + private function addStyleElementToDocument(DOMDocument $document, $css) { |
|
417 | + $styleElement = $document->createElement('style', $css); |
|
418 | + $styleAttribute = $document->createAttribute('type'); |
|
419 | + $styleAttribute->value = 'text/css'; |
|
420 | + $styleElement->appendChild($styleAttribute); |
|
421 | + |
|
422 | + $head = $this->getOrCreateHeadElement($document); |
|
423 | + $head->appendChild($styleElement); |
|
424 | + } |
|
425 | + |
|
426 | + /** |
|
427 | + * Returns the existing or creates a new head element in $document. |
|
428 | + * |
|
429 | + * @param DOMDocument $document |
|
430 | + * @return DOMNode the head element |
|
431 | + */ |
|
432 | + private function getOrCreateHeadElement(DOMDocument $document) { |
|
433 | + $head = $document->getElementsByTagName('head')->item(0); |
|
434 | + |
|
435 | + if ($head === null) { |
|
436 | + $head = $document->createElement('head'); |
|
437 | + $html = $document->getElementsByTagName('html')->item(0); |
|
438 | + $html->insertBefore($head, $document->getElementsByTagName('body')->item(0)); |
|
439 | + } |
|
440 | + |
|
441 | + return $head; |
|
442 | + } |
|
443 | + |
|
444 | + /** |
|
445 | + * Splits input CSS code to an array where: |
|
446 | + * |
|
447 | + * - key "css" will be contains clean CSS code. |
|
448 | + * - key "media" will be contains all valuable media queries. |
|
449 | + * |
|
450 | + * Example: |
|
451 | + * |
|
452 | + * The CSS code. |
|
453 | + * |
|
454 | + * "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}" |
|
455 | + * |
|
456 | + * will be parsed into the following array: |
|
457 | + * |
|
458 | + * "css" => "h1 { color:red; }" |
|
459 | + * "media" => "@media { h1 {}}" |
|
460 | + * |
|
461 | + * @param string $css |
|
462 | + * @return array |
|
463 | + */ |
|
464 | + private function splitCssAndMediaQuery($css) { |
|
465 | + $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css ); |
|
466 | + |
|
467 | + // filter the CSS |
|
468 | + $search = array( |
|
469 | + // get rid of css comment code |
|
470 | + '/\\/\\*.*\\*\\//sU', |
|
471 | + // strip out any import directives |
|
472 | + '/^\\s*@import\\s[^;]+;/misU', |
|
473 | + // strip remains media enclosures |
|
474 | + '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU', |
|
475 | + ); |
|
476 | + |
|
477 | + $replace = array( |
|
478 | + '', |
|
479 | + '', |
|
480 | + '', |
|
481 | + ); |
|
482 | + |
|
483 | + // clean CSS before output |
|
484 | + $css = preg_replace($search, $replace, $css); |
|
485 | + |
|
486 | + return array('css' => $css, 'media' => self::$_media); |
|
487 | + } |
|
488 | + |
|
489 | + private function _media_concat( $matches ) { |
|
490 | + self::$_media .= $matches[0]; |
|
491 | + } |
|
492 | + |
|
493 | + /** |
|
494 | + * Creates a DOMDocument instance with the current HTML. |
|
495 | + * |
|
496 | + * @return DOMDocument |
|
497 | + */ |
|
498 | + private function createXmlDocument() { |
|
499 | + $xmlDocument = new DOMDocument; |
|
500 | + $xmlDocument->encoding = self::ENCODING; |
|
501 | + $xmlDocument->strictErrorChecking = false; |
|
502 | + $xmlDocument->formatOutput = true; |
|
503 | + $libXmlState = libxml_use_internal_errors(true); |
|
504 | + $xmlDocument->loadHTML($this->getUnifiedHtml()); |
|
505 | + libxml_clear_errors(); |
|
506 | + libxml_use_internal_errors($libXmlState); |
|
507 | + $xmlDocument->normalizeDocument(); |
|
508 | + |
|
509 | + return $xmlDocument; |
|
510 | + } |
|
511 | + |
|
512 | + /** |
|
513 | + * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed. |
|
514 | + * |
|
515 | + * @return string the unified HTML |
|
516 | + * |
|
517 | + * @throws BadMethodCallException |
|
518 | + */ |
|
519 | + private function getUnifiedHtml() { |
|
520 | + if (!empty($this->unprocessableHtmlTags)) { |
|
521 | + $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags); |
|
522 | + $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html); |
|
523 | + } else { |
|
524 | + $bodyWithoutUnprocessableTags = $this->html; |
|
525 | + } |
|
526 | + |
|
527 | + if ( function_exists( 'mb_convert_encoding' ) ) { |
|
528 | + return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING ); |
|
529 | + } else { |
|
530 | + return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) ); |
|
531 | + } |
|
532 | + } |
|
533 | + |
|
534 | + /** |
|
535 | + * @param array $a |
|
536 | + * @param array $b |
|
537 | + * |
|
538 | + * @return integer |
|
539 | + */ |
|
540 | + private function sortBySelectorPrecedence(array $a, array $b) { |
|
541 | + $precedenceA = $this->getCssSelectorPrecedence($a['selector']); |
|
542 | + $precedenceB = $this->getCssSelectorPrecedence($b['selector']); |
|
543 | + |
|
544 | + // We want these sorted in ascending order so selectors with lesser precedence get processed first and |
|
545 | + // selectors with greater precedence get sorted last. |
|
546 | + // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around |
|
547 | + // arithmetic operators. |
|
548 | + // @see http://forge.typo3.org/issues/55605 |
|
549 | + $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1); |
|
550 | + $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1); |
|
551 | + return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals; |
|
552 | + } |
|
553 | + |
|
554 | + /** |
|
555 | + * @param string $selector |
|
556 | + * |
|
557 | + * @return integer |
|
558 | + */ |
|
559 | + private function getCssSelectorPrecedence($selector) { |
|
560 | + $selectorKey = md5($selector); |
|
561 | + if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { |
|
562 | + $precedence = 0; |
|
563 | + $value = 100; |
|
564 | + // ids: worth 100, classes: worth 10, elements: worth 1 |
|
565 | + $search = array('\\#','\\.',''); |
|
566 | + |
|
567 | + foreach ($search as $s) { |
|
568 | + if (trim($selector == '')) { |
|
569 | + break; |
|
570 | + } |
|
571 | + $number = 0; |
|
572 | + $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number); |
|
573 | + $precedence += ($value * $number); |
|
574 | + $value /= 10; |
|
575 | + } |
|
576 | + $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; |
|
577 | + } |
|
578 | + |
|
579 | + return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; |
|
580 | + } |
|
581 | + |
|
582 | + /** |
|
583 | + * Right now, we support all CSS 1 selectors and most CSS2/3 selectors. |
|
584 | + * |
|
585 | + * @see http://plasmasturm.org/log/444/ |
|
586 | + * |
|
587 | + * @param string $paramCssSelector |
|
588 | + * |
|
589 | + * @return string |
|
590 | + */ |
|
591 | + private function translateCssToXpath($paramCssSelector) { |
|
592 | + $cssSelector = ' ' . $paramCssSelector . ' '; |
|
593 | + $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector ); |
|
594 | + $cssSelector = trim($cssSelector); |
|
595 | + $xpathKey = md5($cssSelector); |
|
596 | + if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) { |
|
597 | + // returns an Xpath selector |
|
598 | + $search = array( |
|
599 | + // Matches any element that is a child of parent. |
|
600 | + '/\\s+>\\s+/', |
|
601 | + // Matches any element that is an adjacent sibling. |
|
602 | + '/\\s+\\+\\s+/', |
|
603 | + // Matches any element that is a descendant of an parent element element. |
|
604 | + '/\\s+/', |
|
605 | + // first-child pseudo-selector |
|
606 | + '/([^\\/]+):first-child/i', |
|
607 | + // last-child pseudo-selector |
|
608 | + '/([^\\/]+):last-child/i', |
|
609 | + // Matches attribute only selector |
|
610 | + '/^\\[(\\w+)\\]/', |
|
611 | + // Matches element with attribute |
|
612 | + '/(\\w)\\[(\\w+)\\]/', |
|
613 | + // Matches element with EXACT attribute |
|
614 | + '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/', |
|
615 | + ); |
|
616 | + $replace = array( |
|
617 | + '/', |
|
618 | + '/following-sibling::*[1]/self::', |
|
619 | + '//', |
|
620 | + '*[1]/self::\\1', |
|
621 | + '*[last()]/self::\\1', |
|
622 | + '*[@\\1]', |
|
623 | + '\\1[@\\2]', |
|
624 | + '\\1[@\\2="\\3"]', |
|
625 | + ); |
|
626 | + |
|
627 | + $cssSelector = '//' . preg_replace($search, $replace, $cssSelector); |
|
628 | + |
|
629 | + $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector); |
|
630 | + $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector); |
|
631 | + |
|
632 | + // Advanced selectors are going to require a bit more advanced emogrification. |
|
633 | + // When we required PHP 5.3, we could do this with closures. |
|
634 | + $cssSelector = preg_replace_callback( |
|
635 | + '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
636 | + array($this, 'translateNthChild'), $cssSelector |
|
637 | + ); |
|
638 | + $cssSelector = preg_replace_callback( |
|
639 | + '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i', |
|
640 | + array($this, 'translateNthOfType'), $cssSelector |
|
641 | + ); |
|
642 | + |
|
643 | + $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector; |
|
644 | + } |
|
645 | + return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey]; |
|
646 | + } |
|
647 | + |
|
648 | + /** |
|
649 | + * @param array $match |
|
650 | + * |
|
651 | + * @return string |
|
652 | + */ |
|
653 | + private function matchIdAttributes(array $match) { |
|
654 | + return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]'; |
|
655 | + } |
|
656 | + |
|
657 | + /** |
|
658 | + * @param array $match |
|
659 | + * |
|
660 | + * @return string |
|
661 | + */ |
|
662 | + private function matchClassAttributes(array $match) { |
|
663 | + return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' . |
|
664 | + implode( |
|
665 | + '"," "))][contains(concat(" ",@class," "),concat(" ","', |
|
666 | + explode('.', substr($match[2], 1)) |
|
667 | + ) . '"," "))]'; |
|
668 | + } |
|
669 | + |
|
670 | + /** |
|
671 | + * @param array $match |
|
672 | + * |
|
673 | + * @return string |
|
674 | + */ |
|
675 | + private function translateNthChild(array $match) { |
|
676 | + $result = $this->parseNth($match); |
|
677 | + |
|
678 | + if (isset($result[self::MULTIPLIER])) { |
|
679 | + if ($result[self::MULTIPLIER] < 0) { |
|
680 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
681 | + return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
682 | + } else { |
|
683 | + return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]); |
|
684 | + } |
|
685 | + } else { |
|
686 | + return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]); |
|
687 | + } |
|
688 | + } |
|
689 | + |
|
690 | + /** |
|
691 | + * @param array $match |
|
692 | + * |
|
693 | + * @return string |
|
694 | + */ |
|
695 | + private function translateNthOfType(array $match) { |
|
696 | + $result = $this->parseNth($match); |
|
697 | + |
|
698 | + if (isset($result[self::MULTIPLIER])) { |
|
699 | + if ($result[self::MULTIPLIER] < 0) { |
|
700 | + $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]); |
|
701 | + return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
702 | + } else { |
|
703 | + return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]); |
|
704 | + } |
|
705 | + } else { |
|
706 | + return sprintf('%s[%u]', $match[1], $result[self::INDEX]); |
|
707 | + } |
|
708 | + } |
|
709 | + |
|
710 | + /** |
|
711 | + * @param array $match |
|
712 | + * |
|
713 | + * @return array |
|
714 | + */ |
|
715 | + private function parseNth(array $match) { |
|
716 | + if (in_array(strtolower($match[2]), array('even','odd'))) { |
|
717 | + $index = strtolower($match[2]) == 'even' ? 0 : 1; |
|
718 | + return array(self::MULTIPLIER => 2, self::INDEX => $index); |
|
719 | + } elseif (stripos($match[2], 'n') === false) { |
|
720 | + // if there is a multiplier |
|
721 | + $index = intval(str_replace(' ', '', $match[2])); |
|
722 | + return array(self::INDEX => $index); |
|
723 | + } else { |
|
724 | + if (isset($match[3])) { |
|
725 | + $multipleTerm = str_replace($match[3], '', $match[2]); |
|
726 | + $index = intval(str_replace(' ', '', $match[3])); |
|
727 | + } else { |
|
728 | + $multipleTerm = $match[2]; |
|
729 | + $index = 0; |
|
730 | + } |
|
731 | + |
|
732 | + $multiplier = str_ireplace('n', '', $multipleTerm); |
|
733 | + |
|
734 | + if (!strlen($multiplier)) { |
|
735 | + $multiplier = 1; |
|
736 | + } elseif ($multiplier == 0) { |
|
737 | + return array(self::INDEX => $index); |
|
738 | + } else { |
|
739 | + $multiplier = intval($multiplier); |
|
740 | + } |
|
741 | + |
|
742 | + while ($index < 0) { |
|
743 | + $index += abs($multiplier); |
|
744 | + } |
|
745 | + |
|
746 | + return array(self::MULTIPLIER => $multiplier, self::INDEX => $index); |
|
747 | + } |
|
748 | + } |
|
749 | + |
|
750 | + /** |
|
751 | + * Parses a CSS declaration block into property name/value pairs. |
|
752 | + * |
|
753 | + * Example: |
|
754 | + * |
|
755 | + * The declaration block. |
|
756 | + * |
|
757 | + * "color: #000; font-weight: bold;". |
|
758 | + * |
|
759 | + * will be parsed into the following array: |
|
760 | + * |
|
761 | + * "color" => "#000" |
|
762 | + * "font-weight" => "bold" |
|
763 | + * |
|
764 | + * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty |
|
765 | + * |
|
766 | + * @return array the CSS declarations with the property names as array keys and the property values as array values |
|
767 | + */ |
|
768 | + private function parseCssDeclarationBlock($cssDeclarationBlock) { |
|
769 | + if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) { |
|
770 | + return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock]; |
|
771 | + } |
|
772 | + |
|
773 | + $properties = array(); |
|
774 | + $declarations = explode(';', $cssDeclarationBlock); |
|
775 | + foreach ($declarations as $declaration) { |
|
776 | + $matches = array(); |
|
777 | + if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) { |
|
778 | + continue; |
|
779 | + } |
|
780 | + $propertyName = strtolower($matches[1]); |
|
781 | + $propertyValue = $matches[2]; |
|
782 | + $properties[$propertyName] = $propertyValue; |
|
783 | + } |
|
784 | + $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties; |
|
785 | + |
|
786 | + return $properties; |
|
787 | + } |
|
788 | 788 | } |
@@ -8,151 +8,151 @@ |
||
8 | 8 | */ |
9 | 9 | class WP_Session_Command extends \WP_CLI_Command { |
10 | 10 | |
11 | - /** |
|
12 | - * Count the total number of sessions stored in the database. |
|
13 | - * |
|
14 | - * |
|
15 | - * ## EXAMPLES |
|
16 | - * |
|
17 | - * wp session count |
|
18 | - * |
|
19 | - * @global wpdb $wpdb |
|
20 | - * |
|
21 | - * @param array $args |
|
22 | - * @param array $assoc_args |
|
23 | - */ |
|
24 | - public function count( $args, $assoc_args ) { |
|
25 | - $sessions = WP_Session_Utils::count_sessions(); |
|
26 | - |
|
27 | - \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
28 | - } |
|
29 | - |
|
30 | - /** |
|
31 | - * Delete sessions from the database. |
|
32 | - * |
|
33 | - * ## OPTIONS |
|
34 | - * |
|
35 | - * [--all] |
|
36 | - * : Flag whether or not to purge all sessions from the database. |
|
37 | - * |
|
38 | - * [--batch=<batch>] |
|
39 | - * : Set the batch size for deleting old sessions |
|
40 | - * |
|
41 | - * [--limit=<limit>] |
|
42 | - * : Delete just this number of old sessions |
|
43 | - * |
|
44 | - * ## EXAMPLES |
|
45 | - * |
|
46 | - * wp session delete |
|
47 | - * wp session delete [--batch=<batch>] |
|
48 | - * wp session delete [--limit=<limit>] |
|
49 | - * wp session delete [--all] |
|
50 | - * |
|
51 | - * @synopsis [--all] [--batch=<batch>] [--limit=<limit>] |
|
52 | - * |
|
53 | - * @param array $args |
|
54 | - * @param array $assoc_args |
|
55 | - */ |
|
56 | - public function delete( $args, $assoc_args ) { |
|
57 | - if ( isset( $assoc_args['limit'] ) ) { |
|
58 | - $limit = absint( $assoc_args['limit'] ); |
|
59 | - |
|
60 | - $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
61 | - |
|
62 | - if ( $count > 0 ) { |
|
63 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
64 | - } |
|
65 | - |
|
66 | - // Clear memory |
|
67 | - self::free_up_memory(); |
|
68 | - return; |
|
69 | - } |
|
70 | - |
|
71 | - // Determine if we're deleting all sessions or just a subset. |
|
72 | - $all = isset( $assoc_args['all'] ); |
|
73 | - |
|
74 | - /** |
|
75 | - * Determine the size of each batch for deletion. |
|
76 | - * |
|
77 | - * @param int |
|
78 | - */ |
|
79 | - $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
80 | - |
|
81 | - switch ( $all ) { |
|
82 | - case true: |
|
83 | - $count = WP_Session_Utils::delete_all_sessions(); |
|
84 | - |
|
85 | - \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
86 | - break; |
|
87 | - case false: |
|
88 | - do { |
|
89 | - $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
90 | - |
|
91 | - if ( $count > 0 ) { |
|
92 | - \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
93 | - } |
|
94 | - |
|
95 | - // Clear memory |
|
96 | - self::free_up_memory(); |
|
97 | - } while ( $count > 0 ); |
|
98 | - break; |
|
99 | - } |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * Generate a number of dummy sessions for testing purposes. |
|
104 | - * |
|
105 | - * ## OPTIONS |
|
106 | - * |
|
107 | - * <count> |
|
108 | - * : Number of sessions to create. |
|
109 | - * |
|
110 | - * [--expires=<date>] |
|
111 | - * : Optional expiration time tagged for each session. Will use WordPress' local time. |
|
112 | - * |
|
113 | - * ## EXAMPLES |
|
114 | - * |
|
115 | - * wp session generate 5000 |
|
116 | - * wp session generate 5000 --expires="2014-11-09T08:00" |
|
117 | - * |
|
118 | - * @synopsis <count> [--expires=<date>] |
|
119 | - * |
|
120 | - * @param array $args |
|
121 | - * @param array $assoc_args |
|
122 | - */ |
|
123 | - public function generate( $args, $assoc_args ) { |
|
124 | - $count = absint( $args[0] ); |
|
125 | - $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
126 | - |
|
127 | - $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
128 | - |
|
129 | - for ( $i = 0; $i < $count; $i ++ ) { |
|
130 | - WP_Session_Utils::create_dummy_session( $date ); |
|
131 | - $notify->tick(); |
|
132 | - } |
|
133 | - |
|
134 | - $notify->finish(); |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Free up memory |
|
139 | - * |
|
140 | - * @global WP_Object_Cache $wp_object_cache |
|
141 | - * @global wpdb $wpdb |
|
142 | - */ |
|
143 | - private function free_up_memory() { |
|
144 | - global $wp_object_cache, $wpdb; |
|
145 | - $wpdb->queries = array(); |
|
146 | - |
|
147 | - if ( ! is_object( $wp_object_cache ) ) { |
|
148 | - return; |
|
149 | - } |
|
150 | - |
|
151 | - $wp_object_cache->group_ops = array(); |
|
152 | - $wp_object_cache->stats = array(); |
|
153 | - $wp_object_cache->memcache_debug = array(); |
|
154 | - $wp_object_cache->cache = array(); |
|
155 | - } |
|
11 | + /** |
|
12 | + * Count the total number of sessions stored in the database. |
|
13 | + * |
|
14 | + * |
|
15 | + * ## EXAMPLES |
|
16 | + * |
|
17 | + * wp session count |
|
18 | + * |
|
19 | + * @global wpdb $wpdb |
|
20 | + * |
|
21 | + * @param array $args |
|
22 | + * @param array $assoc_args |
|
23 | + */ |
|
24 | + public function count( $args, $assoc_args ) { |
|
25 | + $sessions = WP_Session_Utils::count_sessions(); |
|
26 | + |
|
27 | + \WP_CLI::line( sprintf( '%d sessions currently exist.', absint( $sessions ) ) ); |
|
28 | + } |
|
29 | + |
|
30 | + /** |
|
31 | + * Delete sessions from the database. |
|
32 | + * |
|
33 | + * ## OPTIONS |
|
34 | + * |
|
35 | + * [--all] |
|
36 | + * : Flag whether or not to purge all sessions from the database. |
|
37 | + * |
|
38 | + * [--batch=<batch>] |
|
39 | + * : Set the batch size for deleting old sessions |
|
40 | + * |
|
41 | + * [--limit=<limit>] |
|
42 | + * : Delete just this number of old sessions |
|
43 | + * |
|
44 | + * ## EXAMPLES |
|
45 | + * |
|
46 | + * wp session delete |
|
47 | + * wp session delete [--batch=<batch>] |
|
48 | + * wp session delete [--limit=<limit>] |
|
49 | + * wp session delete [--all] |
|
50 | + * |
|
51 | + * @synopsis [--all] [--batch=<batch>] [--limit=<limit>] |
|
52 | + * |
|
53 | + * @param array $args |
|
54 | + * @param array $assoc_args |
|
55 | + */ |
|
56 | + public function delete( $args, $assoc_args ) { |
|
57 | + if ( isset( $assoc_args['limit'] ) ) { |
|
58 | + $limit = absint( $assoc_args['limit'] ); |
|
59 | + |
|
60 | + $count = WP_Session_Utils::delete_old_sessions( $limit ); |
|
61 | + |
|
62 | + if ( $count > 0 ) { |
|
63 | + \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
64 | + } |
|
65 | + |
|
66 | + // Clear memory |
|
67 | + self::free_up_memory(); |
|
68 | + return; |
|
69 | + } |
|
70 | + |
|
71 | + // Determine if we're deleting all sessions or just a subset. |
|
72 | + $all = isset( $assoc_args['all'] ); |
|
73 | + |
|
74 | + /** |
|
75 | + * Determine the size of each batch for deletion. |
|
76 | + * |
|
77 | + * @param int |
|
78 | + */ |
|
79 | + $batch = isset( $assoc_args['batch'] ) ? absint( $assoc_args['batch'] ) : apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
80 | + |
|
81 | + switch ( $all ) { |
|
82 | + case true: |
|
83 | + $count = WP_Session_Utils::delete_all_sessions(); |
|
84 | + |
|
85 | + \WP_CLI::line( sprintf( 'Deleted all %d sessions.', $count ) ); |
|
86 | + break; |
|
87 | + case false: |
|
88 | + do { |
|
89 | + $count = WP_Session_Utils::delete_old_sessions( $batch ); |
|
90 | + |
|
91 | + if ( $count > 0 ) { |
|
92 | + \WP_CLI::line( sprintf( 'Deleted %d sessions.', $count ) ); |
|
93 | + } |
|
94 | + |
|
95 | + // Clear memory |
|
96 | + self::free_up_memory(); |
|
97 | + } while ( $count > 0 ); |
|
98 | + break; |
|
99 | + } |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * Generate a number of dummy sessions for testing purposes. |
|
104 | + * |
|
105 | + * ## OPTIONS |
|
106 | + * |
|
107 | + * <count> |
|
108 | + * : Number of sessions to create. |
|
109 | + * |
|
110 | + * [--expires=<date>] |
|
111 | + * : Optional expiration time tagged for each session. Will use WordPress' local time. |
|
112 | + * |
|
113 | + * ## EXAMPLES |
|
114 | + * |
|
115 | + * wp session generate 5000 |
|
116 | + * wp session generate 5000 --expires="2014-11-09T08:00" |
|
117 | + * |
|
118 | + * @synopsis <count> [--expires=<date>] |
|
119 | + * |
|
120 | + * @param array $args |
|
121 | + * @param array $assoc_args |
|
122 | + */ |
|
123 | + public function generate( $args, $assoc_args ) { |
|
124 | + $count = absint( $args[0] ); |
|
125 | + $date = isset( $assoc_args['expires'] ) ? $assoc_args['expires'] : null; |
|
126 | + |
|
127 | + $notify = \WP_CLI\Utils\make_progress_bar( 'Generating sessions', $count ); |
|
128 | + |
|
129 | + for ( $i = 0; $i < $count; $i ++ ) { |
|
130 | + WP_Session_Utils::create_dummy_session( $date ); |
|
131 | + $notify->tick(); |
|
132 | + } |
|
133 | + |
|
134 | + $notify->finish(); |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Free up memory |
|
139 | + * |
|
140 | + * @global WP_Object_Cache $wp_object_cache |
|
141 | + * @global wpdb $wpdb |
|
142 | + */ |
|
143 | + private function free_up_memory() { |
|
144 | + global $wp_object_cache, $wpdb; |
|
145 | + $wpdb->queries = array(); |
|
146 | + |
|
147 | + if ( ! is_object( $wp_object_cache ) ) { |
|
148 | + return; |
|
149 | + } |
|
150 | + |
|
151 | + $wp_object_cache->group_ops = array(); |
|
152 | + $wp_object_cache->stats = array(); |
|
153 | + $wp_object_cache->memcache_debug = array(); |
|
154 | + $wp_object_cache->cache = array(); |
|
155 | + } |
|
156 | 156 | } |
157 | 157 | |
158 | 158 | \WP_CLI::add_command( 'session', 'WP_Session_Command' ); |
159 | 159 | \ No newline at end of file |
@@ -16,16 +16,16 @@ discard block |
||
16 | 16 | * @return int |
17 | 17 | */ |
18 | 18 | function wp_session_cache_expire() { |
19 | - $wp_session = WP_Session::get_instance(); |
|
19 | + $wp_session = WP_Session::get_instance(); |
|
20 | 20 | |
21 | - return $wp_session->cache_expiration(); |
|
21 | + return $wp_session->cache_expiration(); |
|
22 | 22 | } |
23 | 23 | |
24 | 24 | /** |
25 | 25 | * Alias of wp_session_write_close() |
26 | 26 | */ |
27 | 27 | function wp_session_commit() { |
28 | - wp_session_write_close(); |
|
28 | + wp_session_write_close(); |
|
29 | 29 | } |
30 | 30 | |
31 | 31 | /** |
@@ -34,9 +34,9 @@ discard block |
||
34 | 34 | * @param string $data |
35 | 35 | */ |
36 | 36 | function wp_session_decode( $data ) { |
37 | - $wp_session = WP_Session::get_instance(); |
|
37 | + $wp_session = WP_Session::get_instance(); |
|
38 | 38 | |
39 | - return $wp_session->json_in( $data ); |
|
39 | + return $wp_session->json_in( $data ); |
|
40 | 40 | } |
41 | 41 | |
42 | 42 | /** |
@@ -45,9 +45,9 @@ discard block |
||
45 | 45 | * @return string |
46 | 46 | */ |
47 | 47 | function wp_session_encode() { |
48 | - $wp_session = WP_Session::get_instance(); |
|
48 | + $wp_session = WP_Session::get_instance(); |
|
49 | 49 | |
50 | - return $wp_session->json_out(); |
|
50 | + return $wp_session->json_out(); |
|
51 | 51 | } |
52 | 52 | |
53 | 53 | /** |
@@ -58,11 +58,11 @@ discard block |
||
58 | 58 | * @return bool |
59 | 59 | */ |
60 | 60 | function wp_session_regenerate_id( $delete_old_session = false ) { |
61 | - $wp_session = WP_Session::get_instance(); |
|
61 | + $wp_session = WP_Session::get_instance(); |
|
62 | 62 | |
63 | - $wp_session->regenerate_id( $delete_old_session ); |
|
63 | + $wp_session->regenerate_id( $delete_old_session ); |
|
64 | 64 | |
65 | - return true; |
|
65 | + return true; |
|
66 | 66 | } |
67 | 67 | |
68 | 68 | /** |
@@ -73,13 +73,13 @@ discard block |
||
73 | 73 | * @return bool |
74 | 74 | */ |
75 | 75 | function wp_session_start() { |
76 | - $wp_session = WP_Session::get_instance(); |
|
77 | - do_action( 'wp_session_start' ); |
|
76 | + $wp_session = WP_Session::get_instance(); |
|
77 | + do_action( 'wp_session_start' ); |
|
78 | 78 | |
79 | - return $wp_session->session_started(); |
|
79 | + return $wp_session->session_started(); |
|
80 | 80 | } |
81 | 81 | if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
82 | - add_action( 'plugins_loaded', 'wp_session_start' ); |
|
82 | + add_action( 'plugins_loaded', 'wp_session_start' ); |
|
83 | 83 | } |
84 | 84 | |
85 | 85 | /** |
@@ -88,35 +88,35 @@ discard block |
||
88 | 88 | * @return int |
89 | 89 | */ |
90 | 90 | function wp_session_status() { |
91 | - $wp_session = WP_Session::get_instance(); |
|
91 | + $wp_session = WP_Session::get_instance(); |
|
92 | 92 | |
93 | - if ( $wp_session->session_started() ) { |
|
94 | - return PHP_SESSION_ACTIVE; |
|
95 | - } |
|
93 | + if ( $wp_session->session_started() ) { |
|
94 | + return PHP_SESSION_ACTIVE; |
|
95 | + } |
|
96 | 96 | |
97 | - return PHP_SESSION_NONE; |
|
97 | + return PHP_SESSION_NONE; |
|
98 | 98 | } |
99 | 99 | |
100 | 100 | /** |
101 | 101 | * Unset all session variables. |
102 | 102 | */ |
103 | 103 | function wp_session_unset() { |
104 | - $wp_session = WP_Session::get_instance(); |
|
104 | + $wp_session = WP_Session::get_instance(); |
|
105 | 105 | |
106 | - $wp_session->reset(); |
|
106 | + $wp_session->reset(); |
|
107 | 107 | } |
108 | 108 | |
109 | 109 | /** |
110 | 110 | * Write session data and end session |
111 | 111 | */ |
112 | 112 | function wp_session_write_close() { |
113 | - $wp_session = WP_Session::get_instance(); |
|
113 | + $wp_session = WP_Session::get_instance(); |
|
114 | 114 | |
115 | - $wp_session->write_data(); |
|
116 | - do_action( 'wp_session_commit' ); |
|
115 | + $wp_session->write_data(); |
|
116 | + do_action( 'wp_session_commit' ); |
|
117 | 117 | } |
118 | 118 | if ( ! defined( 'WP_CLI' ) || false === WP_CLI ) { |
119 | - add_action( 'shutdown', 'wp_session_write_close' ); |
|
119 | + add_action( 'shutdown', 'wp_session_write_close' ); |
|
120 | 120 | } |
121 | 121 | |
122 | 122 | /** |
@@ -127,24 +127,24 @@ discard block |
||
127 | 127 | * of a scheduled task or cron job. |
128 | 128 | */ |
129 | 129 | function wp_session_cleanup() { |
130 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
131 | - return; |
|
132 | - } |
|
133 | - |
|
134 | - if ( ! defined( 'WP_INSTALLING' ) ) { |
|
135 | - /** |
|
136 | - * Determine the size of each batch for deletion. |
|
137 | - * |
|
138 | - * @param int |
|
139 | - */ |
|
140 | - $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
141 | - |
|
142 | - // Delete a batch of old sessions |
|
143 | - WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
144 | - } |
|
145 | - |
|
146 | - // Allow other plugins to hook in to the garbage collection process. |
|
147 | - do_action( 'wp_session_cleanup' ); |
|
130 | + if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
131 | + return; |
|
132 | + } |
|
133 | + |
|
134 | + if ( ! defined( 'WP_INSTALLING' ) ) { |
|
135 | + /** |
|
136 | + * Determine the size of each batch for deletion. |
|
137 | + * |
|
138 | + * @param int |
|
139 | + */ |
|
140 | + $batch_size = apply_filters( 'wp_session_delete_batch_size', 1000 ); |
|
141 | + |
|
142 | + // Delete a batch of old sessions |
|
143 | + WP_Session_Utils::delete_old_sessions( $batch_size ); |
|
144 | + } |
|
145 | + |
|
146 | + // Allow other plugins to hook in to the garbage collection process. |
|
147 | + do_action( 'wp_session_cleanup' ); |
|
148 | 148 | } |
149 | 149 | add_action( 'wp_session_garbage_collection', 'wp_session_cleanup' ); |
150 | 150 | |
@@ -152,8 +152,8 @@ discard block |
||
152 | 152 | * Register the garbage collector as a twice daily event. |
153 | 153 | */ |
154 | 154 | function wp_session_register_garbage_collection() { |
155 | - if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
156 | - wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
157 | - } |
|
155 | + if ( ! wp_next_scheduled( 'wp_session_garbage_collection' ) ) { |
|
156 | + wp_schedule_event( time(), 'hourly', 'wp_session_garbage_collection' ); |
|
157 | + } |
|
158 | 158 | } |
159 | 159 | add_action( 'wp', 'wp_session_register_garbage_collection' ); |
@@ -17,215 +17,215 @@ |
||
17 | 17 | * @since 3.7.0 |
18 | 18 | */ |
19 | 19 | final class WP_Session extends Recursive_ArrayAccess { |
20 | - /** |
|
21 | - * ID of the current session. |
|
22 | - * |
|
23 | - * @var string |
|
24 | - */ |
|
25 | - public $session_id; |
|
26 | - |
|
27 | - /** |
|
28 | - * Unix timestamp when session expires. |
|
29 | - * |
|
30 | - * @var int |
|
31 | - */ |
|
32 | - protected $expires; |
|
33 | - |
|
34 | - /** |
|
35 | - * Unix timestamp indicating when the expiration time needs to be reset. |
|
36 | - * |
|
37 | - * @var int |
|
38 | - */ |
|
39 | - protected $exp_variant; |
|
40 | - |
|
41 | - /** |
|
42 | - * Singleton instance. |
|
43 | - * |
|
44 | - * @var bool|WP_Session |
|
45 | - */ |
|
46 | - private static $instance = false; |
|
47 | - |
|
48 | - /** |
|
49 | - * Retrieve the current session instance. |
|
50 | - * |
|
51 | - * @param bool $session_id Session ID from which to populate data. |
|
52 | - * |
|
53 | - * @return bool|WP_Session |
|
54 | - */ |
|
55 | - public static function get_instance() { |
|
56 | - if ( ! self::$instance ) { |
|
57 | - self::$instance = new self(); |
|
58 | - } |
|
59 | - |
|
60 | - return self::$instance; |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * Default constructor. |
|
65 | - * Will rebuild the session collection from the given session ID if it exists. Otherwise, will |
|
66 | - * create a new session with that ID. |
|
67 | - * |
|
68 | - * @param $session_id |
|
69 | - * @uses apply_filters Calls `wp_session_expiration` to determine how long until sessions expire. |
|
70 | - */ |
|
71 | - protected function __construct() { |
|
72 | - if ( isset( $_COOKIE[WP_SESSION_COOKIE] ) ) { |
|
73 | - $cookie = stripslashes( $_COOKIE[WP_SESSION_COOKIE] ); |
|
74 | - $cookie_crumbs = explode( '||', $cookie ); |
|
20 | + /** |
|
21 | + * ID of the current session. |
|
22 | + * |
|
23 | + * @var string |
|
24 | + */ |
|
25 | + public $session_id; |
|
26 | + |
|
27 | + /** |
|
28 | + * Unix timestamp when session expires. |
|
29 | + * |
|
30 | + * @var int |
|
31 | + */ |
|
32 | + protected $expires; |
|
33 | + |
|
34 | + /** |
|
35 | + * Unix timestamp indicating when the expiration time needs to be reset. |
|
36 | + * |
|
37 | + * @var int |
|
38 | + */ |
|
39 | + protected $exp_variant; |
|
40 | + |
|
41 | + /** |
|
42 | + * Singleton instance. |
|
43 | + * |
|
44 | + * @var bool|WP_Session |
|
45 | + */ |
|
46 | + private static $instance = false; |
|
47 | + |
|
48 | + /** |
|
49 | + * Retrieve the current session instance. |
|
50 | + * |
|
51 | + * @param bool $session_id Session ID from which to populate data. |
|
52 | + * |
|
53 | + * @return bool|WP_Session |
|
54 | + */ |
|
55 | + public static function get_instance() { |
|
56 | + if ( ! self::$instance ) { |
|
57 | + self::$instance = new self(); |
|
58 | + } |
|
59 | + |
|
60 | + return self::$instance; |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * Default constructor. |
|
65 | + * Will rebuild the session collection from the given session ID if it exists. Otherwise, will |
|
66 | + * create a new session with that ID. |
|
67 | + * |
|
68 | + * @param $session_id |
|
69 | + * @uses apply_filters Calls `wp_session_expiration` to determine how long until sessions expire. |
|
70 | + */ |
|
71 | + protected function __construct() { |
|
72 | + if ( isset( $_COOKIE[WP_SESSION_COOKIE] ) ) { |
|
73 | + $cookie = stripslashes( $_COOKIE[WP_SESSION_COOKIE] ); |
|
74 | + $cookie_crumbs = explode( '||', $cookie ); |
|
75 | 75 | |
76 | 76 | $this->session_id = preg_replace("/[^A-Za-z0-9_]/", '', $cookie_crumbs[0] ); |
77 | 77 | $this->expires = absint( $cookie_crumbs[1] ); |
78 | 78 | $this->exp_variant = absint( $cookie_crumbs[2] ); |
79 | 79 | |
80 | - // Update the session expiration if we're past the variant time |
|
81 | - if ( time() > $this->exp_variant ) { |
|
82 | - $this->set_expiration(); |
|
83 | - delete_option( "_wp_session_expires_{$this->session_id}" ); |
|
84 | - add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
85 | - } |
|
86 | - } else { |
|
87 | - $this->session_id = WP_Session_Utils::generate_id(); |
|
88 | - $this->set_expiration(); |
|
89 | - } |
|
90 | - |
|
91 | - $this->read_data(); |
|
92 | - |
|
93 | - $this->set_cookie(); |
|
94 | - |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * Set both the expiration time and the expiration variant. |
|
99 | - * |
|
100 | - * If the current time is below the variant, we don't update the session's expiration time. If it's |
|
101 | - * greater than the variant, then we update the expiration time in the database. This prevents |
|
102 | - * writing to the database on every page load for active sessions and only updates the expiration |
|
103 | - * time if we're nearing when the session actually expires. |
|
104 | - * |
|
105 | - * By default, the expiration time is set to 30 minutes. |
|
106 | - * By default, the expiration variant is set to 24 minutes. |
|
107 | - * |
|
108 | - * As a result, the session expiration time - at a maximum - will only be written to the database once |
|
109 | - * every 24 minutes. After 30 minutes, the session will have been expired. No cookie will be sent by |
|
110 | - * the browser, and the old session will be queued for deletion by the garbage collector. |
|
111 | - * |
|
112 | - * @uses apply_filters Calls `wp_session_expiration_variant` to get the max update window for session data. |
|
113 | - * @uses apply_filters Calls `wp_session_expiration` to get the standard expiration time for sessions. |
|
114 | - */ |
|
115 | - protected function set_expiration() { |
|
116 | - $this->exp_variant = time() + (int) apply_filters( 'wp_session_expiration_variant', 24 * 60 ); |
|
117 | - $this->expires = time() + (int) apply_filters( 'wp_session_expiration', 30 * 60 ); |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * Set the session cookie |
|
122 | - * @uses apply_filters Calls `wp_session_cookie_secure` to set the $secure parameter of setcookie() |
|
123 | - * @uses apply_filters Calls `wp_session_cookie_httponly` to set the $httponly parameter of setcookie() |
|
124 | - */ |
|
125 | - protected function set_cookie() { |
|
126 | - if ( !defined( 'WPI_TESTING_MODE' ) ) { |
|
127 | - try { |
|
128 | - $secure = apply_filters('wp_session_cookie_secure', false); |
|
129 | - $httponly = apply_filters('wp_session_cookie_httponly', false); |
|
130 | - setcookie( WP_SESSION_COOKIE, $this->session_id . '||' . $this->expires . '||' . $this->exp_variant , $this->expires, COOKIEPATH, COOKIE_DOMAIN, $secure, $httponly ); |
|
131 | - } catch(Exception $e) { |
|
132 | - error_log( 'Set Cookie Error: ' . $e->getMessage() ); |
|
133 | - } |
|
134 | - } |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Read data from a transient for the current session. |
|
139 | - * |
|
140 | - * Automatically resets the expiration time for the session transient to some time in the future. |
|
141 | - * |
|
142 | - * @return array |
|
143 | - */ |
|
144 | - protected function read_data() { |
|
145 | - $this->container = get_option( "_wp_session_{$this->session_id}", array() ); |
|
146 | - |
|
147 | - return $this->container; |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Write the data from the current session to the data storage system. |
|
152 | - */ |
|
153 | - public function write_data() { |
|
154 | - $option_key = "_wp_session_{$this->session_id}"; |
|
80 | + // Update the session expiration if we're past the variant time |
|
81 | + if ( time() > $this->exp_variant ) { |
|
82 | + $this->set_expiration(); |
|
83 | + delete_option( "_wp_session_expires_{$this->session_id}" ); |
|
84 | + add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
85 | + } |
|
86 | + } else { |
|
87 | + $this->session_id = WP_Session_Utils::generate_id(); |
|
88 | + $this->set_expiration(); |
|
89 | + } |
|
90 | + |
|
91 | + $this->read_data(); |
|
92 | + |
|
93 | + $this->set_cookie(); |
|
94 | + |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * Set both the expiration time and the expiration variant. |
|
99 | + * |
|
100 | + * If the current time is below the variant, we don't update the session's expiration time. If it's |
|
101 | + * greater than the variant, then we update the expiration time in the database. This prevents |
|
102 | + * writing to the database on every page load for active sessions and only updates the expiration |
|
103 | + * time if we're nearing when the session actually expires. |
|
104 | + * |
|
105 | + * By default, the expiration time is set to 30 minutes. |
|
106 | + * By default, the expiration variant is set to 24 minutes. |
|
107 | + * |
|
108 | + * As a result, the session expiration time - at a maximum - will only be written to the database once |
|
109 | + * every 24 minutes. After 30 minutes, the session will have been expired. No cookie will be sent by |
|
110 | + * the browser, and the old session will be queued for deletion by the garbage collector. |
|
111 | + * |
|
112 | + * @uses apply_filters Calls `wp_session_expiration_variant` to get the max update window for session data. |
|
113 | + * @uses apply_filters Calls `wp_session_expiration` to get the standard expiration time for sessions. |
|
114 | + */ |
|
115 | + protected function set_expiration() { |
|
116 | + $this->exp_variant = time() + (int) apply_filters( 'wp_session_expiration_variant', 24 * 60 ); |
|
117 | + $this->expires = time() + (int) apply_filters( 'wp_session_expiration', 30 * 60 ); |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * Set the session cookie |
|
122 | + * @uses apply_filters Calls `wp_session_cookie_secure` to set the $secure parameter of setcookie() |
|
123 | + * @uses apply_filters Calls `wp_session_cookie_httponly` to set the $httponly parameter of setcookie() |
|
124 | + */ |
|
125 | + protected function set_cookie() { |
|
126 | + if ( !defined( 'WPI_TESTING_MODE' ) ) { |
|
127 | + try { |
|
128 | + $secure = apply_filters('wp_session_cookie_secure', false); |
|
129 | + $httponly = apply_filters('wp_session_cookie_httponly', false); |
|
130 | + setcookie( WP_SESSION_COOKIE, $this->session_id . '||' . $this->expires . '||' . $this->exp_variant , $this->expires, COOKIEPATH, COOKIE_DOMAIN, $secure, $httponly ); |
|
131 | + } catch(Exception $e) { |
|
132 | + error_log( 'Set Cookie Error: ' . $e->getMessage() ); |
|
133 | + } |
|
134 | + } |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Read data from a transient for the current session. |
|
139 | + * |
|
140 | + * Automatically resets the expiration time for the session transient to some time in the future. |
|
141 | + * |
|
142 | + * @return array |
|
143 | + */ |
|
144 | + protected function read_data() { |
|
145 | + $this->container = get_option( "_wp_session_{$this->session_id}", array() ); |
|
146 | + |
|
147 | + return $this->container; |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Write the data from the current session to the data storage system. |
|
152 | + */ |
|
153 | + public function write_data() { |
|
154 | + $option_key = "_wp_session_{$this->session_id}"; |
|
155 | 155 | |
156 | - if ( false === get_option( $option_key ) ) { |
|
157 | - add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
158 | - add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
159 | - } else { |
|
160 | - delete_option( "_wp_session_{$this->session_id}" ); |
|
161 | - add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
162 | - } |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * Output the current container contents as a JSON-encoded string. |
|
167 | - * |
|
168 | - * @return string |
|
169 | - */ |
|
170 | - public function json_out() { |
|
171 | - return json_encode( $this->container ); |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Decodes a JSON string and, if the object is an array, overwrites the session container with its contents. |
|
176 | - * |
|
177 | - * @param string $data |
|
178 | - * |
|
179 | - * @return bool |
|
180 | - */ |
|
181 | - public function json_in( $data ) { |
|
182 | - $array = json_decode( $data ); |
|
183 | - |
|
184 | - if ( is_array( $array ) ) { |
|
185 | - $this->container = $array; |
|
186 | - return true; |
|
187 | - } |
|
188 | - |
|
189 | - return false; |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * Regenerate the current session's ID. |
|
194 | - * |
|
195 | - * @param bool $delete_old Flag whether or not to delete the old session data from the server. |
|
196 | - */ |
|
197 | - public function regenerate_id( $delete_old = false ) { |
|
198 | - if ( $delete_old ) { |
|
199 | - delete_option( "_wp_session_{$this->session_id}" ); |
|
200 | - } |
|
201 | - |
|
202 | - $this->session_id = WP_Session_Utils::generate_id(); |
|
203 | - |
|
204 | - $this->set_cookie(); |
|
205 | - } |
|
206 | - |
|
207 | - /** |
|
208 | - * Check if a session has been initialized. |
|
209 | - * |
|
210 | - * @return bool |
|
211 | - */ |
|
212 | - public function session_started() { |
|
213 | - return !!self::$instance; |
|
214 | - } |
|
215 | - |
|
216 | - /** |
|
217 | - * Return the read-only cache expiration value. |
|
218 | - * |
|
219 | - * @return int |
|
220 | - */ |
|
221 | - public function cache_expiration() { |
|
222 | - return $this->expires; |
|
223 | - } |
|
224 | - |
|
225 | - /** |
|
226 | - * Flushes all session variables. |
|
227 | - */ |
|
228 | - public function reset() { |
|
229 | - $this->container = array(); |
|
230 | - } |
|
156 | + if ( false === get_option( $option_key ) ) { |
|
157 | + add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
158 | + add_option( "_wp_session_expires_{$this->session_id}", $this->expires, '', 'no' ); |
|
159 | + } else { |
|
160 | + delete_option( "_wp_session_{$this->session_id}" ); |
|
161 | + add_option( "_wp_session_{$this->session_id}", $this->container, '', 'no' ); |
|
162 | + } |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * Output the current container contents as a JSON-encoded string. |
|
167 | + * |
|
168 | + * @return string |
|
169 | + */ |
|
170 | + public function json_out() { |
|
171 | + return json_encode( $this->container ); |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Decodes a JSON string and, if the object is an array, overwrites the session container with its contents. |
|
176 | + * |
|
177 | + * @param string $data |
|
178 | + * |
|
179 | + * @return bool |
|
180 | + */ |
|
181 | + public function json_in( $data ) { |
|
182 | + $array = json_decode( $data ); |
|
183 | + |
|
184 | + if ( is_array( $array ) ) { |
|
185 | + $this->container = $array; |
|
186 | + return true; |
|
187 | + } |
|
188 | + |
|
189 | + return false; |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * Regenerate the current session's ID. |
|
194 | + * |
|
195 | + * @param bool $delete_old Flag whether or not to delete the old session data from the server. |
|
196 | + */ |
|
197 | + public function regenerate_id( $delete_old = false ) { |
|
198 | + if ( $delete_old ) { |
|
199 | + delete_option( "_wp_session_{$this->session_id}" ); |
|
200 | + } |
|
201 | + |
|
202 | + $this->session_id = WP_Session_Utils::generate_id(); |
|
203 | + |
|
204 | + $this->set_cookie(); |
|
205 | + } |
|
206 | + |
|
207 | + /** |
|
208 | + * Check if a session has been initialized. |
|
209 | + * |
|
210 | + * @return bool |
|
211 | + */ |
|
212 | + public function session_started() { |
|
213 | + return !!self::$instance; |
|
214 | + } |
|
215 | + |
|
216 | + /** |
|
217 | + * Return the read-only cache expiration value. |
|
218 | + * |
|
219 | + * @return int |
|
220 | + */ |
|
221 | + public function cache_expiration() { |
|
222 | + return $this->expires; |
|
223 | + } |
|
224 | + |
|
225 | + /** |
|
226 | + * Flushes all session variables. |
|
227 | + */ |
|
228 | + public function reset() { |
|
229 | + $this->container = array(); |
|
230 | + } |
|
231 | 231 | } |
@@ -17,197 +17,197 @@ |
||
17 | 17 | * @since 3.7.0 |
18 | 18 | */ |
19 | 19 | class Recursive_ArrayAccess implements ArrayAccess, Iterator, Countable { |
20 | - /** |
|
21 | - * Internal data collection. |
|
22 | - * |
|
23 | - * @var array |
|
24 | - */ |
|
25 | - protected $container = array(); |
|
26 | - |
|
27 | - /** |
|
28 | - * Flag whether or not the internal collection has been changed. |
|
29 | - * |
|
30 | - * @var bool |
|
31 | - */ |
|
32 | - protected $dirty = false; |
|
33 | - |
|
34 | - /** |
|
35 | - * Default object constructor. |
|
36 | - * |
|
37 | - * @param array $data |
|
38 | - */ |
|
39 | - protected function __construct( $data = array() ) { |
|
40 | - foreach ( $data as $key => $value ) { |
|
41 | - $this[ $key ] = $value; |
|
42 | - } |
|
43 | - } |
|
44 | - |
|
45 | - /** |
|
46 | - * Allow deep copies of objects |
|
47 | - */ |
|
48 | - public function __clone() { |
|
49 | - foreach ( $this->container as $key => $value ) { |
|
50 | - if ( $value instanceof self ) { |
|
51 | - $this[ $key ] = clone $value; |
|
52 | - } |
|
53 | - } |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Output the data container as a multidimensional array. |
|
58 | - * |
|
59 | - * @return array |
|
60 | - */ |
|
61 | - public function toArray() { |
|
62 | - $data = $this->container; |
|
63 | - foreach ( $data as $key => $value ) { |
|
64 | - if ( $value instanceof self ) { |
|
65 | - $data[ $key ] = $value->toArray(); |
|
66 | - } |
|
67 | - } |
|
68 | - return $data; |
|
69 | - } |
|
70 | - |
|
71 | - /*****************************************************************/ |
|
72 | - /* ArrayAccess Implementation */ |
|
73 | - /*****************************************************************/ |
|
74 | - |
|
75 | - /** |
|
76 | - * Whether a offset exists |
|
77 | - * |
|
78 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
79 | - * |
|
80 | - * @param mixed $offset An offset to check for. |
|
81 | - * |
|
82 | - * @return boolean true on success or false on failure. |
|
83 | - */ |
|
84 | - public function offsetExists( $offset ) { |
|
85 | - return isset( $this->container[ $offset ]) ; |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * Offset to retrieve |
|
90 | - * |
|
91 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
92 | - * |
|
93 | - * @param mixed $offset The offset to retrieve. |
|
94 | - * |
|
95 | - * @return mixed Can return all value types. |
|
96 | - */ |
|
97 | - public function offsetGet( $offset ) { |
|
98 | - return isset( $this->container[ $offset ] ) ? $this->container[ $offset ] : null; |
|
99 | - } |
|
100 | - |
|
101 | - /** |
|
102 | - * Offset to set |
|
103 | - * |
|
104 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
105 | - * |
|
106 | - * @param mixed $offset The offset to assign the value to. |
|
107 | - * @param mixed $value The value to set. |
|
108 | - * |
|
109 | - * @return void |
|
110 | - */ |
|
111 | - public function offsetSet( $offset, $data ) { |
|
112 | - if ( is_array( $data ) ) { |
|
113 | - $data = new self( $data ); |
|
114 | - } |
|
115 | - if ( $offset === null ) { // don't forget this! |
|
116 | - $this->container[] = $data; |
|
117 | - } else { |
|
118 | - $this->container[ $offset ] = $data; |
|
119 | - } |
|
120 | - |
|
121 | - $this->dirty = true; |
|
122 | - } |
|
123 | - |
|
124 | - /** |
|
125 | - * Offset to unset |
|
126 | - * |
|
127 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
128 | - * |
|
129 | - * @param mixed $offset The offset to unset. |
|
130 | - * |
|
131 | - * @return void |
|
132 | - */ |
|
133 | - public function offsetUnset( $offset ) { |
|
134 | - unset( $this->container[ $offset ] ); |
|
135 | - |
|
136 | - $this->dirty = true; |
|
137 | - } |
|
20 | + /** |
|
21 | + * Internal data collection. |
|
22 | + * |
|
23 | + * @var array |
|
24 | + */ |
|
25 | + protected $container = array(); |
|
26 | + |
|
27 | + /** |
|
28 | + * Flag whether or not the internal collection has been changed. |
|
29 | + * |
|
30 | + * @var bool |
|
31 | + */ |
|
32 | + protected $dirty = false; |
|
33 | + |
|
34 | + /** |
|
35 | + * Default object constructor. |
|
36 | + * |
|
37 | + * @param array $data |
|
38 | + */ |
|
39 | + protected function __construct( $data = array() ) { |
|
40 | + foreach ( $data as $key => $value ) { |
|
41 | + $this[ $key ] = $value; |
|
42 | + } |
|
43 | + } |
|
44 | + |
|
45 | + /** |
|
46 | + * Allow deep copies of objects |
|
47 | + */ |
|
48 | + public function __clone() { |
|
49 | + foreach ( $this->container as $key => $value ) { |
|
50 | + if ( $value instanceof self ) { |
|
51 | + $this[ $key ] = clone $value; |
|
52 | + } |
|
53 | + } |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Output the data container as a multidimensional array. |
|
58 | + * |
|
59 | + * @return array |
|
60 | + */ |
|
61 | + public function toArray() { |
|
62 | + $data = $this->container; |
|
63 | + foreach ( $data as $key => $value ) { |
|
64 | + if ( $value instanceof self ) { |
|
65 | + $data[ $key ] = $value->toArray(); |
|
66 | + } |
|
67 | + } |
|
68 | + return $data; |
|
69 | + } |
|
70 | + |
|
71 | + /*****************************************************************/ |
|
72 | + /* ArrayAccess Implementation */ |
|
73 | + /*****************************************************************/ |
|
74 | + |
|
75 | + /** |
|
76 | + * Whether a offset exists |
|
77 | + * |
|
78 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
79 | + * |
|
80 | + * @param mixed $offset An offset to check for. |
|
81 | + * |
|
82 | + * @return boolean true on success or false on failure. |
|
83 | + */ |
|
84 | + public function offsetExists( $offset ) { |
|
85 | + return isset( $this->container[ $offset ]) ; |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * Offset to retrieve |
|
90 | + * |
|
91 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
92 | + * |
|
93 | + * @param mixed $offset The offset to retrieve. |
|
94 | + * |
|
95 | + * @return mixed Can return all value types. |
|
96 | + */ |
|
97 | + public function offsetGet( $offset ) { |
|
98 | + return isset( $this->container[ $offset ] ) ? $this->container[ $offset ] : null; |
|
99 | + } |
|
100 | + |
|
101 | + /** |
|
102 | + * Offset to set |
|
103 | + * |
|
104 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
105 | + * |
|
106 | + * @param mixed $offset The offset to assign the value to. |
|
107 | + * @param mixed $value The value to set. |
|
108 | + * |
|
109 | + * @return void |
|
110 | + */ |
|
111 | + public function offsetSet( $offset, $data ) { |
|
112 | + if ( is_array( $data ) ) { |
|
113 | + $data = new self( $data ); |
|
114 | + } |
|
115 | + if ( $offset === null ) { // don't forget this! |
|
116 | + $this->container[] = $data; |
|
117 | + } else { |
|
118 | + $this->container[ $offset ] = $data; |
|
119 | + } |
|
120 | + |
|
121 | + $this->dirty = true; |
|
122 | + } |
|
123 | + |
|
124 | + /** |
|
125 | + * Offset to unset |
|
126 | + * |
|
127 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
128 | + * |
|
129 | + * @param mixed $offset The offset to unset. |
|
130 | + * |
|
131 | + * @return void |
|
132 | + */ |
|
133 | + public function offsetUnset( $offset ) { |
|
134 | + unset( $this->container[ $offset ] ); |
|
135 | + |
|
136 | + $this->dirty = true; |
|
137 | + } |
|
138 | 138 | |
139 | 139 | |
140 | - /*****************************************************************/ |
|
141 | - /* Iterator Implementation */ |
|
142 | - /*****************************************************************/ |
|
143 | - |
|
144 | - /** |
|
145 | - * Current position of the array. |
|
146 | - * |
|
147 | - * @link http://php.net/manual/en/iterator.current.php |
|
148 | - * |
|
149 | - * @return mixed |
|
150 | - */ |
|
151 | - public function current() { |
|
152 | - return current( $this->container ); |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * Key of the current element. |
|
157 | - * |
|
158 | - * @link http://php.net/manual/en/iterator.key.php |
|
159 | - * |
|
160 | - * @return mixed |
|
161 | - */ |
|
162 | - public function key() { |
|
163 | - return key( $this->container ); |
|
164 | - } |
|
165 | - |
|
166 | - /** |
|
167 | - * Move the internal point of the container array to the next item |
|
168 | - * |
|
169 | - * @link http://php.net/manual/en/iterator.next.php |
|
170 | - * |
|
171 | - * @return void |
|
172 | - */ |
|
173 | - public function next() { |
|
174 | - next( $this->container ); |
|
175 | - } |
|
176 | - |
|
177 | - /** |
|
178 | - * Rewind the internal point of the container array. |
|
179 | - * |
|
180 | - * @link http://php.net/manual/en/iterator.rewind.php |
|
181 | - * |
|
182 | - * @return void |
|
183 | - */ |
|
184 | - public function rewind() { |
|
185 | - reset( $this->container ); |
|
186 | - } |
|
187 | - |
|
188 | - /** |
|
189 | - * Is the current key valid? |
|
190 | - * |
|
191 | - * @link http://php.net/manual/en/iterator.rewind.php |
|
192 | - * |
|
193 | - * @return bool |
|
194 | - */ |
|
195 | - public function valid() { |
|
196 | - return $this->offsetExists( $this->key() ); |
|
197 | - } |
|
198 | - |
|
199 | - /*****************************************************************/ |
|
200 | - /* Countable Implementation */ |
|
201 | - /*****************************************************************/ |
|
202 | - |
|
203 | - /** |
|
204 | - * Get the count of elements in the container array. |
|
205 | - * |
|
206 | - * @link http://php.net/manual/en/countable.count.php |
|
207 | - * |
|
208 | - * @return int |
|
209 | - */ |
|
210 | - public function count() { |
|
211 | - return count( $this->container ); |
|
212 | - } |
|
140 | + /*****************************************************************/ |
|
141 | + /* Iterator Implementation */ |
|
142 | + /*****************************************************************/ |
|
143 | + |
|
144 | + /** |
|
145 | + * Current position of the array. |
|
146 | + * |
|
147 | + * @link http://php.net/manual/en/iterator.current.php |
|
148 | + * |
|
149 | + * @return mixed |
|
150 | + */ |
|
151 | + public function current() { |
|
152 | + return current( $this->container ); |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * Key of the current element. |
|
157 | + * |
|
158 | + * @link http://php.net/manual/en/iterator.key.php |
|
159 | + * |
|
160 | + * @return mixed |
|
161 | + */ |
|
162 | + public function key() { |
|
163 | + return key( $this->container ); |
|
164 | + } |
|
165 | + |
|
166 | + /** |
|
167 | + * Move the internal point of the container array to the next item |
|
168 | + * |
|
169 | + * @link http://php.net/manual/en/iterator.next.php |
|
170 | + * |
|
171 | + * @return void |
|
172 | + */ |
|
173 | + public function next() { |
|
174 | + next( $this->container ); |
|
175 | + } |
|
176 | + |
|
177 | + /** |
|
178 | + * Rewind the internal point of the container array. |
|
179 | + * |
|
180 | + * @link http://php.net/manual/en/iterator.rewind.php |
|
181 | + * |
|
182 | + * @return void |
|
183 | + */ |
|
184 | + public function rewind() { |
|
185 | + reset( $this->container ); |
|
186 | + } |
|
187 | + |
|
188 | + /** |
|
189 | + * Is the current key valid? |
|
190 | + * |
|
191 | + * @link http://php.net/manual/en/iterator.rewind.php |
|
192 | + * |
|
193 | + * @return bool |
|
194 | + */ |
|
195 | + public function valid() { |
|
196 | + return $this->offsetExists( $this->key() ); |
|
197 | + } |
|
198 | + |
|
199 | + /*****************************************************************/ |
|
200 | + /* Countable Implementation */ |
|
201 | + /*****************************************************************/ |
|
202 | + |
|
203 | + /** |
|
204 | + * Get the count of elements in the container array. |
|
205 | + * |
|
206 | + * @link http://php.net/manual/en/countable.count.php |
|
207 | + * |
|
208 | + * @return int |
|
209 | + */ |
|
210 | + public function count() { |
|
211 | + return count( $this->container ); |
|
212 | + } |
|
213 | 213 | } |
@@ -6,134 +6,134 @@ |
||
6 | 6 | * THIS CLASS SHOULD NEVER BE INSTANTIATED |
7 | 7 | */ |
8 | 8 | class WP_Session_Utils { |
9 | - /** |
|
10 | - * Count the total sessions in the database. |
|
11 | - * |
|
12 | - * @global wpdb $wpdb |
|
13 | - * |
|
14 | - * @return int |
|
15 | - */ |
|
16 | - public static function count_sessions() { |
|
17 | - global $wpdb; |
|
18 | - |
|
19 | - $query = "SELECT COUNT(*) FROM $wpdb->options WHERE option_name LIKE '_wp_session_expires_%'"; |
|
20 | - |
|
21 | - /** |
|
22 | - * Filter the query in case tables are non-standard. |
|
23 | - * |
|
24 | - * @param string $query Database count query |
|
25 | - */ |
|
26 | - $query = apply_filters( 'wp_session_count_query', $query ); |
|
27 | - |
|
28 | - $sessions = $wpdb->get_var( $query ); |
|
29 | - |
|
30 | - return absint( $sessions ); |
|
31 | - } |
|
32 | - |
|
33 | - /** |
|
34 | - * Create a new, random session in the database. |
|
35 | - * |
|
36 | - * @param null|string $date |
|
37 | - */ |
|
38 | - public static function create_dummy_session( $date = null ) { |
|
39 | - // Generate our date |
|
40 | - if ( null !== $date ) { |
|
41 | - $time = strtotime( $date ); |
|
42 | - |
|
43 | - if ( false === $time ) { |
|
44 | - $date = null; |
|
45 | - } else { |
|
46 | - $expires = date( 'U', strtotime( $date ) ); |
|
47 | - } |
|
48 | - } |
|
49 | - |
|
50 | - // If null was passed, or if the string parsing failed, fall back on a default |
|
51 | - if ( null === $date ) { |
|
52 | - /** |
|
53 | - * Filter the expiration of the session in the database |
|
54 | - * |
|
55 | - * @param int |
|
56 | - */ |
|
57 | - $expires = time() + (int) apply_filters( 'wp_session_expiration', 30 * 60 ); |
|
58 | - } |
|
59 | - |
|
60 | - $session_id = self::generate_id(); |
|
61 | - |
|
62 | - // Store the session |
|
63 | - add_option( "_wp_session_{$session_id}", array(), '', 'no' ); |
|
64 | - add_option( "_wp_session_expires_{$session_id}", $expires, '', 'no' ); |
|
65 | - } |
|
66 | - |
|
67 | - /** |
|
68 | - * Delete old sessions from the database. |
|
69 | - * |
|
70 | - * @param int $limit Maximum number of sessions to delete. |
|
71 | - * |
|
72 | - * @global wpdb $wpdb |
|
73 | - * |
|
74 | - * @return int Sessions deleted. |
|
75 | - */ |
|
76 | - public static function delete_old_sessions( $limit = 1000 ) { |
|
77 | - global $wpdb; |
|
78 | - |
|
79 | - $limit = absint( $limit ); |
|
80 | - $keys = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE option_name LIKE '_wp_session_expires_%' ORDER BY option_value ASC LIMIT 0, {$limit}" ); |
|
81 | - |
|
82 | - $now = time(); |
|
83 | - $expired = array(); |
|
84 | - $count = 0; |
|
85 | - |
|
86 | - foreach( $keys as $expiration ) { |
|
87 | - $key = $expiration->option_name; |
|
88 | - $expires = $expiration->option_value; |
|
89 | - |
|
90 | - if ( $now > $expires ) { |
|
91 | - $session_id = preg_replace("/[^A-Za-z0-9_]/", '', substr( $key, 20 ) ); |
|
92 | - |
|
93 | - $expired[] = $key; |
|
94 | - $expired[] = "_wp_session_{$session_id}"; |
|
95 | - |
|
96 | - $count += 1; |
|
97 | - } |
|
98 | - } |
|
99 | - |
|
100 | - // Delete expired sessions |
|
101 | - if ( ! empty( $expired ) ) { |
|
102 | - $placeholders = array_fill( 0, count( $expired ), '%s' ); |
|
103 | - $format = implode( ', ', $placeholders ); |
|
104 | - $query = "DELETE FROM $wpdb->options WHERE option_name IN ($format)"; |
|
105 | - |
|
106 | - $prepared = $wpdb->prepare( $query, $expired ); |
|
107 | - $wpdb->query( $prepared ); |
|
108 | - } |
|
109 | - |
|
110 | - return $count; |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Remove all sessions from the database, regardless of expiration. |
|
115 | - * |
|
116 | - * @global wpdb $wpdb |
|
117 | - * |
|
118 | - * @return int Sessions deleted |
|
119 | - */ |
|
120 | - public static function delete_all_sessions() { |
|
121 | - global $wpdb; |
|
122 | - |
|
123 | - $count = $wpdb->query( "DELETE FROM $wpdb->options WHERE option_name LIKE '_wp_session_%'" ); |
|
124 | - |
|
125 | - return (int) ( $count / 2 ); |
|
126 | - } |
|
127 | - |
|
128 | - /** |
|
129 | - * Generate a new, random session ID. |
|
130 | - * |
|
131 | - * @return string |
|
132 | - */ |
|
133 | - public static function generate_id() { |
|
134 | - require_once( ABSPATH . 'wp-includes/class-phpass.php' ); |
|
135 | - $hash = new PasswordHash( 8, false ); |
|
136 | - |
|
137 | - return md5( $hash->get_random_bytes( 32 ) ); |
|
138 | - } |
|
9 | + /** |
|
10 | + * Count the total sessions in the database. |
|
11 | + * |
|
12 | + * @global wpdb $wpdb |
|
13 | + * |
|
14 | + * @return int |
|
15 | + */ |
|
16 | + public static function count_sessions() { |
|
17 | + global $wpdb; |
|
18 | + |
|
19 | + $query = "SELECT COUNT(*) FROM $wpdb->options WHERE option_name LIKE '_wp_session_expires_%'"; |
|
20 | + |
|
21 | + /** |
|
22 | + * Filter the query in case tables are non-standard. |
|
23 | + * |
|
24 | + * @param string $query Database count query |
|
25 | + */ |
|
26 | + $query = apply_filters( 'wp_session_count_query', $query ); |
|
27 | + |
|
28 | + $sessions = $wpdb->get_var( $query ); |
|
29 | + |
|
30 | + return absint( $sessions ); |
|
31 | + } |
|
32 | + |
|
33 | + /** |
|
34 | + * Create a new, random session in the database. |
|
35 | + * |
|
36 | + * @param null|string $date |
|
37 | + */ |
|
38 | + public static function create_dummy_session( $date = null ) { |
|
39 | + // Generate our date |
|
40 | + if ( null !== $date ) { |
|
41 | + $time = strtotime( $date ); |
|
42 | + |
|
43 | + if ( false === $time ) { |
|
44 | + $date = null; |
|
45 | + } else { |
|
46 | + $expires = date( 'U', strtotime( $date ) ); |
|
47 | + } |
|
48 | + } |
|
49 | + |
|
50 | + // If null was passed, or if the string parsing failed, fall back on a default |
|
51 | + if ( null === $date ) { |
|
52 | + /** |
|
53 | + * Filter the expiration of the session in the database |
|
54 | + * |
|
55 | + * @param int |
|
56 | + */ |
|
57 | + $expires = time() + (int) apply_filters( 'wp_session_expiration', 30 * 60 ); |
|
58 | + } |
|
59 | + |
|
60 | + $session_id = self::generate_id(); |
|
61 | + |
|
62 | + // Store the session |
|
63 | + add_option( "_wp_session_{$session_id}", array(), '', 'no' ); |
|
64 | + add_option( "_wp_session_expires_{$session_id}", $expires, '', 'no' ); |
|
65 | + } |
|
66 | + |
|
67 | + /** |
|
68 | + * Delete old sessions from the database. |
|
69 | + * |
|
70 | + * @param int $limit Maximum number of sessions to delete. |
|
71 | + * |
|
72 | + * @global wpdb $wpdb |
|
73 | + * |
|
74 | + * @return int Sessions deleted. |
|
75 | + */ |
|
76 | + public static function delete_old_sessions( $limit = 1000 ) { |
|
77 | + global $wpdb; |
|
78 | + |
|
79 | + $limit = absint( $limit ); |
|
80 | + $keys = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE option_name LIKE '_wp_session_expires_%' ORDER BY option_value ASC LIMIT 0, {$limit}" ); |
|
81 | + |
|
82 | + $now = time(); |
|
83 | + $expired = array(); |
|
84 | + $count = 0; |
|
85 | + |
|
86 | + foreach( $keys as $expiration ) { |
|
87 | + $key = $expiration->option_name; |
|
88 | + $expires = $expiration->option_value; |
|
89 | + |
|
90 | + if ( $now > $expires ) { |
|
91 | + $session_id = preg_replace("/[^A-Za-z0-9_]/", '', substr( $key, 20 ) ); |
|
92 | + |
|
93 | + $expired[] = $key; |
|
94 | + $expired[] = "_wp_session_{$session_id}"; |
|
95 | + |
|
96 | + $count += 1; |
|
97 | + } |
|
98 | + } |
|
99 | + |
|
100 | + // Delete expired sessions |
|
101 | + if ( ! empty( $expired ) ) { |
|
102 | + $placeholders = array_fill( 0, count( $expired ), '%s' ); |
|
103 | + $format = implode( ', ', $placeholders ); |
|
104 | + $query = "DELETE FROM $wpdb->options WHERE option_name IN ($format)"; |
|
105 | + |
|
106 | + $prepared = $wpdb->prepare( $query, $expired ); |
|
107 | + $wpdb->query( $prepared ); |
|
108 | + } |
|
109 | + |
|
110 | + return $count; |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Remove all sessions from the database, regardless of expiration. |
|
115 | + * |
|
116 | + * @global wpdb $wpdb |
|
117 | + * |
|
118 | + * @return int Sessions deleted |
|
119 | + */ |
|
120 | + public static function delete_all_sessions() { |
|
121 | + global $wpdb; |
|
122 | + |
|
123 | + $count = $wpdb->query( "DELETE FROM $wpdb->options WHERE option_name LIKE '_wp_session_%'" ); |
|
124 | + |
|
125 | + return (int) ( $count / 2 ); |
|
126 | + } |
|
127 | + |
|
128 | + /** |
|
129 | + * Generate a new, random session ID. |
|
130 | + * |
|
131 | + * @return string |
|
132 | + */ |
|
133 | + public static function generate_id() { |
|
134 | + require_once( ABSPATH . 'wp-includes/class-phpass.php' ); |
|
135 | + $hash = new PasswordHash( 8, false ); |
|
136 | + |
|
137 | + return md5( $hash->get_random_bytes( 32 ) ); |
|
138 | + } |
|
139 | 139 | } |
140 | 140 | \ No newline at end of file |
@@ -8,291 +8,291 @@ |
||
8 | 8 | * @since 1.0.0 |
9 | 9 | */ |
10 | 10 | class WPInv_Session { |
11 | - /** |
|
12 | - * Holds our session data. |
|
13 | - * |
|
14 | - * @var array |
|
15 | - * @access private |
|
16 | - * @since 1.0.0 |
|
17 | - */ |
|
18 | - private $session; |
|
19 | - |
|
20 | - /** |
|
21 | - * Whether to use PHP $_SESSION or WP_Session. |
|
22 | - * |
|
23 | - * @var bool |
|
24 | - * @access private |
|
25 | - * @since 1.0.0 |
|
26 | - */ |
|
27 | - private $use_php_sessions = false; |
|
28 | - |
|
29 | - /** |
|
30 | - * Session index prefix. |
|
31 | - * |
|
32 | - * @var string |
|
33 | - * @access private |
|
34 | - * @since 1.0.0 |
|
35 | - */ |
|
36 | - private $prefix = ''; |
|
37 | - |
|
38 | - /** |
|
39 | - * Get things started. |
|
40 | - * |
|
41 | - * Defines our WP_Session constants, includes the necessary libraries and |
|
42 | - * retrieves the WP Session instance. |
|
43 | - * |
|
44 | - * @since 1.0.0 |
|
45 | - */ |
|
46 | - public function __construct() { |
|
47 | - $this->use_php_sessions = $this->use_php_sessions(); |
|
48 | - |
|
49 | - if ( $this->use_php_sessions ) { |
|
50 | - if ( is_multisite() ) { |
|
51 | - $this->prefix = '_' . get_current_blog_id(); |
|
52 | - } |
|
53 | - |
|
54 | - // Use PHP SESSION (must be enabled via the WPINV_USE_PHP_SESSIONS constant) |
|
55 | - add_action( 'init', array( $this, 'maybe_start_session' ), -2 ); |
|
56 | - } else { |
|
57 | - // Use WP_Session (default) |
|
58 | - if ( !defined( 'WP_SESSION_COOKIE' ) ) { |
|
59 | - define( 'WP_SESSION_COOKIE', 'wpinv_wp_session' ); |
|
60 | - } |
|
61 | - |
|
62 | - if ( !class_exists( 'Recursive_ArrayAccess' ) ) { |
|
63 | - require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/class-recursive-arrayaccess.php'; |
|
64 | - } |
|
11 | + /** |
|
12 | + * Holds our session data. |
|
13 | + * |
|
14 | + * @var array |
|
15 | + * @access private |
|
16 | + * @since 1.0.0 |
|
17 | + */ |
|
18 | + private $session; |
|
19 | + |
|
20 | + /** |
|
21 | + * Whether to use PHP $_SESSION or WP_Session. |
|
22 | + * |
|
23 | + * @var bool |
|
24 | + * @access private |
|
25 | + * @since 1.0.0 |
|
26 | + */ |
|
27 | + private $use_php_sessions = false; |
|
28 | + |
|
29 | + /** |
|
30 | + * Session index prefix. |
|
31 | + * |
|
32 | + * @var string |
|
33 | + * @access private |
|
34 | + * @since 1.0.0 |
|
35 | + */ |
|
36 | + private $prefix = ''; |
|
37 | + |
|
38 | + /** |
|
39 | + * Get things started. |
|
40 | + * |
|
41 | + * Defines our WP_Session constants, includes the necessary libraries and |
|
42 | + * retrieves the WP Session instance. |
|
43 | + * |
|
44 | + * @since 1.0.0 |
|
45 | + */ |
|
46 | + public function __construct() { |
|
47 | + $this->use_php_sessions = $this->use_php_sessions(); |
|
48 | + |
|
49 | + if ( $this->use_php_sessions ) { |
|
50 | + if ( is_multisite() ) { |
|
51 | + $this->prefix = '_' . get_current_blog_id(); |
|
52 | + } |
|
53 | + |
|
54 | + // Use PHP SESSION (must be enabled via the WPINV_USE_PHP_SESSIONS constant) |
|
55 | + add_action( 'init', array( $this, 'maybe_start_session' ), -2 ); |
|
56 | + } else { |
|
57 | + // Use WP_Session (default) |
|
58 | + if ( !defined( 'WP_SESSION_COOKIE' ) ) { |
|
59 | + define( 'WP_SESSION_COOKIE', 'wpinv_wp_session' ); |
|
60 | + } |
|
61 | + |
|
62 | + if ( !class_exists( 'Recursive_ArrayAccess' ) ) { |
|
63 | + require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/class-recursive-arrayaccess.php'; |
|
64 | + } |
|
65 | 65 | |
66 | - if ( !class_exists( 'WP_Session_Utils' ) ) { |
|
67 | - require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/class-wp-session-utils.php'; |
|
68 | - } |
|
66 | + if ( !class_exists( 'WP_Session_Utils' ) ) { |
|
67 | + require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/class-wp-session-utils.php'; |
|
68 | + } |
|
69 | 69 | |
70 | - if ( defined( 'WP_CLI' ) && WP_CLI && !class_exists( 'WP_Session_Command' ) ) { |
|
71 | - require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/wp-cli.php'; |
|
72 | - } |
|
73 | - |
|
74 | - if ( !class_exists( 'WP_Session' ) ) { |
|
75 | - require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/class-wp-session.php'; |
|
76 | - require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/wp-session.php'; |
|
77 | - } |
|
78 | - |
|
79 | - add_filter( 'wp_session_expiration_variant', array( $this, 'set_expiration_variant_time' ), 99999 ); |
|
80 | - add_filter( 'wp_session_expiration', array( $this, 'set_expiration_time' ), 99999 ); |
|
81 | - } |
|
82 | - |
|
83 | - if ( empty( $this->session ) && ! $this->use_php_sessions ) { |
|
84 | - add_action( 'plugins_loaded', array( $this, 'init' ), -1 ); |
|
85 | - } else { |
|
86 | - add_action( 'init', array( $this, 'init' ), -1 ); |
|
87 | - } |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Setup the WP_Session instance. |
|
92 | - * |
|
93 | - * @access public |
|
94 | - * @since 1.0.0 |
|
95 | - * @return void |
|
96 | - */ |
|
97 | - public function init() { |
|
98 | - if ( $this->use_php_sessions ) { |
|
99 | - $this->session = isset( $_SESSION['wpi' . $this->prefix ] ) && is_array( $_SESSION['wpi' . $this->prefix ] ) ? $_SESSION['wpi' . $this->prefix ] : array(); |
|
100 | - } else { |
|
101 | - $this->session = WP_Session::get_instance(); |
|
102 | - } |
|
103 | - |
|
104 | - return $this->session; |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * Retrieve session ID. |
|
109 | - * |
|
110 | - * @access public |
|
111 | - * @since 1.0.0 |
|
112 | - * @return string Session ID |
|
113 | - */ |
|
114 | - public function get_id() { |
|
115 | - if ( $this->use_php_sessions ) { |
|
116 | - $session_id = !empty( $_SESSION ) && function_exists( 'session_id' ) ? session_id() : NULL; |
|
117 | - } else { |
|
118 | - $session_id = !empty( $this->session ) && isset( $this->session->session_id ) ? $this->session->session_id : NULL; |
|
119 | - } |
|
120 | - return $session_id; |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Retrieve a session variable. |
|
125 | - * |
|
126 | - * @access public |
|
127 | - * @since 1.0.0 |
|
128 | - * @param string $key Session key |
|
129 | - * @return string Session variable |
|
130 | - */ |
|
131 | - public function get( $key ) { |
|
132 | - $key = sanitize_key( $key ); |
|
133 | - return isset( $this->session[ $key ] ) ? maybe_unserialize( $this->session[ $key ] ) : false; |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Set a session variable |
|
138 | - * |
|
139 | - * @since 1.0.0 |
|
140 | - * |
|
141 | - * @param string $key Session key |
|
142 | - * @param integer $value Session variable |
|
143 | - * @return string Session variable |
|
144 | - */ |
|
145 | - public function set( $key, $value ) { |
|
146 | - $key = sanitize_key( $key ); |
|
147 | - |
|
148 | - if ( is_array( $value ) ) { |
|
149 | - $this->session[ $key ] = maybe_serialize( $value ); |
|
150 | - } else { |
|
151 | - $this->session[ $key ] = $value; |
|
152 | - } |
|
153 | - |
|
154 | - if ( $this->use_php_sessions ) { |
|
155 | - $_SESSION['wpi' . $this->prefix ] = $this->session; |
|
156 | - } |
|
157 | - |
|
158 | - return $this->session[ $key ]; |
|
159 | - } |
|
70 | + if ( defined( 'WP_CLI' ) && WP_CLI && !class_exists( 'WP_Session_Command' ) ) { |
|
71 | + require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/wp-cli.php'; |
|
72 | + } |
|
73 | + |
|
74 | + if ( !class_exists( 'WP_Session' ) ) { |
|
75 | + require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/class-wp-session.php'; |
|
76 | + require_once WPINV_PLUGIN_DIR . 'includes/libraries/wp-session/wp-session.php'; |
|
77 | + } |
|
78 | + |
|
79 | + add_filter( 'wp_session_expiration_variant', array( $this, 'set_expiration_variant_time' ), 99999 ); |
|
80 | + add_filter( 'wp_session_expiration', array( $this, 'set_expiration_time' ), 99999 ); |
|
81 | + } |
|
82 | + |
|
83 | + if ( empty( $this->session ) && ! $this->use_php_sessions ) { |
|
84 | + add_action( 'plugins_loaded', array( $this, 'init' ), -1 ); |
|
85 | + } else { |
|
86 | + add_action( 'init', array( $this, 'init' ), -1 ); |
|
87 | + } |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Setup the WP_Session instance. |
|
92 | + * |
|
93 | + * @access public |
|
94 | + * @since 1.0.0 |
|
95 | + * @return void |
|
96 | + */ |
|
97 | + public function init() { |
|
98 | + if ( $this->use_php_sessions ) { |
|
99 | + $this->session = isset( $_SESSION['wpi' . $this->prefix ] ) && is_array( $_SESSION['wpi' . $this->prefix ] ) ? $_SESSION['wpi' . $this->prefix ] : array(); |
|
100 | + } else { |
|
101 | + $this->session = WP_Session::get_instance(); |
|
102 | + } |
|
103 | + |
|
104 | + return $this->session; |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * Retrieve session ID. |
|
109 | + * |
|
110 | + * @access public |
|
111 | + * @since 1.0.0 |
|
112 | + * @return string Session ID |
|
113 | + */ |
|
114 | + public function get_id() { |
|
115 | + if ( $this->use_php_sessions ) { |
|
116 | + $session_id = !empty( $_SESSION ) && function_exists( 'session_id' ) ? session_id() : NULL; |
|
117 | + } else { |
|
118 | + $session_id = !empty( $this->session ) && isset( $this->session->session_id ) ? $this->session->session_id : NULL; |
|
119 | + } |
|
120 | + return $session_id; |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Retrieve a session variable. |
|
125 | + * |
|
126 | + * @access public |
|
127 | + * @since 1.0.0 |
|
128 | + * @param string $key Session key |
|
129 | + * @return string Session variable |
|
130 | + */ |
|
131 | + public function get( $key ) { |
|
132 | + $key = sanitize_key( $key ); |
|
133 | + return isset( $this->session[ $key ] ) ? maybe_unserialize( $this->session[ $key ] ) : false; |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Set a session variable |
|
138 | + * |
|
139 | + * @since 1.0.0 |
|
140 | + * |
|
141 | + * @param string $key Session key |
|
142 | + * @param integer $value Session variable |
|
143 | + * @return string Session variable |
|
144 | + */ |
|
145 | + public function set( $key, $value ) { |
|
146 | + $key = sanitize_key( $key ); |
|
147 | + |
|
148 | + if ( is_array( $value ) ) { |
|
149 | + $this->session[ $key ] = maybe_serialize( $value ); |
|
150 | + } else { |
|
151 | + $this->session[ $key ] = $value; |
|
152 | + } |
|
153 | + |
|
154 | + if ( $this->use_php_sessions ) { |
|
155 | + $_SESSION['wpi' . $this->prefix ] = $this->session; |
|
156 | + } |
|
157 | + |
|
158 | + return $this->session[ $key ]; |
|
159 | + } |
|
160 | 160 | |
161 | - /** |
|
162 | - * Unset a session variable. |
|
163 | - * |
|
164 | - * @since 1.0.0 |
|
165 | - * |
|
166 | - * @param string|array $key Session key. |
|
167 | - * @param integer $value Session variable. |
|
168 | - * @return string Session variable. |
|
169 | - */ |
|
170 | - public function un_set( $key ) { |
|
171 | - if ( empty( $key ) ) { |
|
172 | - return false; |
|
173 | - } |
|
161 | + /** |
|
162 | + * Unset a session variable. |
|
163 | + * |
|
164 | + * @since 1.0.0 |
|
165 | + * |
|
166 | + * @param string|array $key Session key. |
|
167 | + * @param integer $value Session variable. |
|
168 | + * @return string Session variable. |
|
169 | + */ |
|
170 | + public function un_set( $key ) { |
|
171 | + if ( empty( $key ) ) { |
|
172 | + return false; |
|
173 | + } |
|
174 | 174 | |
175 | - if ( is_array( $key ) ) { |
|
176 | - foreach ($key as $index) { |
|
177 | - $index = sanitize_key( $index ); |
|
175 | + if ( is_array( $key ) ) { |
|
176 | + foreach ($key as $index) { |
|
177 | + $index = sanitize_key( $index ); |
|
178 | 178 | |
179 | - if ( $index && isset( $this->session[ $index ] ) ) { |
|
180 | - unset( $this->session[ $index ] ); |
|
181 | - } |
|
182 | - } |
|
183 | - } else { |
|
184 | - $key = sanitize_key( $key ); |
|
179 | + if ( $index && isset( $this->session[ $index ] ) ) { |
|
180 | + unset( $this->session[ $index ] ); |
|
181 | + } |
|
182 | + } |
|
183 | + } else { |
|
184 | + $key = sanitize_key( $key ); |
|
185 | 185 | |
186 | - if ( isset( $this->session[ $key ] ) ) { |
|
187 | - unset( $this->session[ $key ] ); |
|
188 | - } |
|
189 | - } |
|
186 | + if ( isset( $this->session[ $key ] ) ) { |
|
187 | + unset( $this->session[ $key ] ); |
|
188 | + } |
|
189 | + } |
|
190 | 190 | |
191 | - if ( $this->use_php_sessions ) { |
|
192 | - $_SESSION['wpi' . $this->prefix ] = $this->session; |
|
193 | - } |
|
191 | + if ( $this->use_php_sessions ) { |
|
192 | + $_SESSION['wpi' . $this->prefix ] = $this->session; |
|
193 | + } |
|
194 | 194 | |
195 | - return true; |
|
196 | - } |
|
195 | + return true; |
|
196 | + } |
|
197 | 197 | |
198 | - /** |
|
199 | - * Check a session variable is set or not. |
|
200 | - * |
|
201 | - * @since 1.0.0 |
|
202 | - * |
|
203 | - * @param string $key Session key. |
|
204 | - * @param integer $value Session variable. |
|
205 | - * @return string Session variable. |
|
206 | - */ |
|
207 | - public function is_set( $key ) { |
|
208 | - $key = sanitize_key( $key ); |
|
198 | + /** |
|
199 | + * Check a session variable is set or not. |
|
200 | + * |
|
201 | + * @since 1.0.0 |
|
202 | + * |
|
203 | + * @param string $key Session key. |
|
204 | + * @param integer $value Session variable. |
|
205 | + * @return string Session variable. |
|
206 | + */ |
|
207 | + public function is_set( $key ) { |
|
208 | + $key = sanitize_key( $key ); |
|
209 | 209 | |
210 | - if ( empty( $key ) ) { |
|
211 | - return false; |
|
212 | - } |
|
213 | - |
|
214 | - if ( isset( $this->session[ $key ] ) ) { |
|
215 | - return true; |
|
216 | - } |
|
217 | - |
|
218 | - return false; |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * Force the cookie expiration variant time to 23 hours |
|
223 | - * |
|
224 | - * @access public |
|
225 | - * @since 1.0.0 |
|
226 | - * @param int $exp Default expiration (1 hour) |
|
227 | - * @return int |
|
228 | - */ |
|
229 | - public function set_expiration_variant_time( $exp ) { |
|
230 | - return ( 30 * 60 * 23 ); |
|
231 | - } |
|
232 | - |
|
233 | - /** |
|
234 | - * Force the cookie expiration time to 24 hours |
|
235 | - * |
|
236 | - * @access public |
|
237 | - * @since 1.0.0 |
|
238 | - * @param int $exp Default expiration (1 hour) |
|
239 | - * @return int |
|
240 | - */ |
|
241 | - public function set_expiration_time( $exp ) { |
|
242 | - return ( 30 * 60 * 24 ); |
|
243 | - } |
|
244 | - |
|
245 | - /** |
|
246 | - * Starts a new session if one hasn't started yet. |
|
247 | - * |
|
248 | - * @return boolean |
|
249 | - * Checks to see if the server supports PHP sessions |
|
250 | - * or if the WPINV_USE_PHP_SESSIONS constant is defined |
|
251 | - * |
|
252 | - * @access public |
|
253 | - * @since 1.0.0 |
|
254 | - * @return boolean $ret True if we are using PHP sessions, false otherwise |
|
255 | - */ |
|
256 | - public function use_php_sessions() { |
|
257 | - $ret = false; |
|
258 | - |
|
259 | - // If the database variable is already set, no need to run autodetection |
|
260 | - $wpinv_use_php_sessions = (bool)get_option( 'wpinv_use_php_sessions' ); |
|
261 | - |
|
262 | - if (!$wpinv_use_php_sessions ) { |
|
263 | - // Attempt to detect if the server supports PHP sessions |
|
264 | - if ( function_exists( 'session_start' ) && ! ini_get( 'safe_mode' ) ) { |
|
265 | - $this->set( 'wpinv_use_php_sessions', 1 ); |
|
210 | + if ( empty( $key ) ) { |
|
211 | + return false; |
|
212 | + } |
|
213 | + |
|
214 | + if ( isset( $this->session[ $key ] ) ) { |
|
215 | + return true; |
|
216 | + } |
|
217 | + |
|
218 | + return false; |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * Force the cookie expiration variant time to 23 hours |
|
223 | + * |
|
224 | + * @access public |
|
225 | + * @since 1.0.0 |
|
226 | + * @param int $exp Default expiration (1 hour) |
|
227 | + * @return int |
|
228 | + */ |
|
229 | + public function set_expiration_variant_time( $exp ) { |
|
230 | + return ( 30 * 60 * 23 ); |
|
231 | + } |
|
232 | + |
|
233 | + /** |
|
234 | + * Force the cookie expiration time to 24 hours |
|
235 | + * |
|
236 | + * @access public |
|
237 | + * @since 1.0.0 |
|
238 | + * @param int $exp Default expiration (1 hour) |
|
239 | + * @return int |
|
240 | + */ |
|
241 | + public function set_expiration_time( $exp ) { |
|
242 | + return ( 30 * 60 * 24 ); |
|
243 | + } |
|
244 | + |
|
245 | + /** |
|
246 | + * Starts a new session if one hasn't started yet. |
|
247 | + * |
|
248 | + * @return boolean |
|
249 | + * Checks to see if the server supports PHP sessions |
|
250 | + * or if the WPINV_USE_PHP_SESSIONS constant is defined |
|
251 | + * |
|
252 | + * @access public |
|
253 | + * @since 1.0.0 |
|
254 | + * @return boolean $ret True if we are using PHP sessions, false otherwise |
|
255 | + */ |
|
256 | + public function use_php_sessions() { |
|
257 | + $ret = false; |
|
258 | + |
|
259 | + // If the database variable is already set, no need to run autodetection |
|
260 | + $wpinv_use_php_sessions = (bool)get_option( 'wpinv_use_php_sessions' ); |
|
261 | + |
|
262 | + if (!$wpinv_use_php_sessions ) { |
|
263 | + // Attempt to detect if the server supports PHP sessions |
|
264 | + if ( function_exists( 'session_start' ) && ! ini_get( 'safe_mode' ) ) { |
|
265 | + $this->set( 'wpinv_use_php_sessions', 1 ); |
|
266 | 266 | |
267 | - if ( $this->get( 'wpinv_use_php_sessions' ) ) { |
|
268 | - $ret = true; |
|
269 | - |
|
270 | - // Set the database option |
|
271 | - update_option( 'wpinv_use_php_sessions', true ); |
|
272 | - } |
|
273 | - } |
|
274 | - } else { |
|
275 | - $ret = $wpinv_use_php_sessions; |
|
276 | - } |
|
277 | - |
|
278 | - // Enable or disable PHP Sessions based on the WPINV_USE_PHP_SESSIONS constant |
|
279 | - if ( defined( 'WPINV_USE_PHP_SESSIONS' ) && WPINV_USE_PHP_SESSIONS ) { |
|
280 | - $ret = true; |
|
281 | - } else if ( defined( 'WPINV_USE_PHP_SESSIONS' ) && ! WPINV_USE_PHP_SESSIONS ) { |
|
282 | - $ret = false; |
|
283 | - } |
|
284 | - |
|
285 | - return (bool) apply_filters( 'wpinv_use_php_sessions', $ret ); |
|
286 | - } |
|
287 | - |
|
288 | - /** |
|
289 | - * Starts a new session if one hasn't started yet. |
|
290 | - */ |
|
291 | - public function maybe_start_session() { |
|
292 | - if ( !session_id() && !headers_sent() ) { |
|
293 | - session_start(); |
|
294 | - } |
|
295 | - } |
|
267 | + if ( $this->get( 'wpinv_use_php_sessions' ) ) { |
|
268 | + $ret = true; |
|
269 | + |
|
270 | + // Set the database option |
|
271 | + update_option( 'wpinv_use_php_sessions', true ); |
|
272 | + } |
|
273 | + } |
|
274 | + } else { |
|
275 | + $ret = $wpinv_use_php_sessions; |
|
276 | + } |
|
277 | + |
|
278 | + // Enable or disable PHP Sessions based on the WPINV_USE_PHP_SESSIONS constant |
|
279 | + if ( defined( 'WPINV_USE_PHP_SESSIONS' ) && WPINV_USE_PHP_SESSIONS ) { |
|
280 | + $ret = true; |
|
281 | + } else if ( defined( 'WPINV_USE_PHP_SESSIONS' ) && ! WPINV_USE_PHP_SESSIONS ) { |
|
282 | + $ret = false; |
|
283 | + } |
|
284 | + |
|
285 | + return (bool) apply_filters( 'wpinv_use_php_sessions', $ret ); |
|
286 | + } |
|
287 | + |
|
288 | + /** |
|
289 | + * Starts a new session if one hasn't started yet. |
|
290 | + */ |
|
291 | + public function maybe_start_session() { |
|
292 | + if ( !session_id() && !headers_sent() ) { |
|
293 | + session_start(); |
|
294 | + } |
|
295 | + } |
|
296 | 296 | } |
297 | 297 | |
298 | 298 | global $wpi_session; |
@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | const EXCEPTION_CURL = 10; |
41 | 41 | |
42 | 42 | private $ch; |
43 | - private $login; |
|
43 | + private $login; |
|
44 | 44 | private $response; |
45 | 45 | private $response_xml; |
46 | 46 | private $results; |
@@ -48,9 +48,9 @@ discard block |
||
48 | 48 | private $url; |
49 | 49 | private $xml; |
50 | 50 | |
51 | - public function __construct($login, $transkey, $test = self::USE_PRODUCTION_SERVER) |
|
52 | - { |
|
53 | - $login = trim($login); |
|
51 | + public function __construct($login, $transkey, $test = self::USE_PRODUCTION_SERVER) |
|
52 | + { |
|
53 | + $login = trim($login); |
|
54 | 54 | $transkey = trim($transkey); |
55 | 55 | if (empty($login) || empty($transkey)) |
56 | 56 | { |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | |
64 | 64 | $subdomain = ($test) ? 'apitest' : 'api'; |
65 | 65 | $this->url = 'https://' . $subdomain . '.authorize.net/xml/v1/request.api'; |
66 | - } |
|
66 | + } |
|
67 | 67 | |
68 | 68 | /** |
69 | 69 | * remove XML response namespaces |
@@ -78,9 +78,9 @@ discard block |
||
78 | 78 | return str_replace(' xmlns:xsd="http://www.w3.org/2001/XMLSchema"','',$input); |
79 | 79 | } |
80 | 80 | |
81 | - public function __toString() |
|
82 | - { |
|
83 | - $output = ''; |
|
81 | + public function __toString() |
|
82 | + { |
|
83 | + $output = ''; |
|
84 | 84 | $output .= '<table summary="Authorize.Net Results" id="authnet">' . "\n"; |
85 | 85 | $output .= '<tr>' . "\n\t\t" . '<th colspan="2"><b>Class Parameters</b></th>' . "\n" . '</tr>' . "\n"; |
86 | 86 | $output .= '<tr>' . "\n\t\t" . '<td><b>API Login ID</b></td><td>' . $this->login . '</td>' . "\n" . '</tr>' . "\n"; |
@@ -117,9 +117,9 @@ discard block |
||
117 | 117 | $output .= '</table>'; |
118 | 118 | |
119 | 119 | return $output; |
120 | - } |
|
120 | + } |
|
121 | 121 | |
122 | - public function __destruct() |
|
122 | + public function __destruct() |
|
123 | 123 | { |
124 | 124 | if (isset($this->ch)) |
125 | 125 | { |
@@ -128,31 +128,31 @@ discard block |
||
128 | 128 | } |
129 | 129 | |
130 | 130 | public function __get($var) |
131 | - { |
|
132 | - return $this->response_xml->$var; |
|
133 | - } |
|
134 | - |
|
135 | - public function __set($key, $value) |
|
136 | - { |
|
137 | - trigger_error('You cannot set parameters directly in ' . __CLASS__ . '.', E_USER_WARNING); |
|
138 | - return false; |
|
139 | - } |
|
140 | - |
|
141 | - public function __call($api_call, $args) |
|
142 | - { |
|
143 | - $this->xml = new SimpleXMLElement('<' . $api_call . '></' . $api_call . '>'); |
|
131 | + { |
|
132 | + return $this->response_xml->$var; |
|
133 | + } |
|
134 | + |
|
135 | + public function __set($key, $value) |
|
136 | + { |
|
137 | + trigger_error('You cannot set parameters directly in ' . __CLASS__ . '.', E_USER_WARNING); |
|
138 | + return false; |
|
139 | + } |
|
140 | + |
|
141 | + public function __call($api_call, $args) |
|
142 | + { |
|
143 | + $this->xml = new SimpleXMLElement('<' . $api_call . '></' . $api_call . '>'); |
|
144 | 144 | $this->xml->addAttribute('xmlns', 'AnetApi/xml/v1/schema/AnetApiSchema.xsd'); |
145 | - $merch_auth = $this->xml->addChild('merchantAuthentication'); |
|
145 | + $merch_auth = $this->xml->addChild('merchantAuthentication'); |
|
146 | 146 | $merch_auth->addChild('name', $this->login); |
147 | - $merch_auth->addChild('transactionKey', $this->transkey); |
|
147 | + $merch_auth->addChild('transactionKey', $this->transkey); |
|
148 | 148 | |
149 | - $this->setParameters($this->xml, $args[0]); |
|
150 | - $this->process(); |
|
151 | - } |
|
149 | + $this->setParameters($this->xml, $args[0]); |
|
150 | + $this->process(); |
|
151 | + } |
|
152 | 152 | |
153 | - private function setParameters($xml, $array) |
|
154 | - { |
|
155 | - if (is_array($array)) |
|
153 | + private function setParameters($xml, $array) |
|
154 | + { |
|
155 | + if (is_array($array)) |
|
156 | 156 | { |
157 | 157 | $first = true; |
158 | 158 | foreach ($array as $key => $value) |
@@ -184,34 +184,34 @@ discard block |
||
184 | 184 | } |
185 | 185 | } |
186 | 186 | } |
187 | - } |
|
187 | + } |
|
188 | 188 | |
189 | - private function process() |
|
190 | - { |
|
191 | - $this->xml = $this->xml->asXML(); |
|
189 | + private function process() |
|
190 | + { |
|
191 | + $this->xml = $this->xml->asXML(); |
|
192 | 192 | |
193 | - $this->ch = curl_init(); |
|
193 | + $this->ch = curl_init(); |
|
194 | 194 | curl_setopt($this->ch, CURLOPT_URL, $this->url); |
195 | - curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, 1); |
|
196 | - curl_setopt($this->ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); |
|
197 | - curl_setopt($this->ch, CURLOPT_HEADER, 0); |
|
198 | - curl_setopt($this->ch, CURLOPT_POSTFIELDS, $this->xml); |
|
199 | - curl_setopt($this->ch, CURLOPT_POST, 1); |
|
200 | - curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 2); |
|
201 | - curl_setopt($this->ch, CURLOPT_CAINFO, dirname(__FILE__) . '/ssl/cert.pem'); |
|
195 | + curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, 1); |
|
196 | + curl_setopt($this->ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); |
|
197 | + curl_setopt($this->ch, CURLOPT_HEADER, 0); |
|
198 | + curl_setopt($this->ch, CURLOPT_POSTFIELDS, $this->xml); |
|
199 | + curl_setopt($this->ch, CURLOPT_POST, 1); |
|
200 | + curl_setopt($this->ch, CURLOPT_SSL_VERIFYHOST, 2); |
|
201 | + curl_setopt($this->ch, CURLOPT_CAINFO, dirname(__FILE__) . '/ssl/cert.pem'); |
|
202 | 202 | |
203 | 203 | if(($this->response = curl_exec($this->ch)) !== false) |
204 | 204 | { |
205 | 205 | $this->response_xml = @new SimpleXMLElement($this->response); |
206 | 206 | |
207 | - curl_close($this->ch); |
|
207 | + curl_close($this->ch); |
|
208 | 208 | unset($this->ch); |
209 | 209 | return; |
210 | - } |
|
210 | + } |
|
211 | 211 | throw new AuthnetXMLException('Connection error: ' . curl_error($this->ch) . ' (' . curl_errno($this->ch) . ')', self::EXCEPTION_CURL); |
212 | - } |
|
212 | + } |
|
213 | 213 | |
214 | - public function isSuccessful() |
|
214 | + public function isSuccessful() |
|
215 | 215 | { |
216 | 216 | return $this->response_xml->messages->resultCode == 'Ok'; |
217 | 217 | } |