AyeCode / invoicing

includes/libraries/class-emogrifier.php

Indentation +779 added lines, -779 removed lines

@@ -9,346 +9,346 @@ 
  * @author Roman Ožana <ozana@omdesign.cz>
  */
 class Emogrifier {
-	/**
-	 * @var string
-	 */
-	const ENCODING = 'UTF-8';
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_CSS = 0;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_SELECTOR = 1;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_XPATH = 2;
-
-	/**
-	 * @var integer
-	 */
-	const CACHE_KEY_CSS_DECLARATION_BLOCK = 3;
-
-	/**
-	 * for calculating nth-of-type and nth-child selectors.
-	 *
-	 * @var integer
-	 */
-	const INDEX = 0;
-
-	/**
-	 * for calculating nth-of-type and nth-child selectors.
-	 *
-	 * @var integer
-	 */
-	const MULTIPLIER = 1;
-
-	/**
-	 * @var string
-	 */
-	const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/';
-
-	/**
-	 * @var string
-	 */
-	const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
-
-	/**
-	 * @var string
-	 */
-	private $html = '';
-
-	/**
-	 * @var string
-	 */
-	private $css = '';
-
-	/**
-	 * @var array<string>
-	 */
-	private $unprocessableHtmlTags = array('wbr');
-
-	/**
-	 * @var array<array>
-	 */
-	private $caches = array(
-		self::CACHE_KEY_CSS => array(),
-		self::CACHE_KEY_SELECTOR => array(),
-		self::CACHE_KEY_XPATH => array(),
-		self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(),
-	);
-
-	/**
-	 * the visited nodes with the XPath paths as array keys.
-	 *
-	 * @var array<\DOMNode>
-	 */
-	private $visitedNodes = array();
-
-	/**
-	 * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values.
-	 * as key/value pairs for the inner array.
-	 *
-	 * @var array<array><string>
-	 */
-	private $styleAttributesForNodes = array();
-
-	/**
-	 * This attribute applies to the case where you want to preserve your original text encoding.
-	 *
-	 * By default, emogrifier translates your text into HTML entities for two reasons:
-	 *
-	 * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email.
-	 *
-	 * 2. It translates any illegal XML characters that DOMDocument cannot work with.
-	 *
-	 * If you would like to preserve your original encoding, set this attribute to TRUE.
-	 *
-	 * @var boolean
-	 */
-	public $preserveEncoding = false;
-
-	public static $_media = '';
-
-	/**
-	 * The constructor.
-	 *
-	 * @param string $html the HTML to emogrify, must be UTF-8-encoded
-	 * @param string $css the CSS to merge, must be UTF-8-encoded
-	 */
-	public function __construct($html = '', $css = '') {
-		$this->setHtml($html);
-		$this->setCss($css);
-	}
-
-	/**
-	 * The destructor.
-	 */
-	public function __destruct() {
-		$this->purgeVisitedNodes();
-	}
-
-	/**
-	 * Sets the HTML to emogrify.
-	 *
-	 * @param string $html the HTML to emogrify, must be UTF-8-encoded
-	 */
-	public function setHtml($html = '') {
-		$this->html = $html;
-	}
-
-	/**
-	 * Sets the CSS to merge with the HTML.
-	 *
-	 * @param string $css the CSS to merge, must be UTF-8-encoded
-	 */
-	public function setCss($css = '') {
-		$this->css = $css;
-	}
-
-	/**
-	 * Clears all caches.
-	 */
-	private function clearAllCaches() {
-		$this->clearCache(self::CACHE_KEY_CSS);
-		$this->clearCache(self::CACHE_KEY_SELECTOR);
-		$this->clearCache(self::CACHE_KEY_XPATH);
-		$this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK);
-	}
-
-	/**
-	 * Clears a single cache by key.
-	 *
-	 * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	private function clearCache($key) {
-		$allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK);
-		if (!in_array($key, $allowedCacheKeys, true)) {
-			throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
-		}
-
-		$this->caches[$key] = array();
-	}
-
-	/**
-	 * Purges the visited nodes.
-	 */
-	private function purgeVisitedNodes() {
-		$this->visitedNodes = array();
-		$this->styleAttributesForNodes = array();
-	}
-
-	/**
-	 * Marks a tag for removal.
-	 *
-	 * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them.
-	 * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document.
-	 *
-	 * Note: The tags will not be removed if they have any content.
-	 *
-	 * @param string $tagName the tag name, e.g., "p"
-	 */
-	public function addUnprocessableHtmlTag($tagName) {
-		$this->unprocessableHtmlTags[] = $tagName;
-	}
-
-	/**
-	 * Drops a tag from the removal list.
-	 *
-	 * @param string $tagName the tag name, e.g., "p"
-	 */
-	public function removeUnprocessableHtmlTag($tagName) {
-		$key = array_search($tagName, $this->unprocessableHtmlTags, true);
-		if ($key !== false) {
-			unset($this->unprocessableHtmlTags[$key]);
-		}
-	}
-
-	/**
-	 * Applies the CSS you submit to the HTML you submit.
-	 *
-	 * This method places the CSS inline.
-	 *
-	 * @return string
-	 *
-	 * @throws BadMethodCallException
-	 */
-	public function emogrify() {
-		if ($this->html === '') {
-			throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096);
-		}
-
-		$xmlDocument = $this->createXmlDocument();
-		$xpath = new DOMXPath($xmlDocument);
-		$this->clearAllCaches();
-
-		// before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none');
-		// we wouldn't have to do this if DOMXPath supported XPath 2.0.
-		// also store a reference of nodes with existing inline styles so we don't overwrite them
-		$this->purgeVisitedNodes();
-
-		$nodesWithStyleAttributes = $xpath->query('//*[@style]');
-		if ($nodesWithStyleAttributes !== false) {
-			/** @var $nodeWithStyleAttribute DOMNode */
-			foreach ($nodesWithStyleAttributes as $node) {
-				$normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') );
-
-				// in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles
-				$nodePath = $node->getNodePath();
-				if (!isset($this->styleAttributesForNodes[$nodePath])) {
-					$this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle);
-					$this->visitedNodes[$nodePath] = $node;
-				}
-
-				$node->setAttribute('style', $normalizedOriginalStyle);
-			}
-		}
-
-		// grab any existing style blocks from the html and append them to the existing CSS
-		// (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
-		$allCss = $this->css;
-
-		$allCss .= $this->getCssFromAllStyleNodes($xpath);
-
-		$cssParts = $this->splitCssAndMediaQuery($allCss);
-		self::$_media = ''; // reset
-
-		$cssKey = md5($cssParts['css']);
-		if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
-			// process the CSS file for selectors and definitions
-			preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER);
-
-			$allSelectors = array();
-			foreach ($matches as $key => $selectorString) {
-				// if there is a blank definition, skip
-				if (!strlen(trim($selectorString[2]))) {
-					continue;
-				}
-
-				// else split by commas and duplicate attributes so we can sort by selector precedence
-				$selectors = explode(',', $selectorString[1]);
-				foreach ($selectors as $selector) {
-					// don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes
-					if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) {
-						continue;
-					}
-
-					$allSelectors[] = array('selector' => trim($selector),
-											 'attributes' => trim($selectorString[2]),
-											 // keep track of where it appears in the file, since order is important
-											 'line' => $key,
-					);
-				}
-			}
-
-			// now sort the selectors by precedence
-			usort($allSelectors, array($this,'sortBySelectorPrecedence'));
-
-			$this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors;
-		}
-
-		foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) {
-			// query the body for the xpath selector
-			$nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector']));
-
-			/** @var $node \DOMNode */
-			foreach ($nodesMatchingCssSelectors as $node) {
-				// if it has a style attribute, get it, process it, and append (overwrite) new stuff
-				if ($node->hasAttribute('style')) {
-					// break it up into an associative array
-					$oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style'));
-				} else {
-					$oldStyleDeclarations = array();
-				}
-				$newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']);
-				$node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
-			}
-		}
-
-		// now iterate through the nodes that contained inline styles in the original HTML
-		foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
-			$node = $this->visitedNodes[$nodePath];
-			$currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style'));
-			$node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
-		}
-
-		// This removes styles from your email that contain display:none.
-		// We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0,
-		// lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need
-		// to translate() the letters that would be in 'NONE' ("NOE") to lowercase.
-		$nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]');
-		// The checks on parentNode and is_callable below ensure that if we've deleted the parent node,
-		// we don't try to call removeChild on a nonexistent child node
-		if ($nodesWithStyleDisplayNone->length > 0) {
-			/** @var $node \DOMNode */
-			foreach ($nodesWithStyleDisplayNone as $node) {
-				if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) {
-					$node->parentNode->removeChild($node);
-				}
-			}
-		}
-
-		$this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument);
-
-		if ($this->preserveEncoding) {
-			// Deprecated since PHP 8.2
-			if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
-				return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' );
-			} else {
-				return mb_encode_numericentity( $xmlDocument->saveHTML(), [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
-				//return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) );
-			}
-		} else {
-			return $xmlDocument->saveHTML();
-		}
-	}
+    /**
+     * @var string
+     */
+    const ENCODING = 'UTF-8';
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_CSS = 0;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_SELECTOR = 1;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_XPATH = 2;
+
+    /**
+     * @var integer
+     */
+    const CACHE_KEY_CSS_DECLARATION_BLOCK = 3;
+
+    /**
+     * for calculating nth-of-type and nth-child selectors.
+     *
+     * @var integer
+     */
+    const INDEX = 0;
+
+    /**
+     * for calculating nth-of-type and nth-child selectors.
+     *
+     * @var integer
+     */
+    const MULTIPLIER = 1;
+
+    /**
+     * @var string
+     */
+    const ID_ATTRIBUTE_MATCHER = '/(\\w+)?\\#([\\w\\-]+)/';
+
+    /**
+     * @var string
+     */
+    const CLASS_ATTRIBUTE_MATCHER = '/(\\w+|[\\*\\]])?((\\.[\\w\\-]+)+)/';
+
+    /**
+     * @var string
+     */
+    private $html = '';
+
+    /**
+     * @var string
+     */
+    private $css = '';
+
+    /**
+     * @var array<string>
+     */
+    private $unprocessableHtmlTags = array('wbr');
+
+    /**
+     * @var array<array>
+     */
+    private $caches = array(
+        self::CACHE_KEY_CSS => array(),
+        self::CACHE_KEY_SELECTOR => array(),
+        self::CACHE_KEY_XPATH => array(),
+        self::CACHE_KEY_CSS_DECLARATION_BLOCK => array(),
+    );
+
+    /**
+     * the visited nodes with the XPath paths as array keys.
+     *
+     * @var array<\DOMNode>
+     */
+    private $visitedNodes = array();
+
+    /**
+     * the styles to apply to the nodes with the XPath paths as array keys for the outer array and the attribute names/values.
+     * as key/value pairs for the inner array.
+     *
+     * @var array<array><string>
+     */
+    private $styleAttributesForNodes = array();
+
+    /**
+     * This attribute applies to the case where you want to preserve your original text encoding.
+     *
+     * By default, emogrifier translates your text into HTML entities for two reasons:
+     *
+     * 1. Because of client incompatibilities, it is better practice to send out HTML entities rather than unicode over email.
+     *
+     * 2. It translates any illegal XML characters that DOMDocument cannot work with.
+     *
+     * If you would like to preserve your original encoding, set this attribute to TRUE.
+     *
+     * @var boolean
+     */
+    public $preserveEncoding = false;
+
+    public static $_media = '';
+
+    /**
+     * The constructor.
+     *
+     * @param string $html the HTML to emogrify, must be UTF-8-encoded
+     * @param string $css the CSS to merge, must be UTF-8-encoded
+     */
+    public function __construct($html = '', $css = '') {
+        $this->setHtml($html);
+        $this->setCss($css);
+    }
+
+    /**
+     * The destructor.
+     */
+    public function __destruct() {
+        $this->purgeVisitedNodes();
+    }
+
+    /**
+     * Sets the HTML to emogrify.
+     *
+     * @param string $html the HTML to emogrify, must be UTF-8-encoded
+     */
+    public function setHtml($html = '') {
+        $this->html = $html;
+    }
+
+    /**
+     * Sets the CSS to merge with the HTML.
+     *
+     * @param string $css the CSS to merge, must be UTF-8-encoded
+     */
+    public function setCss($css = '') {
+        $this->css = $css;
+    }
+
+    /**
+     * Clears all caches.
+     */
+    private function clearAllCaches() {
+        $this->clearCache(self::CACHE_KEY_CSS);
+        $this->clearCache(self::CACHE_KEY_SELECTOR);
+        $this->clearCache(self::CACHE_KEY_XPATH);
+        $this->clearCache(self::CACHE_KEY_CSS_DECLARATION_BLOCK);
+    }
+
+    /**
+     * Clears a single cache by key.
+     *
+     * @param integer $key the cache key, must be CACHE_KEY_CSS, CACHE_KEY_SELECTOR, CACHE_KEY_XPATH or CACHE_KEY_CSS_DECLARATION_BLOCK
+     *
+     * @throws InvalidArgumentException
+     */
+    private function clearCache($key) {
+        $allowedCacheKeys = array(self::CACHE_KEY_CSS, self::CACHE_KEY_SELECTOR, self::CACHE_KEY_XPATH, self::CACHE_KEY_CSS_DECLARATION_BLOCK);
+        if (!in_array($key, $allowedCacheKeys, true)) {
+            throw new InvalidArgumentException('Invalid cache key: ' . $key, 1391822035);
+        }
+
+        $this->caches[$key] = array();
+    }
+
+    /**
+     * Purges the visited nodes.
+     */
+    private function purgeVisitedNodes() {
+        $this->visitedNodes = array();
+        $this->styleAttributesForNodes = array();
+    }
+
+    /**
+     * Marks a tag for removal.
+     *
+     * There are some HTML tags that DOMDocument cannot process, and it will throw an error if it encounters them.
+     * In particular, DOMDocument will complain if you try to use HTML5 tags in an XHTML document.
+     *
+     * Note: The tags will not be removed if they have any content.
+     *
+     * @param string $tagName the tag name, e.g., "p"
+     */
+    public function addUnprocessableHtmlTag($tagName) {
+        $this->unprocessableHtmlTags[] = $tagName;
+    }
+
+    /**
+     * Drops a tag from the removal list.
+     *
+     * @param string $tagName the tag name, e.g., "p"
+     */
+    public function removeUnprocessableHtmlTag($tagName) {
+        $key = array_search($tagName, $this->unprocessableHtmlTags, true);
+        if ($key !== false) {
+            unset($this->unprocessableHtmlTags[$key]);
+        }
+    }
+
+    /**
+     * Applies the CSS you submit to the HTML you submit.
+     *
+     * This method places the CSS inline.
+     *
+     * @return string
+     *
+     * @throws BadMethodCallException
+     */
+    public function emogrify() {
+        if ($this->html === '') {
+            throw new BadMethodCallException('Please set some HTML first before calling emogrify.', 1390393096);
+        }
+
+        $xmlDocument = $this->createXmlDocument();
+        $xpath = new DOMXPath($xmlDocument);
+        $this->clearAllCaches();
+
+        // before be begin processing the CSS file, parse the document and normalize all existing CSS attributes (changes 'DISPLAY: none' to 'display: none');
+        // we wouldn't have to do this if DOMXPath supported XPath 2.0.
+        // also store a reference of nodes with existing inline styles so we don't overwrite them
+        $this->purgeVisitedNodes();
+
+        $nodesWithStyleAttributes = $xpath->query('//*[@style]');
+        if ($nodesWithStyleAttributes !== false) {
+            /** @var $nodeWithStyleAttribute DOMNode */
+            foreach ($nodesWithStyleAttributes as $node) {
+                $normalizedOriginalStyle = preg_replace_callback( '/[A-z\\-]+(?=\\:)/S', array( $this, 'strtolower' ), $node->getAttribute('style') );
+
+                // in order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles
+                $nodePath = $node->getNodePath();
+                if (!isset($this->styleAttributesForNodes[$nodePath])) {
+                    $this->styleAttributesForNodes[$nodePath] = $this->parseCssDeclarationBlock($normalizedOriginalStyle);
+                    $this->visitedNodes[$nodePath] = $node;
+                }
+
+                $node->setAttribute('style', $normalizedOriginalStyle);
+            }
+        }
+
+        // grab any existing style blocks from the html and append them to the existing CSS
+        // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS)
+        $allCss = $this->css;
+
+        $allCss .= $this->getCssFromAllStyleNodes($xpath);
+
+        $cssParts = $this->splitCssAndMediaQuery($allCss);
+        self::$_media = ''; // reset
+
+        $cssKey = md5($cssParts['css']);
+        if (!isset($this->caches[self::CACHE_KEY_CSS][$cssKey])) {
+            // process the CSS file for selectors and definitions
+            preg_match_all('/(?:^|[\\s^{}]*)([^{]+){([^}]*)}/mis', $cssParts['css'], $matches, PREG_SET_ORDER);
+
+            $allSelectors = array();
+            foreach ($matches as $key => $selectorString) {
+                // if there is a blank definition, skip
+                if (!strlen(trim($selectorString[2]))) {
+                    continue;
+                }
+
+                // else split by commas and duplicate attributes so we can sort by selector precedence
+                $selectors = explode(',', $selectorString[1]);
+                foreach ($selectors as $selector) {
+                    // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; ONLY allow structural pseudo-classes
+                    if (strpos($selector, ':') !== false && !preg_match('/:\\S+\\-(child|type)\\(/i', $selector)) {
+                        continue;
+                    }
+
+                    $allSelectors[] = array('selector' => trim($selector),
+                                                'attributes' => trim($selectorString[2]),
+                                                // keep track of where it appears in the file, since order is important
+                                                'line' => $key,
+                    );
+                }
+            }
+
+            // now sort the selectors by precedence
+            usort($allSelectors, array($this,'sortBySelectorPrecedence'));
+
+            $this->caches[self::CACHE_KEY_CSS][$cssKey] = $allSelectors;
+        }
+
+        foreach ($this->caches[self::CACHE_KEY_CSS][$cssKey] as $value) {
+            // query the body for the xpath selector
+            $nodesMatchingCssSelectors = $xpath->query($this->translateCssToXpath($value['selector']));
+
+            /** @var $node \DOMNode */
+            foreach ($nodesMatchingCssSelectors as $node) {
+                // if it has a style attribute, get it, process it, and append (overwrite) new stuff
+                if ($node->hasAttribute('style')) {
+                    // break it up into an associative array
+                    $oldStyleDeclarations = $this->parseCssDeclarationBlock($node->getAttribute('style'));
+                } else {
+                    $oldStyleDeclarations = array();
+                }
+                $newStyleDeclarations = $this->parseCssDeclarationBlock($value['attributes']);
+                $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations));
+            }
+        }
+
+        // now iterate through the nodes that contained inline styles in the original HTML
+        foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) {
+            $node = $this->visitedNodes[$nodePath];
+            $currentStyleAttributes = $this->parseCssDeclarationBlock($node->getAttribute('style'));
+            $node->setAttribute('style', $this->generateStyleStringFromDeclarationsArrays($currentStyleAttributes, $styleAttributesForNode));
+        }
+
+        // This removes styles from your email that contain display:none.
+        // We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only supports XPath 1.0,
+        // lower-case() isn't available to us. We've thus far only set attributes to lowercase, not attribute values. Consequently, we need
+        // to translate() the letters that would be in 'NONE' ("NOE") to lowercase.
+        $nodesWithStyleDisplayNone = $xpath->query('//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]');
+        // The checks on parentNode and is_callable below ensure that if we've deleted the parent node,
+        // we don't try to call removeChild on a nonexistent child node
+        if ($nodesWithStyleDisplayNone->length > 0) {
+            /** @var $node \DOMNode */
+            foreach ($nodesWithStyleDisplayNone as $node) {
+                if ($node->parentNode && is_callable(array($node->parentNode,'removeChild'))) {
+                    $node->parentNode->removeChild($node);
+                }
+            }
+        }
+
+        $this->copyCssWithMediaToStyleNode($cssParts, $xmlDocument);
+
+        if ($this->preserveEncoding) {
+            // Deprecated since PHP 8.2
+            if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
+                return mb_convert_encoding( $xmlDocument->saveHTML(), self::ENCODING, 'HTML-ENTITIES' );
+            } else {
+                return mb_encode_numericentity( $xmlDocument->saveHTML(), [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
+                //return htmlspecialchars_decode( utf8_encode( html_entity_decode( $xmlDocument->saveHTML(), ENT_COMPAT, self::ENCODING ) ) );
+            }
+        } else {
+            return $xmlDocument->saveHTML();
+        }
+    }
 
     /**
      * String to lower.
@@ -358,143 +358,143 @@ 
      * @param array $m
      * @return string
      */
-	public function strtolower(array $m) {
-		return strtolower($m[0]);
-	}
-
-
-	/**
-	 * This method merges old or existing name/value array with new name/value array.
-	 * and then generates a string of the combined style suitable for placing inline.
-	 * This becomes the single point for CSS string generation allowing for consistent.
-	 * CSS output no matter where the CSS originally came from.
-	 * @param array $oldStyles
-	 * @param array $newStyles
-	 * @return string
-	 */
-	private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) {
-		$combinedStyles = array_merge($oldStyles, $newStyles);
-		$style = '';
-		foreach ($combinedStyles as $attributeName => $attributeValue) {
-			$style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ');
-		}
-		return trim($style);
-	}
-
-
-	/**
-	 * Copies the media part from CSS array parts to $xmlDocument.
-	 *
-	 * @param array $cssParts
-	 * @param DOMDocument $xmlDocument
-	 */
-	public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) {
-		if (isset($cssParts['media']) && $cssParts['media'] !== '') {
-			$this->addStyleElementToDocument($xmlDocument, $cssParts['media']);
-		}
-	}
-
-	/**
-	 * Returns CSS content.
-	 *
-	 * @param DOMXPath $xpath
-	 * @return string
-	 */
-	private function getCssFromAllStyleNodes(DOMXPath $xpath) {
-		$styleNodes = $xpath->query('//style');
-
-		if ($styleNodes === false) {
-			return '';
-		}
-
-		$css = '';
-		/** @var $styleNode DOMNode */
-		foreach ($styleNodes as $styleNode) {
-			$css .= "\n\n" . $styleNode->nodeValue;
-			$styleNode->parentNode->removeChild($styleNode);
-		}
-
-		return $css;
-	}
-
-	/**
-	 * Adds a style element with $css to $document.
-	 *
-	 * @param DOMDocument $document
-	 * @param string $css
-	 */
-	private function addStyleElementToDocument(DOMDocument $document, $css) {
-		$styleElement = $document->createElement('style', $css);
-		$styleAttribute = $document->createAttribute('type');
-		$styleAttribute->value = 'text/css';
-		$styleElement->appendChild($styleAttribute);
-
-		$head = $this->getOrCreateHeadElement($document);
-		$head->appendChild($styleElement);
-	}
-
-	/**
-	 * Returns the existing or creates a new head element in $document.
-	 *
-	 * @param DOMDocument $document
-	 * @return DOMNode the head element
-	 */
-	private function getOrCreateHeadElement(DOMDocument $document) {
-		$head = $document->getElementsByTagName('head')->item(0);
-
-		if ($head === null) {
-			$head = $document->createElement('head');
-			$html = $document->getElementsByTagName('html')->item(0);
-			$html->insertBefore($head, $document->getElementsByTagName('body')->item(0));
-		}
-
-		return $head;
-	}
-
-	/**
-	 * Splits input CSS code to an array where:
-	 *
-	 * - key "css" will be contains clean CSS code.
-	 * - key "media" will be contains all valuable media queries.
-	 *
-	 * Example:
-	 *
-	 * The CSS code.
-	 *
-	 *   "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}"
-	 *
-	 * will be parsed into the following array:
-	 *
-	 *   "css" => "h1 { color:red; }"
-	 *   "media" => "@media { h1 {}}"
-	 *
-	 * @param string $css
-	 * @return array
-	 */
-	private function splitCssAndMediaQuery($css) {
-		$css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css );
-
-		// filter the CSS
-		$search = array(
-			// get rid of css comment code
-			'/\\/\\*.*\\*\\//sU',
-			// strip out any import directives
-			'/^\\s*@import\\s[^;]+;/misU',
-			// strip remains media enclosures
-			'/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
-		);
-
-		$replace = array(
-			'',
-			'',
-			'',
-		);
-
-		// clean CSS before output
-		$css = preg_replace($search, $replace, $css);
-
-		return array('css' => $css, 'media' => self::$_media);
-	}
+    public function strtolower(array $m) {
+        return strtolower($m[0]);
+    }
+
+
+    /**
+     * This method merges old or existing name/value array with new name/value array.
+     * and then generates a string of the combined style suitable for placing inline.
+     * This becomes the single point for CSS string generation allowing for consistent.
+     * CSS output no matter where the CSS originally came from.
+     * @param array $oldStyles
+     * @param array $newStyles
+     * @return string
+     */
+    private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles) {
+        $combinedStyles = array_merge($oldStyles, $newStyles);
+        $style = '';
+        foreach ($combinedStyles as $attributeName => $attributeValue) {
+            $style .= (strtolower(trim($attributeName)) . ': ' . trim($attributeValue) . '; ');
+        }
+        return trim($style);
+    }
+
+
+    /**
+     * Copies the media part from CSS array parts to $xmlDocument.
+     *
+     * @param array $cssParts
+     * @param DOMDocument $xmlDocument
+     */
+    public function copyCssWithMediaToStyleNode(array $cssParts, DOMDocument $xmlDocument) {
+        if (isset($cssParts['media']) && $cssParts['media'] !== '') {
+            $this->addStyleElementToDocument($xmlDocument, $cssParts['media']);
+        }
+    }
+
+    /**
+     * Returns CSS content.
+     *
+     * @param DOMXPath $xpath
+     * @return string
+     */
+    private function getCssFromAllStyleNodes(DOMXPath $xpath) {
+        $styleNodes = $xpath->query('//style');
+
+        if ($styleNodes === false) {
+            return '';
+        }
+
+        $css = '';
+        /** @var $styleNode DOMNode */
+        foreach ($styleNodes as $styleNode) {
+            $css .= "\n\n" . $styleNode->nodeValue;
+            $styleNode->parentNode->removeChild($styleNode);
+        }
+
+        return $css;
+    }
+
+    /**
+     * Adds a style element with $css to $document.
+     *
+     * @param DOMDocument $document
+     * @param string $css
+     */
+    private function addStyleElementToDocument(DOMDocument $document, $css) {
+        $styleElement = $document->createElement('style', $css);
+        $styleAttribute = $document->createAttribute('type');
+        $styleAttribute->value = 'text/css';
+        $styleElement->appendChild($styleAttribute);
+
+        $head = $this->getOrCreateHeadElement($document);
+        $head->appendChild($styleElement);
+    }
+
+    /**
+     * Returns the existing or creates a new head element in $document.
+     *
+     * @param DOMDocument $document
+     * @return DOMNode the head element
+     */
+    private function getOrCreateHeadElement(DOMDocument $document) {
+        $head = $document->getElementsByTagName('head')->item(0);
+
+        if ($head === null) {
+            $head = $document->createElement('head');
+            $html = $document->getElementsByTagName('html')->item(0);
+            $html->insertBefore($head, $document->getElementsByTagName('body')->item(0));
+        }
+
+        return $head;
+    }
+
+    /**
+     * Splits input CSS code to an array where:
+     *
+     * - key "css" will be contains clean CSS code.
+     * - key "media" will be contains all valuable media queries.
+     *
+     * Example:
+     *
+     * The CSS code.
+     *
+     *   "@import "file.css"; h1 { color:red; } @media { h1 {}} @media tv { h1 {}}"
+     *
+     * will be parsed into the following array:
+     *
+     *   "css" => "h1 { color:red; }"
+     *   "media" => "@media { h1 {}}"
+     *
+     * @param string $css
+     * @return array
+     */
+    private function splitCssAndMediaQuery($css) {
+        $css = preg_replace_callback( '#@media\\s+(?:only\\s)?(?:[\\s{\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#misU', array( $this, '_media_concat' ), $css );
+
+        // filter the CSS
+        $search = array(
+            // get rid of css comment code
+            '/\\/\\*.*\\*\\//sU',
+            // strip out any import directives
+            '/^\\s*@import\\s[^;]+;/misU',
+            // strip remains media enclosures
+            '/^\\s*@media\\s[^{]+{(.*)}\\s*}\\s/misU',
+        );
+
+        $replace = array(
+            '',
+            '',
+            '',
+        );
+
+        // clean CSS before output
+        $css = preg_replace($search, $replace, $css);
+
+        return array('css' => $css, 'media' => self::$_media);
+    }
 
     /**
      * Media concat.
@@ -503,306 +503,306 @@ 
      *
      * @param array $matches Matches result array.
      */
-	private function _media_concat( $matches ) {
-		self::$_media .= $matches[0];
-	}
-
-	/**
-	 * Creates a DOMDocument instance with the current HTML.
-	 *
-	 * @return DOMDocument
-	 */
-	private function createXmlDocument() {
-		$xmlDocument = new DOMDocument;
-		$xmlDocument->encoding = self::ENCODING;
-		$xmlDocument->strictErrorChecking = false;
-		$xmlDocument->formatOutput = true;
-		$libXmlState = libxml_use_internal_errors(true);
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		/** @scrutinizer ignore-unhandled */ @$xmlDocument->loadHTML($this->getUnifiedHtml());
-		libxml_clear_errors();
-		libxml_use_internal_errors($libXmlState);
-		$xmlDocument->normalizeDocument();
-
-		return $xmlDocument;
-	}
-
-	/**
-	 * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed.
-	 *
-	 * @return string the unified HTML
-	 *
-	 * @throws BadMethodCallException
-	 */
-	private function getUnifiedHtml() {
-		if (!empty($this->unprocessableHtmlTags)) {
-			$unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
-			$bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html);
-		} else {
-			$bodyWithoutUnprocessableTags = $this->html;
-		}
-
-		// Deprecated since PHP 8.2
-		if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
-			return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING );
-		} else {
-			return mb_encode_numericentity( $bodyWithoutUnprocessableTags, [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
-			//return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) );
-		}
-	}
-
-	/**
-	 * @param array $a
-	 * @param array $b
-	 *
-	 * @return integer
-	 */
-	private function sortBySelectorPrecedence(array $a, array $b) {
-		$precedenceA = $this->getCssSelectorPrecedence($a['selector']);
-		$precedenceB = $this->getCssSelectorPrecedence($b['selector']);
-
-		// We want these sorted in ascending order so selectors with lesser precedence get processed first and
-		// selectors with greater precedence get sorted last.
-		// The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around
-		// arithmetic operators.
-		// @see http://forge.typo3.org/issues/55605
-		$precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1);
-		$precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1);
-		return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
-	}
-
-	/**
-	 * @param string $selector
-	 *
-	 * @return integer
-	 */
-	private function getCssSelectorPrecedence($selector) {
-		$selectorKey = md5($selector);
-		if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
-			$precedence = 0;
-			$value = 100;
-			// ids: worth 100, classes: worth 10, elements: worth 1
-			$search = array('\\#','\\.','');
-
-			foreach ($search as $s) {
-				if (trim($selector == '')) {
-					break;
-				}
-				$number = 0;
-				$selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
-				$precedence += ($value * $number);
-				$value /= 10;
-			}
-			$this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
-		}
-
-		return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
-	}
-
-	/**
-	 * Right now, we support all CSS 1 selectors and most CSS2/3 selectors.
-	 *
-	 * @see http://plasmasturm.org/log/444/
-	 *
-	 * @param string $paramCssSelector
-	 *
-	 * @return string
-	 */
-	private function translateCssToXpath($paramCssSelector) {
-		$cssSelector = ' ' . $paramCssSelector . ' ';
-		$cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector );
-		$cssSelector = trim($cssSelector);
-		$xpathKey = md5($cssSelector);
-		if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) {
-			// returns an Xpath selector
-			$search = array(
-				// Matches any element that is a child of parent.
-				'/\\s+>\\s+/',
-				// Matches any element that is an adjacent sibling.
-				'/\\s+\\+\\s+/',
-				// Matches any element that is a descendant of an parent element element.
-				'/\\s+/',
-				// first-child pseudo-selector
-				'/([^\\/]+):first-child/i',
-				// last-child pseudo-selector
-				'/([^\\/]+):last-child/i',
-				// Matches attribute only selector
-				'/^\\[(\\w+)\\]/',
-				// Matches element with attribute
-				'/(\\w)\\[(\\w+)\\]/',
-				// Matches element with EXACT attribute
-				'/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/',
-			);
-			$replace = array(
-				'/',
-				'/following-sibling::*[1]/self::',
-				'//',
-				'*[1]/self::\\1',
-				'*[last()]/self::\\1',
-				'*[@\\1]',
-				'\\1[@\\2]',
-				'\\1[@\\2="\\3"]',
-			);
-
-			$cssSelector = '//' . preg_replace($search, $replace, $cssSelector);
-
-			$cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector);
-			$cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector);
-
-			// Advanced selectors are going to require a bit more advanced emogrification.
-			// When we required PHP 5.3, we could do this with closures.
-			$cssSelector = preg_replace_callback(
-				'/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
-				array($this, 'translateNthChild'), $cssSelector
-			);
-			$cssSelector = preg_replace_callback(
-				'/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
-				array($this, 'translateNthOfType'), $cssSelector
-			);
-
-			$this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector;
-		}
-		return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey];
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function matchIdAttributes(array $match) {
-		return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]';
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function matchClassAttributes(array $match) {
-		return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' .
-			implode(
-				'"," "))][contains(concat(" ",@class," "),concat(" ","',
-				explode('.', substr($match[2], 1))
-			) . '"," "))]';
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function translateNthChild(array $match) {
-		$result = $this->parseNth($match);
-
-		if (isset($result[self::MULTIPLIER])) {
-			if ($result[self::MULTIPLIER] < 0) {
-				$result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
-				return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
-			} else {
-				return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
-			}
-		} else {
-			return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]);
-		}
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return string
-	 */
-	private function translateNthOfType(array $match) {
-		$result = $this->parseNth($match);
-
-		if (isset($result[self::MULTIPLIER])) {
-			if ($result[self::MULTIPLIER] < 0) {
-				$result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
-				return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
-			} else {
-				return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
-			}
-		} else {
-			return sprintf('%s[%u]', $match[1], $result[self::INDEX]);
-		}
-	}
-
-	/**
-	 * @param array $match
-	 *
-	 * @return array
-	 */
-	private function parseNth(array $match) {
-		if (in_array(strtolower($match[2]), array('even','odd'))) {
-			$index = strtolower($match[2]) == 'even' ? 0 : 1;
-			return array(self::MULTIPLIER => 2, self::INDEX => $index);
-		} elseif (stripos($match[2], 'n') === false) {
-			// if there is a multiplier
-			$index = intval(str_replace(' ', '', $match[2]));
-			return array(self::INDEX => $index);
-		} else {
-			if (isset($match[3])) {
-				$multipleTerm = str_replace($match[3], '', $match[2]);
-				$index = intval(str_replace(' ', '', $match[3]));
-			} else {
-				$multipleTerm = $match[2];
-				$index = 0;
-			}
-
-			$multiplier = str_ireplace('n', '', $multipleTerm);
-
-			if (!strlen($multiplier)) {
-				$multiplier = 1;
-			} elseif ($multiplier == 0) {
-				return array(self::INDEX => $index);
-			} else {
-				$multiplier = intval($multiplier);
-			}
-
-			while ($index < 0) {
-				$index += abs($multiplier);
-			}
-
-			return array(self::MULTIPLIER => $multiplier, self::INDEX => $index);
-		}
-	}
-
-	/**
-	 * Parses a CSS declaration block into property name/value pairs.
-	 *
-	 * Example:
-	 *
-	 * The declaration block.
-	 *
-	 *   "color: #000; font-weight: bold;".
-	 *
-	 * will be parsed into the following array:
-	 *
-	 *   "color" => "#000"
-	 *   "font-weight" => "bold"
-	 *
-	 * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty
-	 *
-	 * @return array the CSS declarations with the property names as array keys and the property values as array values
-	 */
-	private function parseCssDeclarationBlock($cssDeclarationBlock) {
-		if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) {
-			return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock];
-		}
-
-		$properties = array();
-		$declarations = explode(';', $cssDeclarationBlock);
-		foreach ($declarations as $declaration) {
-			$matches = array();
-			if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) {
-				continue;
-			}
-			$propertyName = strtolower($matches[1]);
-			$propertyValue = $matches[2];
-			$properties[$propertyName] = $propertyValue;
-		}
-		$this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties;
-
-		return $properties;
-	}
+    private function _media_concat( $matches ) {
+        self::$_media .= $matches[0];
+    }
+
+    /**
+     * Creates a DOMDocument instance with the current HTML.
+     *
+     * @return DOMDocument
+     */
+    private function createXmlDocument() {
+        $xmlDocument = new DOMDocument;
+        $xmlDocument->encoding = self::ENCODING;
+        $xmlDocument->strictErrorChecking = false;
+        $xmlDocument->formatOutput = true;
+        $libXmlState = libxml_use_internal_errors(true);
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        /** @scrutinizer ignore-unhandled */ @$xmlDocument->loadHTML($this->getUnifiedHtml());
+        libxml_clear_errors();
+        libxml_use_internal_errors($libXmlState);
+        $xmlDocument->normalizeDocument();
+
+        return $xmlDocument;
+    }
+
+    /**
+     * Returns the HTML with the non-ASCII characters converts into HTML entities and the unprocessable HTML tags removed.
+     *
+     * @return string the unified HTML
+     *
+     * @throws BadMethodCallException
+     */
+    private function getUnifiedHtml() {
+        if (!empty($this->unprocessableHtmlTags)) {
+            $unprocessableHtmlTags = implode('|', $this->unprocessableHtmlTags);
+            $bodyWithoutUnprocessableTags = preg_replace('/<\\/?(' . $unprocessableHtmlTags . ')[^>]*>/i', '', $this->html);
+        } else {
+            $bodyWithoutUnprocessableTags = $this->html;
+        }
+
+        // Deprecated since PHP 8.2
+        if ( version_compare( PHP_VERSION, '8.2', '<' ) && function_exists( 'mb_convert_encoding' ) ) {
+            return mb_convert_encoding( $bodyWithoutUnprocessableTags, 'HTML-ENTITIES', self::ENCODING );
+        } else {
+            return mb_encode_numericentity( $bodyWithoutUnprocessableTags, [0x80, 0x10FFFF, 0, ~0], self::ENCODING );
+            //return htmlspecialchars_decode( utf8_decode( htmlentities( $bodyWithoutUnprocessableTags, ENT_COMPAT, self::ENCODING, false ) ) );
+        }
+    }
+
+    /**
+     * @param array $a
+     * @param array $b
+     *
+     * @return integer
+     */
+    private function sortBySelectorPrecedence(array $a, array $b) {
+        $precedenceA = $this->getCssSelectorPrecedence($a['selector']);
+        $precedenceB = $this->getCssSelectorPrecedence($b['selector']);
+
+        // We want these sorted in ascending order so selectors with lesser precedence get processed first and
+        // selectors with greater precedence get sorted last.
+        // The parenthesis around the -1 are necessary to avoid a PHP_CodeSniffer warning about missing spaces around
+        // arithmetic operators.
+        // @see http://forge.typo3.org/issues/55605
+        $precedenceForEquals = ($a['line'] < $b['line'] ? (-1) : 1);
+        $precedenceForNotEquals = ($precedenceA < $precedenceB ? (-1) : 1);
+        return ($precedenceA === $precedenceB) ? $precedenceForEquals : $precedenceForNotEquals;
+    }
+
+    /**
+     * @param string $selector
+     *
+     * @return integer
+     */
+    private function getCssSelectorPrecedence($selector) {
+        $selectorKey = md5($selector);
+        if (!isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) {
+            $precedence = 0;
+            $value = 100;
+            // ids: worth 100, classes: worth 10, elements: worth 1
+            $search = array('\\#','\\.','');
+
+            foreach ($search as $s) {
+                if (trim($selector == '')) {
+                    break;
+                }
+                $number = 0;
+                $selector = preg_replace('/' . $s . '\\w+/', '', $selector, -1, $number);
+                $precedence += ($value * $number);
+                $value /= 10;
+            }
+            $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence;
+        }
+
+        return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey];
+    }
+
+    /**
+     * Right now, we support all CSS 1 selectors and most CSS2/3 selectors.
+     *
+     * @see http://plasmasturm.org/log/444/
+     *
+     * @param string $paramCssSelector
+     *
+     * @return string
+     */
+    private function translateCssToXpath($paramCssSelector) {
+        $cssSelector = ' ' . $paramCssSelector . ' ';
+        $cssSelector = preg_replace_callback( '/\s+\w+\s+/', array( $this, 'strtolower' ), $cssSelector );
+        $cssSelector = trim($cssSelector);
+        $xpathKey = md5($cssSelector);
+        if (!isset($this->caches[self::CACHE_KEY_XPATH][$xpathKey])) {
+            // returns an Xpath selector
+            $search = array(
+                // Matches any element that is a child of parent.
+                '/\\s+>\\s+/',
+                // Matches any element that is an adjacent sibling.
+                '/\\s+\\+\\s+/',
+                // Matches any element that is a descendant of an parent element element.
+                '/\\s+/',
+                // first-child pseudo-selector
+                '/([^\\/]+):first-child/i',
+                // last-child pseudo-selector
+                '/([^\\/]+):last-child/i',
+                // Matches attribute only selector
+                '/^\\[(\\w+)\\]/',
+                // Matches element with attribute
+                '/(\\w)\\[(\\w+)\\]/',
+                // Matches element with EXACT attribute
+                '/(\\w)\\[(\\w+)\\=[\'"]?(\\w+)[\'"]?\\]/',
+            );
+            $replace = array(
+                '/',
+                '/following-sibling::*[1]/self::',
+                '//',
+                '*[1]/self::\\1',
+                '*[last()]/self::\\1',
+                '*[@\\1]',
+                '\\1[@\\2]',
+                '\\1[@\\2="\\3"]',
+            );
+
+            $cssSelector = '//' . preg_replace($search, $replace, $cssSelector);
+
+            $cssSelector = preg_replace_callback(self::ID_ATTRIBUTE_MATCHER, array($this, 'matchIdAttributes'), $cssSelector);
+            $cssSelector = preg_replace_callback(self::CLASS_ATTRIBUTE_MATCHER, array($this, 'matchClassAttributes'), $cssSelector);
+
+            // Advanced selectors are going to require a bit more advanced emogrification.
+            // When we required PHP 5.3, we could do this with closures.
+            $cssSelector = preg_replace_callback(
+                '/([^\\/]+):nth-child\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+                array($this, 'translateNthChild'), $cssSelector
+            );
+            $cssSelector = preg_replace_callback(
+                '/([^\\/]+):nth-of-type\\(\s*(odd|even|[+\-]?\\d|[+\\-]?\\d?n(\\s*[+\\-]\\s*\\d)?)\\s*\\)/i',
+                array($this, 'translateNthOfType'), $cssSelector
+            );
+
+            $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey] = $cssSelector;
+        }
+        return $this->caches[self::CACHE_KEY_SELECTOR][$xpathKey];
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function matchIdAttributes(array $match) {
+        return (strlen($match[1]) ? $match[1] : '*') . '[@id="' . $match[2] . '"]';
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function matchClassAttributes(array $match) {
+        return (strlen($match[1]) ? $match[1] : '*') . '[contains(concat(" ",@class," "),concat(" ","' .
+            implode(
+                '"," "))][contains(concat(" ",@class," "),concat(" ","',
+                explode('.', substr($match[2], 1))
+            ) . '"," "))]';
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function translateNthChild(array $match) {
+        $result = $this->parseNth($match);
+
+        if (isset($result[self::MULTIPLIER])) {
+            if ($result[self::MULTIPLIER] < 0) {
+                $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
+                return sprintf('*[(last() - position()) mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
+            } else {
+                return sprintf('*[position() mod %u = %u]/self::%s', $result[self::MULTIPLIER], $result[self::INDEX], $match[1]);
+            }
+        } else {
+            return sprintf('*[%u]/self::%s', $result[self::INDEX], $match[1]);
+        }
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return string
+     */
+    private function translateNthOfType(array $match) {
+        $result = $this->parseNth($match);
+
+        if (isset($result[self::MULTIPLIER])) {
+            if ($result[self::MULTIPLIER] < 0) {
+                $result[self::MULTIPLIER] = abs($result[self::MULTIPLIER]);
+                return sprintf('%s[(last() - position()) mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
+            } else {
+                return sprintf('%s[position() mod %u = %u]', $match[1], $result[self::MULTIPLIER], $result[self::INDEX]);
+            }
+        } else {
+            return sprintf('%s[%u]', $match[1], $result[self::INDEX]);
+        }
+    }
+
+    /**
+     * @param array $match
+     *
+     * @return array
+     */
+    private function parseNth(array $match) {
+        if (in_array(strtolower($match[2]), array('even','odd'))) {
+            $index = strtolower($match[2]) == 'even' ? 0 : 1;
+            return array(self::MULTIPLIER => 2, self::INDEX => $index);
+        } elseif (stripos($match[2], 'n') === false) {
+            // if there is a multiplier
+            $index = intval(str_replace(' ', '', $match[2]));
+            return array(self::INDEX => $index);
+        } else {
+            if (isset($match[3])) {
+                $multipleTerm = str_replace($match[3], '', $match[2]);
+                $index = intval(str_replace(' ', '', $match[3]));
+            } else {
+                $multipleTerm = $match[2];
+                $index = 0;
+            }
+
+            $multiplier = str_ireplace('n', '', $multipleTerm);
+
+            if (!strlen($multiplier)) {
+                $multiplier = 1;
+            } elseif ($multiplier == 0) {
+                return array(self::INDEX => $index);
+            } else {
+                $multiplier = intval($multiplier);
+            }
+
+            while ($index < 0) {
+                $index += abs($multiplier);
+            }
+
+            return array(self::MULTIPLIER => $multiplier, self::INDEX => $index);
+        }
+    }
+
+    /**
+     * Parses a CSS declaration block into property name/value pairs.
+     *
+     * Example:
+     *
+     * The declaration block.
+     *
+     *   "color: #000; font-weight: bold;".
+     *
+     * will be parsed into the following array:
+     *
+     *   "color" => "#000"
+     *   "font-weight" => "bold"
+     *
+     * @param string $cssDeclarationBlock the CSS declaration block without the curly braces, may be empty
+     *
+     * @return array the CSS declarations with the property names as array keys and the property values as array values
+     */
+    private function parseCssDeclarationBlock($cssDeclarationBlock) {
+        if (isset($this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock])) {
+            return $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock];
+        }
+
+        $properties = array();
+        $declarations = explode(';', $cssDeclarationBlock);
+        foreach ($declarations as $declaration) {
+            $matches = array();
+            if (!preg_match('/ *([A-Za-z\\-]+) *: *([^;]+) */', $declaration, $matches)) {
+                continue;
+            }
+            $propertyName = strtolower($matches[1]);
+            $propertyValue = $matches[2];
+            $properties[$propertyName] = $propertyValue;
+        }
+        $this->caches[self::CACHE_KEY_CSS_DECLARATION_BLOCK][$cssDeclarationBlock] = $properties;
+
+        return $properties;
+    }
 }

includes/class-wpinv.php

Indentation +597 added lines, -597 removed lines

@@ -14,643 +14,643 @@
  */
 class WPInv_Plugin {
 
-	/**
-	 * GetPaid version.
-	 *
-	 * @var string
-	 */
-	public $version;
-
-	/**
-	 * Data container.
-	 *
-	 * @var array
-	 */
-	protected $data = array();
-
-	/**
-	 * Form elements instance.
-	 *
-	 * @var WPInv_Payment_Form_Elements
-	 */
-	public $form_elements;
-
-	/**
-	 * @var array An array of payment gateways.
-	 */
-	public $gateways;
-
-	/**
-	 * Class constructor.
-	 */
-	public function __construct() {
-		$this->define_constants();
-		$this->includes();
-		$this->init_hooks();
-		$this->set_properties();
-	}
-
-	/**
-	 * Sets a custom data property.
-	 *
-	 * @param string $prop The prop to set.
-	 * @param mixed $value The value to retrieve.
-	 */
-	public function set( $prop, $value ) {
-		$this->data[ $prop ] = $value;
-	}
-
-	/**
-	 * Gets a custom data property.
-	 *
-	 * @param string $prop The prop to set.
-	 * @return mixed The value.
-	 */
-	public function get( $prop ) {
-
-		if ( isset( $this->data[ $prop ] ) ) {
-			return $this->data[ $prop ];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Define class properties.
-	 */
-	public function set_properties() {
-
-		// Sessions.
-		$this->set( 'session', new WPInv_Session_Handler() );
-		$GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility.
-		$GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility.
-
-		// Init other objects.
-		$this->set( 'notes', new WPInv_Notes() );
-		$this->set( 'api', new WPInv_API() );
-		$this->set( 'post_types', new GetPaid_Post_Types() );
-		$this->set( 'template', new GetPaid_Template() );
-		$this->set( 'admin', new GetPaid_Admin() );
-		$this->set( 'subscriptions', new WPInv_Subscriptions() );
-		$this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() );
-		$this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() );
-		$this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() );
-		$this->set( 'payment_forms', new GetPaid_Payment_Forms() );
-		$this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() );
-
-	}
-
-	 /**
-	 * Define plugin constants.
-	 */
-	public function define_constants() {
-		define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) );
-		define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) );
-		$this->version = WPINV_VERSION;
-	}
-
-	/**
-	 * Hook into actions and filters.
-	 *
-	 * @since 1.0.19
-	 */
-	protected function init_hooks() {
-		/* Internationalize the text strings used. */
-		add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) );
-
-		// Init the plugin after WordPress inits.
-		add_action( 'init', array( $this, 'init' ), 1 );
-		add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 );
-		add_action( 'init', array( $this, 'wpinv_actions' ) );
-		add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 );
-		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 );
-		add_action( 'wp_footer', array( $this, 'wp_footer' ) );
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
-		add_action( 'widgets_init', array( $this, 'register_widgets' ) );
-		add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) );
-		add_filter( 'the_seo_framework_sitemap_supported_post_types', array( $this, 'exclude_invoicing_post_types' ) );
-		add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) );
-
-		add_filter( 'query_vars', array( $this, 'custom_query_vars' ) );
+    /**
+     * GetPaid version.
+     *
+     * @var string
+     */
+    public $version;
+
+    /**
+     * Data container.
+     *
+     * @var array
+     */
+    protected $data = array();
+
+    /**
+     * Form elements instance.
+     *
+     * @var WPInv_Payment_Form_Elements
+     */
+    public $form_elements;
+
+    /**
+     * @var array An array of payment gateways.
+     */
+    public $gateways;
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+        $this->define_constants();
+        $this->includes();
+        $this->init_hooks();
+        $this->set_properties();
+    }
+
+    /**
+     * Sets a custom data property.
+     *
+     * @param string $prop The prop to set.
+     * @param mixed $value The value to retrieve.
+     */
+    public function set( $prop, $value ) {
+        $this->data[ $prop ] = $value;
+    }
+
+    /**
+     * Gets a custom data property.
+     *
+     * @param string $prop The prop to set.
+     * @return mixed The value.
+     */
+    public function get( $prop ) {
+
+        if ( isset( $this->data[ $prop ] ) ) {
+            return $this->data[ $prop ];
+        }
+
+        return null;
+    }
+
+    /**
+     * Define class properties.
+     */
+    public function set_properties() {
+
+        // Sessions.
+        $this->set( 'session', new WPInv_Session_Handler() );
+        $GLOBALS['wpi_session'] = $this->get( 'session' ); // Backwards compatibility.
+        $GLOBALS['wpinv_euvat'] = new WPInv_EUVat(); // Backwards compatibility.
+
+        // Init other objects.
+        $this->set( 'notes', new WPInv_Notes() );
+        $this->set( 'api', new WPInv_API() );
+        $this->set( 'post_types', new GetPaid_Post_Types() );
+        $this->set( 'template', new GetPaid_Template() );
+        $this->set( 'admin', new GetPaid_Admin() );
+        $this->set( 'subscriptions', new WPInv_Subscriptions() );
+        $this->set( 'invoice_emails', new GetPaid_Invoice_Notification_Emails() );
+        $this->set( 'subscription_emails', new GetPaid_Subscription_Notification_Emails() );
+        $this->set( 'daily_maintenace', new GetPaid_Daily_Maintenance() );
+        $this->set( 'payment_forms', new GetPaid_Payment_Forms() );
+        $this->set( 'maxmind', new GetPaid_MaxMind_Geolocation() );
+
+    }
+
+        /**
+         * Define plugin constants.
+         */
+    public function define_constants() {
+        define( 'WPINV_PLUGIN_DIR', plugin_dir_path( WPINV_PLUGIN_FILE ) );
+        define( 'WPINV_PLUGIN_URL', plugin_dir_url( WPINV_PLUGIN_FILE ) );
+        $this->version = WPINV_VERSION;
+    }
+
+    /**
+     * Hook into actions and filters.
+     *
+     * @since 1.0.19
+     */
+    protected function init_hooks() {
+        /* Internationalize the text strings used. */
+        add_action( 'plugins_loaded', array( &$this, 'plugins_loaded' ) );
+
+        // Init the plugin after WordPress inits.
+        add_action( 'init', array( $this, 'init' ), 1 );
+        add_action( 'init', array( $this, 'maybe_process_ipn' ), 10 );
+        add_action( 'init', array( $this, 'wpinv_actions' ) );
+        add_action( 'init', array( $this, 'maybe_do_authenticated_action' ), 100 );
+        add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ), 11 );
+        add_action( 'wp_footer', array( $this, 'wp_footer' ) );
+        add_action( 'wp_head', array( $this, 'wp_head' ) );
+        add_action( 'widgets_init', array( $this, 'register_widgets' ) );
+        add_filter( 'wpseo_exclude_from_sitemap_by_post_ids', array( $this, 'wpseo_exclude_from_sitemap_by_post_ids' ) );
+        add_filter( 'the_seo_framework_sitemap_supported_post_types', array( $this, 'exclude_invoicing_post_types' ) );
+        add_filter( 'pre_get_posts', array( &$this, 'pre_get_posts' ) );
+
+        add_filter( 'query_vars', array( $this, 'custom_query_vars' ) );
         add_action( 'init', array( $this, 'add_rewrite_rule' ), 10, 0 );
-		add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 );
-
-		// Fires after registering actions.
-		do_action( 'wpinv_actions', $this );
-		do_action( 'getpaid_actions', $this );
-
-	}
-
-	public function plugins_loaded() {
-		/* Internationalize the text strings used. */
-		$this->load_textdomain();
-
-		do_action( 'wpinv_loaded' );
-
-		// Fix oxygen page builder conflict
-		if ( function_exists( 'ct_css_output' ) ) {
-			wpinv_oxygen_fix_conflict();
-		}
-	}
-
-	/**
-	 * Load Localisation files.
-	 *
-	 * Note: the first-loaded translation file overrides any following ones if the same translation is present.
-	 *
-	 * Locales found in:
-	 *      - WP_LANG_DIR/plugins/invoicing-LOCALE.mo
-	 *      - WP_PLUGIN_DIR/invoicing/languages/invoicing-LOCALE.mo
-	 *
-	 * @since 1.0.0
-	 */
-	public function load_textdomain() {
-
-		load_plugin_textdomain(
-			'invoicing',
-			false,
-			plugin_basename( dirname( WPINV_PLUGIN_FILE ) ) . '/languages/'
-		);
-
-	}
-
-	/**
-	 * Include required core files used in admin and on the frontend.
-	 */
-	public function includes() {
-
-		// Start with the settings.
-		require_once WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php';
-
-		// Packages/libraries.
-		require_once WPINV_PLUGIN_DIR . 'vendor/autoload.php';
-		require_once WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php';
-
-		// Load functions.
-		require_once WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/invoice-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/subscription-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/user-functions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/error-functions.php';
-
-		// Register autoloader.
-		try {
-			spl_autoload_register( array( $this, 'autoload' ), true );
-		} catch ( Exception $e ) {
-			wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
-		}
-
-		require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/checkout.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice-history.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/subscriptions.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/buy-item.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/getpaid.php';
-		require_once WPINV_PLUGIN_DIR . 'widgets/invoice.php';
-		require_once WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php';
-
-		if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) {
-			GetPaid_Post_Types_Admin::init();
-
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php';
-			require_once WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php';
-			// load the user class only on the users.php page
-			global $pagenow;
-			if ( $pagenow == 'users.php' ) {
-				new WPInv_Admin_Users();
-			}
-		}
-
-		// Register cli commands
-		if ( defined( 'WP_CLI' ) && WP_CLI ) {
-			require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php';
-			WP_CLI::add_command( 'invoicing', 'WPInv_CLI' );
-		}
-
-	}
-
-	/**
-	 * Class autoloader
-	 *
-	 * @param       string $class_name The name of the class to load.
-	 * @access      public
-	 * @since       1.0.19
-	 * @return      void
-	 */
-	public function autoload( $class_name ) {
-
-		// Normalize the class name...
-		$class_name  = strtolower( $class_name );
-
-		// ... and make sure it is our class.
-		if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
-			return;
-		}
-
-		// Next, prepare the file name from the class.
-		$file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
-
-		// Base path of the classes.
-		$plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
-
-		// And an array of possible locations in order of importance.
-		$locations = array(
-			"$plugin_path/includes",
-			"$plugin_path/includes/data-stores",
-			"$plugin_path/includes/gateways",
-			"$plugin_path/includes/payments",
-			"$plugin_path/includes/geolocation",
-			"$plugin_path/includes/reports",
-			"$plugin_path/includes/api",
-			"$plugin_path/includes/admin",
-			"$plugin_path/includes/admin/meta-boxes",
-		);
-
-		foreach ( apply_filters( 'getpaid_autoload_locations', $locations ) as $location ) {
-
-			if ( file_exists( trailingslashit( $location ) . $file_name ) ) {
-				include trailingslashit( $location ) . $file_name;
-				break;
-			}
+        add_action( 'pre_get_posts', array( $this, 'maybe_process_new_ipn' ), 1 );
+
+        // Fires after registering actions.
+        do_action( 'wpinv_actions', $this );
+        do_action( 'getpaid_actions', $this );
+
+    }
+
+    public function plugins_loaded() {
+        /* Internationalize the text strings used. */
+        $this->load_textdomain();
+
+        do_action( 'wpinv_loaded' );
+
+        // Fix oxygen page builder conflict
+        if ( function_exists( 'ct_css_output' ) ) {
+            wpinv_oxygen_fix_conflict();
+        }
+    }
+
+    /**
+     * Load Localisation files.
+     *
+     * Note: the first-loaded translation file overrides any following ones if the same translation is present.
+     *
+     * Locales found in:
+     *      - WP_LANG_DIR/plugins/invoicing-LOCALE.mo
+     *      - WP_PLUGIN_DIR/invoicing/languages/invoicing-LOCALE.mo
+     *
+     * @since 1.0.0
+     */
+    public function load_textdomain() {
+
+        load_plugin_textdomain(
+            'invoicing',
+            false,
+            plugin_basename( dirname( WPINV_PLUGIN_FILE ) ) . '/languages/'
+        );
+
+    }
+
+    /**
+     * Include required core files used in admin and on the frontend.
+     */
+    public function includes() {
+
+        // Start with the settings.
+        require_once WPINV_PLUGIN_DIR . 'includes/admin/register-settings.php';
+
+        // Packages/libraries.
+        require_once WPINV_PLUGIN_DIR . 'vendor/autoload.php';
+        require_once WPINV_PLUGIN_DIR . 'vendor/ayecode/wp-ayecode-ui/ayecode-ui-loader.php';
+
+        // Load functions.
+        require_once WPINV_PLUGIN_DIR . 'includes/deprecated-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-email-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-general-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-helper-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-tax-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-template-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-address-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/invoice-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/subscription-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-item-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-discount-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-gateway-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-payment-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/user-functions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/error-functions.php';
+
+        // Register autoloader.
+        try {
+            spl_autoload_register( array( $this, 'autoload' ), true );
+        } catch ( Exception $e ) {
+            wpinv_error_log( $e->getMessage(), '', __FILE__, 149, true );
+        }
+
+        require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-session.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-session-handler.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-ajax.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-api.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cache-helper.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-db.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/admin/subscriptions.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-subscriptions-db.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/wpinv-subscription.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/abstracts/abstract-wpinv-privacy.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-privacy.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/libraries/class-ayecode-addons.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-addons.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/checkout.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice-history.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice-receipt.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice-messages.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/subscriptions.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/buy-item.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/getpaid.php';
+        require_once WPINV_PLUGIN_DIR . 'widgets/invoice.php';
+        require_once WPINV_PLUGIN_DIR . 'includes/admin/admin-pages.php';
+
+        if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) {
+            GetPaid_Post_Types_Admin::init();
+
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/wpinv-admin-functions.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-payment-form.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/meta-boxes/class-mb-invoice-notes.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-admin-menus.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/class-wpinv-users.php';
+            require_once WPINV_PLUGIN_DIR . 'includes/admin/class-getpaid-admin-profile.php';
+            // load the user class only on the users.php page
+            global $pagenow;
+            if ( $pagenow == 'users.php' ) {
+                new WPInv_Admin_Users();
+            }
+        }
+
+        // Register cli commands
+        if ( defined( 'WP_CLI' ) && WP_CLI ) {
+            require_once WPINV_PLUGIN_DIR . 'includes/class-wpinv-cli.php';
+            WP_CLI::add_command( 'invoicing', 'WPInv_CLI' );
+        }
+
+    }
+
+    /**
+     * Class autoloader
+     *
+     * @param       string $class_name The name of the class to load.
+     * @access      public
+     * @since       1.0.19
+     * @return      void
+     */
+    public function autoload( $class_name ) {
+
+        // Normalize the class name...
+        $class_name  = strtolower( $class_name );
+
+        // ... and make sure it is our class.
+        if ( false === strpos( $class_name, 'getpaid_' ) && false === strpos( $class_name, 'wpinv_' ) ) {
+            return;
+        }
+
+        // Next, prepare the file name from the class.
+        $file_name = 'class-' . str_replace( '_', '-', $class_name ) . '.php';
+
+        // Base path of the classes.
+        $plugin_path = untrailingslashit( WPINV_PLUGIN_DIR );
+
+        // And an array of possible locations in order of importance.
+        $locations = array(
+            "$plugin_path/includes",
+            "$plugin_path/includes/data-stores",
+            "$plugin_path/includes/gateways",
+            "$plugin_path/includes/payments",
+            "$plugin_path/includes/geolocation",
+            "$plugin_path/includes/reports",
+            "$plugin_path/includes/api",
+            "$plugin_path/includes/admin",
+            "$plugin_path/includes/admin/meta-boxes",
+        );
+
+        foreach ( apply_filters( 'getpaid_autoload_locations', $locations ) as $location ) {
+
+            if ( file_exists( trailingslashit( $location ) . $file_name ) ) {
+                include trailingslashit( $location ) . $file_name;
+                break;
+            }
 }
 
-	}
-
-	/**
-	 * Inits hooks etc.
-	 */
-	public function init() {
-
-		// Fires before getpaid inits.
-		do_action( 'before_getpaid_init', $this );
-
-		// Maybe upgrade.
-		$this->maybe_upgrade_database();
-
-		// Load default gateways.
-		$gateways = apply_filters(
-			'getpaid_default_gateways',
-			array(
-				'manual'        => 'GetPaid_Manual_Gateway',
-				'paypal'        => 'GetPaid_Paypal_Gateway',
-				'worldpay'      => 'GetPaid_Worldpay_Gateway',
-				'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway',
-				'authorizenet'  => 'GetPaid_Authorize_Net_Gateway',
-			)
-		);
-
-		foreach ( $gateways as $id => $class ) {
-			$this->gateways[ $id ] = new $class();
-		}
-
-		if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) {
-			GetPaid_Installer::rename_gateways_label();
-			update_option( 'wpinv_renamed_gateways', 'yes' );
-		}
-
-		// Fires after getpaid inits.
-		do_action( 'getpaid_init', $this );
-
-	}
-
-	/**
-	 * Checks if this is an IPN request and processes it.
-	 */
-	public function maybe_process_ipn() {
-
-		// Ensure that this is an IPN request.
-		if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) {
-			return;
-		}
-
-		$gateway = sanitize_text_field( $_GET['wpi-gateway'] );
-
-		do_action( 'wpinv_verify_payment_ipn', $gateway );
-		do_action( "wpinv_verify_{$gateway}_ipn" );
-		exit;
-
-	}
-
-	public function enqueue_scripts() {
-
-		// Fires before adding scripts.
-		do_action( 'getpaid_enqueue_scripts' );
-
-		$localize                         = array();
-		$localize['ajax_url']             = admin_url( 'admin-ajax.php' );
-		$localize['thousands']            = wpinv_thousands_separator();
-		$localize['decimals']             = wpinv_decimal_separator();
-		$localize['nonce']                = wp_create_nonce( 'wpinv-nonce' );
-		$localize['txtComplete']          = __( 'Continue', 'invoicing' );
-		$localize['UseTaxes']             = wpinv_use_taxes();
-		$localize['formNonce']            = wp_create_nonce( 'getpaid_form_nonce' );
-		$localize['loading']              = __( 'Loading...', 'invoicing' );
-		$localize['connectionError']      = __( 'Could not establish a connection to the server.', 'invoicing' );
-		$localize['recaptchaSettings']    = getpaid_get_recaptcha_settings();
-
-		$localize = apply_filters( 'wpinv_front_js_localize', $localize );
-
-		// reCaptcha.
-		if ( getpaid_is_recaptcha_enabled() && ( $recaptcha_js = getpaid_recaptcha_api_url() ) ) {
-			wp_enqueue_script( 'recaptcha', $recaptcha_js, array(), null, true ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion
-		}
-
-		$version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' );
-		wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true );
-		wp_localize_script( 'wpinv-front-script', 'WPInv', $localize );
-	}
-
-	public function wpinv_actions() {
-		if ( isset( $_REQUEST['wpi_action'] ) ) {
-			do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST );
-		}
-
-		if ( defined( 'WP_ALL_IMPORT_ROOT_DIR' ) ) {
-			include plugin_dir_path( __FILE__ ) . 'libraries/wp-all-import/class-getpaid-wp-all-import.php';
-		}
-	}
-
-	/**
+    }
+
+    /**
+     * Inits hooks etc.
+     */
+    public function init() {
+
+        // Fires before getpaid inits.
+        do_action( 'before_getpaid_init', $this );
+
+        // Maybe upgrade.
+        $this->maybe_upgrade_database();
+
+        // Load default gateways.
+        $gateways = apply_filters(
+            'getpaid_default_gateways',
+            array(
+                'manual'        => 'GetPaid_Manual_Gateway',
+                'paypal'        => 'GetPaid_Paypal_Gateway',
+                'worldpay'      => 'GetPaid_Worldpay_Gateway',
+                'bank_transfer' => 'GetPaid_Bank_Transfer_Gateway',
+                'authorizenet'  => 'GetPaid_Authorize_Net_Gateway',
+            )
+        );
+
+        foreach ( $gateways as $id => $class ) {
+            $this->gateways[ $id ] = new $class();
+        }
+
+        if ( 'yes' != get_option( 'wpinv_renamed_gateways' ) ) {
+            GetPaid_Installer::rename_gateways_label();
+            update_option( 'wpinv_renamed_gateways', 'yes' );
+        }
+
+        // Fires after getpaid inits.
+        do_action( 'getpaid_init', $this );
+
+    }
+
+    /**
+     * Checks if this is an IPN request and processes it.
+     */
+    public function maybe_process_ipn() {
+
+        // Ensure that this is an IPN request.
+        if ( empty( $_GET['wpi-listener'] ) || 'IPN' !== $_GET['wpi-listener'] || empty( $_GET['wpi-gateway'] ) ) {
+            return;
+        }
+
+        $gateway = sanitize_text_field( $_GET['wpi-gateway'] );
+
+        do_action( 'wpinv_verify_payment_ipn', $gateway );
+        do_action( "wpinv_verify_{$gateway}_ipn" );
+        exit;
+
+    }
+
+    public function enqueue_scripts() {
+
+        // Fires before adding scripts.
+        do_action( 'getpaid_enqueue_scripts' );
+
+        $localize                         = array();
+        $localize['ajax_url']             = admin_url( 'admin-ajax.php' );
+        $localize['thousands']            = wpinv_thousands_separator();
+        $localize['decimals']             = wpinv_decimal_separator();
+        $localize['nonce']                = wp_create_nonce( 'wpinv-nonce' );
+        $localize['txtComplete']          = __( 'Continue', 'invoicing' );
+        $localize['UseTaxes']             = wpinv_use_taxes();
+        $localize['formNonce']            = wp_create_nonce( 'getpaid_form_nonce' );
+        $localize['loading']              = __( 'Loading...', 'invoicing' );
+        $localize['connectionError']      = __( 'Could not establish a connection to the server.', 'invoicing' );
+        $localize['recaptchaSettings']    = getpaid_get_recaptcha_settings();
+
+        $localize = apply_filters( 'wpinv_front_js_localize', $localize );
+
+        // reCaptcha.
+        if ( getpaid_is_recaptcha_enabled() && ( $recaptcha_js = getpaid_recaptcha_api_url() ) ) {
+            wp_enqueue_script( 'recaptcha', $recaptcha_js, array(), null, true ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion
+        }
+
+        $version = filemtime( WPINV_PLUGIN_DIR . 'assets/js/payment-forms.js' );
+        wp_enqueue_script( 'wpinv-front-script', WPINV_PLUGIN_URL . 'assets/js/payment-forms.js', array( 'jquery' ), $version, true );
+        wp_localize_script( 'wpinv-front-script', 'WPInv', $localize );
+    }
+
+    public function wpinv_actions() {
+        if ( isset( $_REQUEST['wpi_action'] ) ) {
+            do_action( 'wpinv_' . wpinv_sanitize_key( $_REQUEST['wpi_action'] ), $_REQUEST );
+        }
+
+        if ( defined( 'WP_ALL_IMPORT_ROOT_DIR' ) ) {
+            include plugin_dir_path( __FILE__ ) . 'libraries/wp-all-import/class-getpaid-wp-all-import.php';
+        }
+    }
+
+    /**
      * Fires an action after verifying that a user can fire them.
-	 *
-	 * Note: If the action is on an invoice, subscription etc, esure that the
-	 * current user owns the invoice/subscription.
+     *
+     * Note: If the action is on an invoice, subscription etc, esure that the
+     * current user owns the invoice/subscription.
      */
     public function maybe_do_authenticated_action() {
 
-		if ( isset( $_REQUEST['getpaid-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) {
+        if ( isset( $_REQUEST['getpaid-action'] ) && isset( $_REQUEST['getpaid-nonce'] ) && wp_verify_nonce( $_REQUEST['getpaid-nonce'], 'getpaid-nonce' ) ) {
 
-			$key  = sanitize_key( $_REQUEST['getpaid-action'] );
-			$data = wp_unslash( $_REQUEST );
-			if ( is_user_logged_in() ) {
-				do_action( "getpaid_authenticated_action_$key", $data );
-			}
+            $key  = sanitize_key( $_REQUEST['getpaid-action'] );
+            $data = wp_unslash( $_REQUEST );
+            if ( is_user_logged_in() ) {
+                do_action( "getpaid_authenticated_action_$key", $data );
+            }
 
-			do_action( "getpaid_unauthenticated_action_$key", $data );
+            do_action( "getpaid_unauthenticated_action_$key", $data );
+
+        }
 
-		}
+    }
+
+    public function pre_get_posts( $wp_query ) {
+
+        if ( ! is_admin() && ! empty( $wp_query->query_vars['post_type'] ) && getpaid_is_invoice_post_type( $wp_query->query_vars['post_type'] ) && is_user_logged_in() && is_single() && $wp_query->is_main_query() ) {
+            $wp_query->query_vars['post_status'] = array_keys( wpinv_get_invoice_statuses( false, false, $wp_query->query_vars['post_type'] ) );
+        }
 
+        return $wp_query;
     }
 
-	public function pre_get_posts( $wp_query ) {
-
-		if ( ! is_admin() && ! empty( $wp_query->query_vars['post_type'] ) && getpaid_is_invoice_post_type( $wp_query->query_vars['post_type'] ) && is_user_logged_in() && is_single() && $wp_query->is_main_query() ) {
-			$wp_query->query_vars['post_status'] = array_keys( wpinv_get_invoice_statuses( false, false, $wp_query->query_vars['post_type'] ) );
-		}
-
-		return $wp_query;
-	}
-
-	/**
-	 * Register widgets
-	 *
-	 */
-	public function register_widgets() {
-		global $pagenow;
-
-		// Currently, UX Builder does not work particulaly well with SuperDuper.
-		// So we disable our widgets when editing a page with UX Builder.
-		if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) {
-			return;
-		}
-
-		$block_widget_init_screens = function_exists( 'sd_pagenow_exclude' ) ? sd_pagenow_exclude() : array();
-
-		if ( is_admin() && $pagenow && in_array( $pagenow, $block_widget_init_screens ) ) {
-			// don't initiate in these conditions.
-		} else {
-
-			// Only load allowed widgets.
-			$exclude = function_exists( 'sd_widget_exclude' ) ? sd_widget_exclude() : array();
-			$widgets = apply_filters(
-				'getpaid_widget_classes',
-				array(
-					'WPInv_Checkout_Widget',
-					'WPInv_History_Widget',
-					'WPInv_Receipt_Widget',
-					'WPInv_Subscriptions_Widget',
-					'WPInv_Buy_Item_Widget',
-					'WPInv_Messages_Widget',
-					'WPInv_GetPaid_Widget',
-					'WPInv_Invoice_Widget',
-				)
-			);
-
-			// For each widget...
-			foreach ( $widgets as $widget ) {
-
-				// Abort early if it is excluded for this page.
-				if ( in_array( $widget, $exclude ) ) {
-					continue;
-				}
-
-				// SD V1 used to extend the widget class. V2 does not, so we cannot call register widget on it.
-				if ( is_subclass_of( $widget, 'WP_Widget' ) ) {
-					register_widget( $widget );
-				} else {
-					new $widget();
-				}
+    /**
+     * Register widgets
+     *
+     */
+    public function register_widgets() {
+        global $pagenow;
+
+        // Currently, UX Builder does not work particulaly well with SuperDuper.
+        // So we disable our widgets when editing a page with UX Builder.
+        if ( function_exists( 'ux_builder_is_active' ) && ux_builder_is_active() ) {
+            return;
+        }
+
+        $block_widget_init_screens = function_exists( 'sd_pagenow_exclude' ) ? sd_pagenow_exclude() : array();
+
+        if ( is_admin() && $pagenow && in_array( $pagenow, $block_widget_init_screens ) ) {
+            // don't initiate in these conditions.
+        } else {
+
+            // Only load allowed widgets.
+            $exclude = function_exists( 'sd_widget_exclude' ) ? sd_widget_exclude() : array();
+            $widgets = apply_filters(
+                'getpaid_widget_classes',
+                array(
+                    'WPInv_Checkout_Widget',
+                    'WPInv_History_Widget',
+                    'WPInv_Receipt_Widget',
+                    'WPInv_Subscriptions_Widget',
+                    'WPInv_Buy_Item_Widget',
+                    'WPInv_Messages_Widget',
+                    'WPInv_GetPaid_Widget',
+                    'WPInv_Invoice_Widget',
+                )
+            );
+
+            // For each widget...
+            foreach ( $widgets as $widget ) {
+
+                // Abort early if it is excluded for this page.
+                if ( in_array( $widget, $exclude ) ) {
+                    continue;
+                }
+
+                // SD V1 used to extend the widget class. V2 does not, so we cannot call register widget on it.
+                if ( is_subclass_of( $widget, 'WP_Widget' ) ) {
+                    register_widget( $widget );
+                } else {
+                    new $widget();
+                }
 }
 }
 
-	}
+    }
+
+    /**
+     * Upgrades the database.
+     *
+     * @since 2.0.2
+     */
+    public function maybe_upgrade_database() {
+
+        // Ensure the database tables are up to date.
+        GetPaid_Installer::maybe_create_db_tables();
+
+        $wpi_version = get_option( 'wpinv_version', 0 );
+
+        if ( $wpi_version == WPINV_VERSION ) {
+            return;
+        }
+
+        $installer = new GetPaid_Installer();
+
+        if ( empty( $wpi_version ) ) {
+            return $installer->upgrade_db( 0 );
+        }
+
+        $upgrades  = array(
+            '0.0.5' => '004',
+            '1.0.3' => '102',
+            '2.0.0' => '118',
+            '2.8.0' => '279',
+        );
+
+        foreach ( $upgrades as $key => $method ) {
 
-	/**
-	 * Upgrades the database.
-	 *
-	 * @since 2.0.2
-	 */
-	public function maybe_upgrade_database() {
+            if ( version_compare( $wpi_version, $key, '<' ) ) {
+                return $installer->upgrade_db( $method );
+            }
+        }
+
+    }
+
+    /**
+     * Flushes the permalinks if needed.
+     *
+     * @since 2.0.8
+     */
+    public function maybe_flush_permalinks() {
 
-		// Ensure the database tables are up to date.
-		GetPaid_Installer::maybe_create_db_tables();
+        $flush = get_option( 'wpinv_flush_permalinks', 0 );
 
-		$wpi_version = get_option( 'wpinv_version', 0 );
+        if ( ! empty( $flush ) ) {
+            flush_rewrite_rules();
+            delete_option( 'wpinv_flush_permalinks' );
+        }
 
-		if ( $wpi_version == WPINV_VERSION ) {
-			return;
-		}
+    }
 
-		$installer = new GetPaid_Installer();
+    /**
+     * Remove our pages from yoast sitemaps.
+     *
+     * @since 1.0.19
+     * @param int[] $excluded_posts_ids
+     */
+    public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ) {
+
+        // Ensure that we have an array.
+        if ( ! is_array( $excluded_posts_ids ) ) {
+            $excluded_posts_ids = array();
+        }
 
-		if ( empty( $wpi_version ) ) {
-			return $installer->upgrade_db( 0 );
-		}
+        // Prepare our pages.
+        $our_pages = array();
+
+        // Checkout page.
+        $our_pages[] = wpinv_get_option( 'checkout_page', false );
+
+        // Success page.
+        $our_pages[] = wpinv_get_option( 'success_page', false );
+
+        // Failure page.
+        $our_pages[] = wpinv_get_option( 'failure_page', false );
+
+        // History page.
+        $our_pages[] = wpinv_get_option( 'invoice_history_page', false );
+
+        // Subscriptions page.
+        $our_pages[] = wpinv_get_option( 'invoice_subscription_page', false );
+
+        $our_pages   = array_map( 'intval', array_filter( $our_pages ) );
+
+        $excluded_posts_ids = $excluded_posts_ids + $our_pages;
+        return array_unique( $excluded_posts_ids );
+
+    }
 
-		$upgrades  = array(
-			'0.0.5' => '004',
-			'1.0.3' => '102',
-			'2.0.0' => '118',
-			'2.8.0' => '279',
-		);
-
-		foreach ( $upgrades as $key => $method ) {
-
-			if ( version_compare( $wpi_version, $key, '<' ) ) {
-				return $installer->upgrade_db( $method );
-			}
-		}
-
-	}
-
-	/**
-	 * Flushes the permalinks if needed.
-	 *
-	 * @since 2.0.8
-	 */
-	public function maybe_flush_permalinks() {
-
-		$flush = get_option( 'wpinv_flush_permalinks', 0 );
-
-		if ( ! empty( $flush ) ) {
-			flush_rewrite_rules();
-			delete_option( 'wpinv_flush_permalinks' );
-		}
-
-	}
-
-	/**
-	 * Remove our pages from yoast sitemaps.
-	 *
-	 * @since 1.0.19
-	 * @param int[] $excluded_posts_ids
-	 */
-	public function wpseo_exclude_from_sitemap_by_post_ids( $excluded_posts_ids ) {
-
-		// Ensure that we have an array.
-		if ( ! is_array( $excluded_posts_ids ) ) {
-			$excluded_posts_ids = array();
-		}
-
-		// Prepare our pages.
-		$our_pages = array();
-
-		// Checkout page.
-		$our_pages[] = wpinv_get_option( 'checkout_page', false );
-
-		// Success page.
-		$our_pages[] = wpinv_get_option( 'success_page', false );
-
-		// Failure page.
-		$our_pages[] = wpinv_get_option( 'failure_page', false );
-
-		// History page.
-		$our_pages[] = wpinv_get_option( 'invoice_history_page', false );
-
-		// Subscriptions page.
-		$our_pages[] = wpinv_get_option( 'invoice_subscription_page', false );
-
-		$our_pages   = array_map( 'intval', array_filter( $our_pages ) );
-
-		$excluded_posts_ids = $excluded_posts_ids + $our_pages;
-		return array_unique( $excluded_posts_ids );
-
-	}
-
-	/**
-	 * Remove our pages from yoast sitemaps.
-	 *
-	 * @since 1.0.19
-	 * @param string[] $post_types
-	 */
-	public function exclude_invoicing_post_types( $post_types ) {
-
-		// Ensure that we have an array.
-		if ( ! is_array( $post_types ) ) {
-			$post_types = array();
-		}
-
-		// Remove our post types.
-		return array_diff( $post_types, array_keys( getpaid_get_invoice_post_types() ) );
-	}
-
-	/**
-	 * Displays additional footer code.
-	 *
-	 * @since 2.0.0
-	 */
-	public function wp_footer() {
-		wpinv_get_template( 'frontend-footer.php' );
-	}
-
-	/**
-	 * Displays additional header code.
-	 *
-	 * @since 2.0.0
-	 */
-	public function wp_head() {
-		wpinv_get_template( 'frontend-head.php' );
-	}
-
-	/**
-	 * Custom query vars.
-	 *
-	 */
-	public function custom_query_vars( $vars ) {
+    /**
+     * Remove our pages from yoast sitemaps.
+     *
+     * @since 1.0.19
+     * @param string[] $post_types
+     */
+    public function exclude_invoicing_post_types( $post_types ) {
+
+        // Ensure that we have an array.
+        if ( ! is_array( $post_types ) ) {
+            $post_types = array();
+        }
+
+        // Remove our post types.
+        return array_diff( $post_types, array_keys( getpaid_get_invoice_post_types() ) );
+    }
+
+    /**
+     * Displays additional footer code.
+     *
+     * @since 2.0.0
+     */
+    public function wp_footer() {
+        wpinv_get_template( 'frontend-footer.php' );
+    }
+
+    /**
+     * Displays additional header code.
+     *
+     * @since 2.0.0
+     */
+    public function wp_head() {
+        wpinv_get_template( 'frontend-head.php' );
+    }
+
+    /**
+     * Custom query vars.
+     *
+     */
+    public function custom_query_vars( $vars ) {
         $vars[] = 'getpaid-ipn';
         return $vars;
-	}
+    }
 
-	/**
-	 * Add rewrite tags and rules.
-	 *
-	 */
-	public function add_rewrite_rule() {
+    /**
+     * Add rewrite tags and rules.
+     *
+     */
+    public function add_rewrite_rule() {
         $tag = 'getpaid-ipn';
         add_rewrite_tag( "%$tag%", '([^&]+)' );
         add_rewrite_rule( "^$tag/([^/]*)/?", "index.php?$tag=\$matches[1]", 'top' );
-	}
+    }
 
-	/**
-	 * Processes non-query string ipns.
-	 *
-	 */
-	public function maybe_process_new_ipn( $query ) {
+    /**
+     * Processes non-query string ipns.
+     *
+     */
+    public function maybe_process_new_ipn( $query ) {
 
         if ( is_admin() || ! $query->is_main_query() ) {
             return;
         }
 
-		$gateway = get_query_var( 'getpaid-ipn' );
+        $gateway = get_query_var( 'getpaid-ipn' );
 
         if ( ! empty( $gateway ) ) {
 
-			$gateway = sanitize_text_field( $gateway );
-			nocache_headers();
-			do_action( 'wpinv_verify_payment_ipn', $gateway );
-			do_action( "wpinv_verify_{$gateway}_ipn" );
-			exit;
+            $gateway = sanitize_text_field( $gateway );
+            nocache_headers();
+            do_action( 'wpinv_verify_payment_ipn', $gateway );
+            do_action( "wpinv_verify_{$gateway}_ipn" );
+            exit;
 
         }
 
-	}
+    }
 
 }

includes/wpinv-payment-functions.php

Indentation +286 added lines, -286 removed lines

@@ -1,196 +1,196 @@ 
 <?php
 function wpinv_is_subscription_payment( $invoice = '' ) {
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
-		$invoice = wpinv_get_invoice( $invoice );
-	}
+    if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
+        $invoice = wpinv_get_invoice( $invoice );
+    }
 
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( $invoice->is_renewal() ) {
-		return true;
-	}
+    if ( $invoice->is_renewal() ) {
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 function wpinv_payment_link_transaction_id( $invoice = '' ) {
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
-		$invoice = wpinv_get_invoice( $invoice );
-	}
+    if ( ! is_object( $invoice ) && is_scalar( $invoice ) ) {
+        $invoice = wpinv_get_invoice( $invoice );
+    }
 
-	if ( empty( $invoice ) ) {
-		return false;
-	}
+    if ( empty( $invoice ) ) {
+        return false;
+    }
 
-	return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice );
+    return apply_filters( 'wpinv_payment_details_transaction_id-' . $invoice->gateway, $invoice->get_transaction_id(), $invoice->ID, $invoice );
 }
 
 function wpinv_subscription_initial_payment_desc( $amount, $period, $interval, $trial_period = '', $trial_interval = 0 ) {
-	$interval   = (int)$interval > 0 ? (int)$interval : 1;
-
-	if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
-		$amount = __( 'Free', 'invoicing' );
-		$interval = $trial_interval;
-		$period = $trial_period;
-	}
-
-	$description = '';
-	switch ( $period ) {
-		case 'D':
-		case 'day':
-			$description = wp_sprintf( _n( '%s for the first day.', '%1$s for the first %2$d days.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'W':
-		case 'week':
-			$description = wp_sprintf( _n( '%s for the first week.', '%1$s for the first %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'M':
-		case 'month':
-			$description = wp_sprintf( _n( '%s for the first month.', '%1$s for the first %2$d months.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-		case 'Y':
-		case 'year':
-			$description = wp_sprintf( _n( '%s for the first year.', '%1$s for the first %2$d years.', $interval, 'invoicing' ), $amount, $interval );
-			break;
-	}
-
-	return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval );
+    $interval   = (int)$interval > 0 ? (int)$interval : 1;
+
+    if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
+        $amount = __( 'Free', 'invoicing' );
+        $interval = $trial_interval;
+        $period = $trial_period;
+    }
+
+    $description = '';
+    switch ( $period ) {
+        case 'D':
+        case 'day':
+            $description = wp_sprintf( _n( '%s for the first day.', '%1$s for the first %2$d days.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'W':
+        case 'week':
+            $description = wp_sprintf( _n( '%s for the first week.', '%1$s for the first %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'M':
+        case 'month':
+            $description = wp_sprintf( _n( '%s for the first month.', '%1$s for the first %2$d months.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+        case 'Y':
+        case 'year':
+            $description = wp_sprintf( _n( '%s for the first year.', '%1$s for the first %2$d years.', $interval, 'invoicing' ), $amount, $interval );
+            break;
+    }
+
+    return apply_filters( 'wpinv_subscription_initial_payment_desc', $description, $amount, $period, $interval, $trial_period, $trial_interval );
 }
 
 function wpinv_subscription_recurring_payment_desc( $amount, $period, $interval, $bill_times = 0, $trial_period = '', $trial_interval = 0 ) {
-	$interval   = (int)$interval > 0 ? (int)$interval : 1;
-	$bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0;
-
-	$description = '';
-	switch ( $period ) {
-		case 'D':
-		case 'day':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d days, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d days.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one day.', '%1$s for each day, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each day.', '%1$s for each %2$d days.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'W':
-		case 'week':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d weeks, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d weeks.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one week.', '%1$s for each week, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each week.', '%1$s for each %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'M':
-		case 'month':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d months, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d months.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one month.', '%1$s for each month, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each month.', '%1$s for each %2$d months.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-		case 'Y':
-		case 'year':
-			if ( (int)$bill_times > 0 ) {
-				if ( $interval > 1 ) {
-					if ( $bill_times > 1 ) {
-						$description = wp_sprintf( __( '%1$s for each %2$d years, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
-					} else {
-						$description = wp_sprintf( __( '%1$s for %2$d years.', 'invoicing' ), $amount, $interval );
-					}
-				} else {
-					$description = wp_sprintf( _n( '%s for one year.', '%1$s for each year, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
-				}
-			} else {
-				$description = wp_sprintf( _n( '%s for each year.', '%1$s for each %2$d years.', $interval, 'invoicing' ), $amount, $interval );
-			}
-			break;
-	}
-
-	return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
+    $interval   = (int)$interval > 0 ? (int)$interval : 1;
+    $bill_times = (int)$bill_times > 0 ? (int)$bill_times : 0;
+
+    $description = '';
+    switch ( $period ) {
+        case 'D':
+        case 'day':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d days, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d days.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one day.', '%1$s for each day, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each day.', '%1$s for each %2$d days.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'W':
+        case 'week':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d weeks, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d weeks.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one week.', '%1$s for each week, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each week.', '%1$s for each %2$d weeks.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'M':
+        case 'month':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d months, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d months.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one month.', '%1$s for each month, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each month.', '%1$s for each %2$d months.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+        case 'Y':
+        case 'year':
+            if ( (int)$bill_times > 0 ) {
+                if ( $interval > 1 ) {
+                    if ( $bill_times > 1 ) {
+                        $description = wp_sprintf( __( '%1$s for each %2$d years, for %3$d installments.', 'invoicing' ), $amount, $interval, $bill_times );
+                    } else {
+                        $description = wp_sprintf( __( '%1$s for %2$d years.', 'invoicing' ), $amount, $interval );
+                    }
+                } else {
+                    $description = wp_sprintf( _n( '%s for one year.', '%1$s for each year, for %2$d installments.', $bill_times, 'invoicing' ), $amount, $bill_times );
+                }
+            } else {
+                $description = wp_sprintf( _n( '%s for each year.', '%1$s for each %2$d years.', $interval, 'invoicing' ), $amount, $interval );
+            }
+            break;
+    }
+
+    return apply_filters( 'wpinv_subscription_recurring_payment_desc', $description, $amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
 }
 
 function wpinv_subscription_payment_desc( $invoice ) {
-	if ( empty( $invoice ) ) {
-		return null;
-	}
-
-	$description = '';
-	if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) {
-		if ( $item->has_free_trial() ) {
-			$trial_period = $item->get_trial_period();
-			$trial_interval = $item->get_trial_interval();
-		} else {
-			$trial_period = '';
-			$trial_interval = 0;
-		}
-
-		$description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() );
-	}
-
-	return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice );
+    if ( empty( $invoice ) ) {
+        return null;
+    }
+
+    $description = '';
+    if ( $invoice->is_parent() && $item = $invoice->get_recurring( true ) ) {
+        if ( $item->has_free_trial() ) {
+            $trial_period = $item->get_trial_period();
+            $trial_interval = $item->get_trial_interval();
+        } else {
+            $trial_period = '';
+            $trial_interval = 0;
+        }
+
+        $description = wpinv_get_billing_cycle( $invoice->get_total(), $invoice->get_recurring_details( 'total' ), $item->get_recurring_period(), $item->get_recurring_interval(), $item->get_recurring_limit(), $trial_period, $trial_interval, $invoice->get_currency() );
+    }
+
+    return apply_filters( 'wpinv_subscription_payment_desc', $description, $invoice );
 }
 
 function wpinv_get_billing_cycle( $initial, $recurring, $period, $interval, $bill_times, $trial_period = '', $trial_interval = 0, $currency = '' ) {
-	$initial_total      = wpinv_round_amount( $initial );
-	$recurring_total    = wpinv_round_amount( $recurring );
+    $initial_total      = wpinv_round_amount( $initial );
+    $recurring_total    = wpinv_round_amount( $recurring );
 
-	if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
-		// Free trial
-	} else {
-		if ( $bill_times == 1 ) {
-			$recurring_total = $initial_total;
-		} elseif ( $bill_times > 1 && $initial_total != $recurring_total ) {
-			$bill_times--;
-		}
-	}
+    if ( $trial_interval > 0 && ! empty( $trial_period ) ) {
+        // Free trial
+    } else {
+        if ( $bill_times == 1 ) {
+            $recurring_total = $initial_total;
+        } elseif ( $bill_times > 1 && $initial_total != $recurring_total ) {
+            $bill_times--;
+        }
+    }
 
-	$initial_amount     = wpinv_price( $initial_total, $currency );
-	$recurring_amount   = wpinv_price( $recurring_total, $currency );
+    $initial_amount     = wpinv_price( $initial_total, $currency );
+    $recurring_amount   = wpinv_price( $recurring_total, $currency );
 
-	$recurring          = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
+    $recurring          = wpinv_subscription_recurring_payment_desc( $recurring_amount, $period, $interval, $bill_times, $trial_period, $trial_interval );
 
-	if ( $initial_total != $recurring_total ) {
-		$initial        = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval );
+    if ( $initial_total != $recurring_total ) {
+        $initial        = wpinv_subscription_initial_payment_desc( $initial_amount, $period, $interval, $trial_period, $trial_interval );
 
-		$description    = wp_sprintf( __( '%1$s Then %2$s', 'invoicing' ), $initial, $recurring );
-	} else {
-		$description    = $recurring;
-	}
+        $description    = wp_sprintf( __( '%1$s Then %2$s', 'invoicing' ), $initial, $recurring );
+    } else {
+        $description    = $recurring;
+    }
 
-	return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency );
+    return apply_filters( 'wpinv_get_billing_cycle', $description, $initial, $recurring, $period, $interval, $bill_times, $trial_period, $trial_interval, $currency );
 }
 
 /**
@@ -202,25 +202,25 @@ 
  */
 function getpaid_get_card_name( $card_number ) {
 
-	// Known regexes.
-	$regexes = array(
-		'/^4/'                     => __( 'Visa', 'invoicing' ),
-		'/^5[1-5]/'                => __( 'Mastercard', 'invoicing' ),
-		'/^3[47]/'                 => __( 'Amex', 'invoicing' ),
-		'/^3(?:0[0-5]|[68])/'      => __( 'Diners Club', 'invoicing' ),
-		'/^6(?:011|5)/'            => __( 'Discover', 'invoicing' ),
-		'/^(?:2131|1800|35\d{3})/' => __( 'JCB', 'invoicing' ),
-	);
-
-	// Confirm if one matches.
-	foreach ( $regexes as $regex => $card ) {
-		if ( preg_match( $regex, $card_number ) >= 1 ) {
-			return $card;
-		}
-	}
-
-	// None matched.
-	return __( 'Card', 'invoicing' );
+    // Known regexes.
+    $regexes = array(
+        '/^4/'                     => __( 'Visa', 'invoicing' ),
+        '/^5[1-5]/'                => __( 'Mastercard', 'invoicing' ),
+        '/^3[47]/'                 => __( 'Amex', 'invoicing' ),
+        '/^3(?:0[0-5]|[68])/'      => __( 'Diners Club', 'invoicing' ),
+        '/^6(?:011|5)/'            => __( 'Discover', 'invoicing' ),
+        '/^(?:2131|1800|35\d{3})/' => __( 'JCB', 'invoicing' ),
+    );
+
+    // Confirm if one matches.
+    foreach ( $regexes as $regex => $card ) {
+        if ( preg_match( $regex, $card_number ) >= 1 ) {
+            return $card;
+        }
+    }
+
+    // None matched.
+    return __( 'Card', 'invoicing' );
 
 }
 
@@ -230,24 +230,24 @@ 
  * @param WPInv_Invoice|int|null $invoice
  */
 function wpinv_send_back_to_checkout( $invoice = null ) {
-	$response = array( 'success' => false );
-	$invoice  = wpinv_get_invoice( $invoice );
-
-	// Was an invoice created?
-	if ( ! empty( $invoice ) ) {
-		$invoice             = is_scalar( $invoice ) ? new WPInv_Invoice( $invoice ) : $invoice;
-		$response['invoice'] = $invoice->get_id();
-		do_action( 'getpaid_checkout_invoice_exception', $invoice );
-	}
-
-	// Do we have any errors?
-	if ( wpinv_get_errors() ) {
-		$response['data'] = getpaid_get_errors_html( true, false );
-	} else {
-		$response['data'] = __( 'An error occured while processing your payment. Please try again.', 'invoicing' );
-	}
-
-	wp_send_json( $response );
+    $response = array( 'success' => false );
+    $invoice  = wpinv_get_invoice( $invoice );
+
+    // Was an invoice created?
+    if ( ! empty( $invoice ) ) {
+        $invoice             = is_scalar( $invoice ) ? new WPInv_Invoice( $invoice ) : $invoice;
+        $response['invoice'] = $invoice->get_id();
+        do_action( 'getpaid_checkout_invoice_exception', $invoice );
+    }
+
+    // Do we have any errors?
+    if ( wpinv_get_errors() ) {
+        $response['data'] = getpaid_get_errors_html( true, false );
+    } else {
+        $response['data'] = __( 'An error occured while processing your payment. Please try again.', 'invoicing' );
+    }
+
+    wp_send_json( $response );
 }
 
 /**
@@ -256,7 +256,7 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_site_key() {
-	return apply_filters( 'getpaid_recaptcha_site_key', wpinv_get_option( 'recaptcha_site_key', '' ) );
+    return apply_filters( 'getpaid_recaptcha_site_key', wpinv_get_option( 'recaptcha_site_key', '' ) );
 }
 
 /**
@@ -265,7 +265,7 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_secret_key() {
-	return apply_filters( 'getpaid_recaptcha_secret_key', wpinv_get_option( 'recaptcha_secret_key', '' ) );
+    return apply_filters( 'getpaid_recaptcha_secret_key', wpinv_get_option( 'recaptcha_secret_key', '' ) );
 }
 
 /**
@@ -274,7 +274,7 @@ 
  * @return bool
  */
 function getpaid_is_recaptcha_enabled() {
-	return wpinv_get_option( 'enable_recaptcha', false ) && getpaid_get_recaptcha_site_key() && getpaid_get_recaptcha_secret_key();
+    return wpinv_get_option( 'enable_recaptcha', false ) && getpaid_get_recaptcha_site_key() && getpaid_get_recaptcha_secret_key();
 }
 
 /**
@@ -283,27 +283,27 @@ 
  * @return string
  */
 function getpaid_get_recaptcha_version() {
-	return apply_filters( 'getpaid_recaptcha_version', wpinv_get_option( 'recaptcha_version', 'v2' ) );
+    return apply_filters( 'getpaid_recaptcha_version', wpinv_get_option( 'recaptcha_version', 'v2' ) );
 }
 
 function getpaid_recaptcha_api_url() {
-	// Prevent conflicts with Ninja Forms recaptcha.
-	if ( ! empty( $_REQUEST['action'] ) && $_REQUEST['action'] == 'geodir_ninja_forms' ) {
-		$url = '';
-	} else {
-		$url = getpaid_recaptcha_get_api_url();
-	}
-
-	return apply_filters( 'getpaid_recaptcha_api_url', $url );
+    // Prevent conflicts with Ninja Forms recaptcha.
+    if ( ! empty( $_REQUEST['action'] ) && $_REQUEST['action'] == 'geodir_ninja_forms' ) {
+        $url = '';
+    } else {
+        $url = getpaid_recaptcha_get_api_url();
+    }
+
+    return apply_filters( 'getpaid_recaptcha_api_url', $url );
 }
 
 function getpaid_recaptcha_get_api_url() {
-	return add_query_arg(
-		array(
-			'render' => 'v2' === getpaid_get_recaptcha_version() ? 'explicit' : getpaid_get_recaptcha_site_key(),
-		),
-		'https://www.google.com/recaptcha/api.js'
-	);
+    return add_query_arg(
+        array(
+            'render' => 'v2' === getpaid_get_recaptcha_version() ? 'explicit' : getpaid_get_recaptcha_site_key(),
+        ),
+        'https://www.google.com/recaptcha/api.js'
+    );
 }
 
 /**
@@ -312,42 +312,42 @@ 
  * @return array
  */
 function getpaid_get_recaptcha_settings() {
-	$settings = array(
-		'enabled' => getpaid_is_recaptcha_enabled(),
-		'version' => getpaid_get_recaptcha_version(),
-	);
-
-	if ( ! getpaid_is_recaptcha_enabled() ) {
-		return $settings;
-	}
-
-	$settings['sitekey'] = getpaid_get_recaptcha_site_key();
-
-	// Version 2 render params.
-	if ( 'v2' === getpaid_get_recaptcha_version() ) {
-		$settings['render_params'] = array(
-			'sitekey'  => getpaid_get_recaptcha_site_key(),
-			'theme'    => 'light',
-			'size'     => 'normal',
-			'tabindex' => 0,
-		);
-	}
-
-	return apply_filters( 'getpaid_recaptcha_settings', $settings );
+    $settings = array(
+        'enabled' => getpaid_is_recaptcha_enabled(),
+        'version' => getpaid_get_recaptcha_version(),
+    );
+
+    if ( ! getpaid_is_recaptcha_enabled() ) {
+        return $settings;
+    }
+
+    $settings['sitekey'] = getpaid_get_recaptcha_site_key();
+
+    // Version 2 render params.
+    if ( 'v2' === getpaid_get_recaptcha_version() ) {
+        $settings['render_params'] = array(
+            'sitekey'  => getpaid_get_recaptcha_site_key(),
+            'theme'    => 'light',
+            'size'     => 'normal',
+            'tabindex' => 0,
+        );
+    }
+
+    return apply_filters( 'getpaid_recaptcha_settings', $settings );
 }
 
 /**
  * Displays reCAPTCHA before payment button.
  */
 function getpaid_display_recaptcha_before_payment_button() {
-	if ( ! getpaid_is_recaptcha_enabled() || 'v2' !== getpaid_get_recaptcha_version() ) {
-		return;
-	}
-
-	printf(
-		'<div class="getpaid-recaptcha-wrapper"><div class="g-recaptcha mw-100 overflow-hidden my-2" id="getpaid-recaptcha-%s"></div></div>',
-		esc_attr( wp_unique_id() )
-	);
+    if ( ! getpaid_is_recaptcha_enabled() || 'v2' !== getpaid_get_recaptcha_version() ) {
+        return;
+    }
+
+    printf(
+        '<div class="getpaid-recaptcha-wrapper"><div class="g-recaptcha mw-100 overflow-hidden my-2" id="getpaid-recaptcha-%s"></div></div>',
+        esc_attr( wp_unique_id() )
+    );
 }
 add_action( 'getpaid_before_payment_form_pay_button', 'getpaid_display_recaptcha_before_payment_button' );
 
@@ -358,43 +358,43 @@ 
  */
 function getpaid_validate_recaptcha_response( $submission ) {
 
-	// Check if reCAPTCHA is enabled.
-	if ( ! getpaid_is_recaptcha_enabled() ) {
-		return;
-	}
-
-	$token = $submission->get_field( 'g-recaptcha-response' );
-
-	// Abort if no token was provided.
-	if ( empty( $token ) ) {
-		wp_send_json_error( 'v2' === getpaid_get_recaptcha_version() ? __( 'Please confirm that you are not a robot.', 'invoicing' ) : __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
-
-	$result = wp_remote_post(
-		'https://www.google.com/recaptcha/api/siteverify',
-		array(
-			'body' => array(
-				'secret'   => getpaid_get_recaptcha_secret_key(),
-				'response' => $token,
-			),
-		)
-	);
-
-	// Site not reachable, give benefit of doubt.
-	if ( is_wp_error( $result ) ) {
-		return;
-	}
-
-	$result = json_decode( wp_remote_retrieve_body( $result ), true );
-
-	if ( empty( $result['success'] ) && ! in_array( 'missing-input-secret', $result['error-codes'], true ) && ! in_array( 'invalid-input-secret', $result['error-codes'], true ) ) {
-		wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
-
-	// For v3, check the score.
-	$minimum_score = apply_filters( 'getpaid_recaptcha_minimum_score', 0.4 );
-	if ( 'v3' === getpaid_get_recaptcha_version() && ( empty( $result['score'] ) || $result['score'] < $minimum_score ) ) {
-		wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
-	}
+    // Check if reCAPTCHA is enabled.
+    if ( ! getpaid_is_recaptcha_enabled() ) {
+        return;
+    }
+
+    $token = $submission->get_field( 'g-recaptcha-response' );
+
+    // Abort if no token was provided.
+    if ( empty( $token ) ) {
+        wp_send_json_error( 'v2' === getpaid_get_recaptcha_version() ? __( 'Please confirm that you are not a robot.', 'invoicing' ) : __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
+
+    $result = wp_remote_post(
+        'https://www.google.com/recaptcha/api/siteverify',
+        array(
+            'body' => array(
+                'secret'   => getpaid_get_recaptcha_secret_key(),
+                'response' => $token,
+            ),
+        )
+    );
+
+    // Site not reachable, give benefit of doubt.
+    if ( is_wp_error( $result ) ) {
+        return;
+    }
+
+    $result = json_decode( wp_remote_retrieve_body( $result ), true );
+
+    if ( empty( $result['success'] ) && ! in_array( 'missing-input-secret', $result['error-codes'], true ) && ! in_array( 'invalid-input-secret', $result['error-codes'], true ) ) {
+        wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
+
+    // For v3, check the score.
+    $minimum_score = apply_filters( 'getpaid_recaptcha_minimum_score', 0.4 );
+    if ( 'v3' === getpaid_get_recaptcha_version() && ( empty( $result['score'] ) || $result['score'] < $minimum_score ) ) {
+        wp_send_json_error( __( "Unable to verify that you're not a robot. Please try again.", 'invoicing' ) );
+    }
 }
 add_action( 'getpaid_checkout_error_checks', 'getpaid_validate_recaptcha_response' );

includes/class-getpaid-template.php

Indentation +152 added lines, -152 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -20,29 +20,29 @@ 
     public $templates_url;
 
     /**
-	 * Class constructor.
-	 *
-	 * @since 1.0.19
-	 */
-	public function __construct() {
+     * Class constructor.
+     *
+     * @since 1.0.19
+     */
+    public function __construct() {
 
         $this->templates_dir = apply_filters( 'getpaid_default_templates_dir', WPINV_PLUGIN_DIR . 'templates' );
         $this->templates_url = apply_filters( 'getpaid_default_templates_url', WPINV_PLUGIN_URL . 'templates' );
 
         // Oxygen plugin
-		if ( defined( 'CT_VERSION' ) ) {
-			add_filter( 'wpinv_locate_template', array( $this, 'oxygen_override_template' ), 11, 4 );
-		}
+        if ( defined( 'CT_VERSION' ) ) {
+            add_filter( 'wpinv_locate_template', array( $this, 'oxygen_override_template' ), 11, 4 );
+        }
 
     }
 
     /**
-	 * Checks if this is a preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_preview() {
+     * Checks if this is a preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_preview() {
         return $this->is_divi_preview() ||
             $this->is_elementor_preview() ||
             $this->is_beaver_preview() ||
@@ -53,73 +53,73 @@ 
     }
 
     /**
-	 * Checks if this is an elementor preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_elementor_preview() {
-		return isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' );
-	}
-
-	/**
-	 * Checks if this is a DIVI preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_divi_preview() {
-		return isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'et_pb' );
-	}
-
-	/**
-	 * Checks if this is a beaver builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_beaver_preview() {
-		return isset( $_REQUEST['fl_builder'] );
-	}
-
-	/**
-	 * Checks if this is a siteorigin builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_siteorigin_preview() {
-		return ! empty( $_REQUEST['siteorigin_panels_live_editor'] );
-	}
-
-	/**
-	 * Checks if this is a cornerstone builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_cornerstone_preview() {
-		return ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint';
-	}
-
-	/**
-	 * Checks if this is a fusion builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_fusion_preview() {
-		return ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] );
-	}
-
-	/**
-	 * Checks if this is an oxygen builder preview page
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	public function is_oxygen_preview() {
-		return ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === 'oxy_render_' || substr( $_REQUEST['action'], 0, 10 ) === 'ct_render_' ) );
+     * Checks if this is an elementor preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_elementor_preview() {
+        return isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' );
+    }
+
+    /**
+     * Checks if this is a DIVI preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_divi_preview() {
+        return isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'et_pb' );
+    }
+
+    /**
+     * Checks if this is a beaver builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_beaver_preview() {
+        return isset( $_REQUEST['fl_builder'] );
+    }
+
+    /**
+     * Checks if this is a siteorigin builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_siteorigin_preview() {
+        return ! empty( $_REQUEST['siteorigin_panels_live_editor'] );
+    }
+
+    /**
+     * Checks if this is a cornerstone builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_cornerstone_preview() {
+        return ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint';
+    }
+
+    /**
+     * Checks if this is a fusion builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_fusion_preview() {
+        return ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] );
+    }
+
+    /**
+     * Checks if this is an oxygen builder preview page
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    public function is_oxygen_preview() {
+        return ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === 'oxy_render_' || substr( $_REQUEST['action'], 0, 10 ) === 'ct_render_' ) );
     }
 
     /**
@@ -129,7 +129,7 @@ 
      * @param string $template_path The template path relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function locate_template( $template_name, $template_path = '', $default_path = '' ) {
+    public function locate_template( $template_name, $template_path = '', $default_path = '' ) {
 
         // Load the defaults for the template path and default path.
         $template_path = empty( $template_path ) ? 'invoicing' : $template_path;
@@ -150,22 +150,22 @@ 
     }
 
     /**
-	 * Loads a template
-	 *
-	 * @since 1.0.19
-	 * @return bool
-	 */
-	protected function load_template( $template_name, $template_path, $args ) {
+     * Loads a template
+     *
+     * @since 1.0.19
+     * @return bool
+     */
+    protected function load_template( $template_name, $template_path, $args ) {
 
         if ( is_array( $args ) ) {
             extract( $args );
         }
 
         // Fires before loading a template.
-	    do_action( 'wpinv_before_template_part', $template_name, $template_path, $args );
+        do_action( 'wpinv_before_template_part', $template_name, $template_path, $args );
 
         // Load the template.
-	    include $template_path;
+        include $template_path;
 
         // Fires after loading a template.
         do_action( 'wpinv_after_template_part', $template_name, $template_path, $args );
@@ -182,7 +182,7 @@ 
      * @param string $template_path The templates directory relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function display_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
+    public function display_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
 
         // Locate the template.
         $located = $this->locate_template( $template_name, $template_path, $default_path );
@@ -207,74 +207,74 @@ 
      * @param string $template_path The templates directory relative to the theme's root dir. Defaults to 'invoicing'.
      * @param string $default_path The root path to the default template. Defaults to invoicing/templates
      */
-	public function get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
+    public function get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
         ob_start();
         $this->display_template( $template_name, $args, $template_path, $default_path );
         return ob_get_clean();
     }
 
     /**
-	 * Get the GetPaid templates theme path.
-	 *
-	 *
-	 * @return string Template path.
-	 */
-	public static function get_theme_template_path() {
-		$template   = get_template();
-		$theme_root = get_theme_root( $template );
-
-		return $theme_root . '/' . $template . '/' . untrailingslashit( wpinv_get_theme_template_dir_name() );
-
-	}
-
-	/**
-	 * Oxygen locate theme template.
-	 *
-	 * @param string $template The template.
-	 * @return string The theme template.
-	 */
-	public static function oxygen_locate_template( $template ) {
-
-		if ( empty( $template ) ) {
-			return '';
-		}
-
-		$has_filter = has_filter( 'template', 'ct_oxygen_template_name' );
-
-		// Remove template filter
-		if ( $has_filter ) {
-			remove_filter( 'template', 'ct_oxygen_template_name' );
-		}
-
-		$template = self::get_theme_template_path() . '/' . $template;
-
-		if ( ! file_exists( $template ) ) {
-			$template = '';
-		}
-
-		// Add template filter
-		if ( $has_filter ) {
-			add_filter( 'template', 'ct_oxygen_template_name' );
-		}
-
-		return $template;
-	}
-
-	/**
-	 * Oxygen override theme template.
-	 *
-	 * @param string $located Located template.
-	 * @param string $template_name Template name.
-	 * @return string Located template.
-	 */
-	public function oxygen_override_template( $located, $template_name ) {
+     * Get the GetPaid templates theme path.
+     *
+     *
+     * @return string Template path.
+     */
+    public static function get_theme_template_path() {
+        $template   = get_template();
+        $theme_root = get_theme_root( $template );
+
+        return $theme_root . '/' . $template . '/' . untrailingslashit( wpinv_get_theme_template_dir_name() );
+
+    }
+
+    /**
+     * Oxygen locate theme template.
+     *
+     * @param string $template The template.
+     * @return string The theme template.
+     */
+    public static function oxygen_locate_template( $template ) {
+
+        if ( empty( $template ) ) {
+            return '';
+        }
+
+        $has_filter = has_filter( 'template', 'ct_oxygen_template_name' );
+
+        // Remove template filter
+        if ( $has_filter ) {
+            remove_filter( 'template', 'ct_oxygen_template_name' );
+        }
+
+        $template = self::get_theme_template_path() . '/' . $template;
+
+        if ( ! file_exists( $template ) ) {
+            $template = '';
+        }
+
+        // Add template filter
+        if ( $has_filter ) {
+            add_filter( 'template', 'ct_oxygen_template_name' );
+        }
+
+        return $template;
+    }
+
+    /**
+     * Oxygen override theme template.
+     *
+     * @param string $located Located template.
+     * @param string $template_name Template name.
+     * @return string Located template.
+     */
+    public function oxygen_override_template( $located, $template_name ) {
 
         $oxygen_overide = self::oxygen_locate_template( $template_name );
-		if ( ! empty( $oxygen_overide ) ) {
-			return $oxygen_overide;
-		}
+        if ( ! empty( $oxygen_overide ) ) {
+            return $oxygen_overide;
+        }
 
-		return $located;
-	}
+        return $located;
+    }
 
 }

includes/gateways/class-getpaid-paypal-gateway-ipn-handler.php

Indentation +405 added lines, -405 removed lines

@@ -12,482 +12,482 @@
  */
 class GetPaid_Paypal_Gateway_IPN_Handler {
 
-	/**
-	 * Payment method id.
-	 *
-	 * @var string
-	 */
-	protected $id = 'paypal';
-
-	/**
-	 * Payment method object.
-	 *
-	 * @var GetPaid_Paypal_Gateway
-	 */
-	protected $gateway;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param GetPaid_Paypal_Gateway $gateway
-	 */
-	public function __construct( $gateway ) {
-		$this->gateway = $gateway;
-		$this->verify_ipn();
-	}
-
-	/**
-	 * Processes ipns and marks payments as complete.
-	 *
-	 * @return void
-	 */
-	public function verify_ipn() {
-
-		wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
-
-		// Validate the IPN.
-		if ( empty( $_POST ) || ! $this->validate_ipn() ) {
-			wp_die( 'PayPal IPN Request Failure', 500 );
-		}
-
-		// Process the IPN.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		// Abort if it was not paid by our gateway.
-		if ( $this->id != $invoice->get_gateway() ) {
-			wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
-			wp_die( 'Invoice not paid via PayPal', 200 );
-		}
-
-		$posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
-		$posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
-
-		wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
-		wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
-
-		if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
-			call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
-			wpinv_error_log( 'Done processing IPN', false );
-			wp_die( 'Processed', 200 );
-		}
-
-		wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
-		wp_die( 'Unsupported IPN type', 200 );
-
-	}
-
-	/**
-	 * Retrieves IPN Invoice.
-	 *
-	 * @param array $posted
-	 * @return WPInv_Invoice
-	 */
-	protected function get_ipn_invoice( $posted ) {
-
-		wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
-
-		if ( ! empty( $posted['custom'] ) ) {
-			$invoice = new WPInv_Invoice( $posted['custom'] );
-
-			if ( $invoice->exists() ) {
-				wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
-				return $invoice;
-			}
-		}
-
-		wpinv_error_log( 'Could not retrieve the associated invoice.', false );
-		wp_die( 'Could not retrieve the associated invoice.', 200 );
-	}
-
-	/**
-	 * Check PayPal IPN validity.
-	 */
-	protected function validate_ipn() {
-
-		wpinv_error_log( 'Validating PayPal IPN response', false );
-
-		// Retrieve the associated invoice.
-		$posted  = wp_unslash( $_POST );
-		$invoice = $this->get_ipn_invoice( $posted );
-
-		if ( $this->gateway->is_sandbox( $invoice ) ) {
-			wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
-		}
-
-		// Validate the IPN.
-		$posted['cmd'] = '_notify-validate';
-
-		// Send back post vars to paypal.
-		$params = array(
-			'body'        => $posted,
-			'timeout'     => 60,
-			'httpversion' => '1.1',
-			'compress'    => false,
-			'decompress'  => false,
-			'user-agent'  => 'GetPaid/' . WPINV_VERSION,
-		);
-
-		// Post back to get a response.
-		$response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
-
-		// Check to see if the request was valid.
-		if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
-			$invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
-			wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
-			return true;
-		}
-
-		$invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
-
-		if ( is_wp_error( $response ) ) {
-			$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
-			wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
-			return false;
-		}
-
-		$invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
-		wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
-		return false;
-
-	}
-
-	/**
-	 * Check currency from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $currency currency to validate.
-	 */
-	protected function validate_ipn_currency( $invoice, $currency ) {
+    /**
+     * Payment method id.
+     *
+     * @var string
+     */
+    protected $id = 'paypal';
+
+    /**
+     * Payment method object.
+     *
+     * @var GetPaid_Paypal_Gateway
+     */
+    protected $gateway;
+
+    /**
+     * Class constructor.
+     *
+     * @param GetPaid_Paypal_Gateway $gateway
+     */
+    public function __construct( $gateway ) {
+        $this->gateway = $gateway;
+        $this->verify_ipn();
+    }
+
+    /**
+     * Processes ipns and marks payments as complete.
+     *
+     * @return void
+     */
+    public function verify_ipn() {
+
+        wpinv_error_log( 'GetPaid PayPal IPN Handler', false );
+
+        // Validate the IPN.
+        if ( empty( $_POST ) || ! $this->validate_ipn() ) {
+            wp_die( 'PayPal IPN Request Failure', 500 );
+        }
+
+        // Process the IPN.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        // Abort if it was not paid by our gateway.
+        if ( $this->id != $invoice->get_gateway() ) {
+            wpinv_error_log( 'Aborting, Invoice was not paid via PayPal', false );
+            wp_die( 'Invoice not paid via PayPal', 200 );
+        }
+
+        $posted['payment_status'] = isset( $posted['payment_status'] ) ? sanitize_key( strtolower( $posted['payment_status'] ) ) : '';
+        $posted['txn_type']       = sanitize_key( strtolower( $posted['txn_type'] ) );
+
+        wpinv_error_log( 'Payment status:' . $posted['payment_status'], false );
+        wpinv_error_log( 'IPN Type:' . $posted['txn_type'], false );
+
+        if ( method_exists( $this, 'ipn_txn_' . $posted['txn_type'] ) ) {
+            call_user_func( array( $this, 'ipn_txn_' . $posted['txn_type'] ), $invoice, $posted );
+            wpinv_error_log( 'Done processing IPN', false );
+            wp_die( 'Processed', 200 );
+        }
+
+        wpinv_error_log( 'Aborting, Unsupported IPN type:' . $posted['txn_type'], false );
+        wp_die( 'Unsupported IPN type', 200 );
+
+    }
+
+    /**
+     * Retrieves IPN Invoice.
+     *
+     * @param array $posted
+     * @return WPInv_Invoice
+     */
+    protected function get_ipn_invoice( $posted ) {
+
+        wpinv_error_log( 'Retrieving PayPal IPN Response Invoice', false );
+
+        if ( ! empty( $posted['custom'] ) ) {
+            $invoice = new WPInv_Invoice( $posted['custom'] );
+
+            if ( $invoice->exists() ) {
+                wpinv_error_log( 'Found invoice #' . $invoice->get_number(), false );
+                return $invoice;
+            }
+        }
+
+        wpinv_error_log( 'Could not retrieve the associated invoice.', false );
+        wp_die( 'Could not retrieve the associated invoice.', 200 );
+    }
+
+    /**
+     * Check PayPal IPN validity.
+     */
+    protected function validate_ipn() {
+
+        wpinv_error_log( 'Validating PayPal IPN response', false );
+
+        // Retrieve the associated invoice.
+        $posted  = wp_unslash( $_POST );
+        $invoice = $this->get_ipn_invoice( $posted );
+
+        if ( $this->gateway->is_sandbox( $invoice ) ) {
+            wpinv_error_log( $posted, 'Invoice was processed in sandbox hence logging the posted data', false );
+        }
+
+        // Validate the IPN.
+        $posted['cmd'] = '_notify-validate';
+
+        // Send back post vars to paypal.
+        $params = array(
+            'body'        => $posted,
+            'timeout'     => 60,
+            'httpversion' => '1.1',
+            'compress'    => false,
+            'decompress'  => false,
+            'user-agent'  => 'GetPaid/' . WPINV_VERSION,
+        );
+
+        // Post back to get a response.
+        $response = wp_safe_remote_post( $this->gateway->is_sandbox( $invoice ) ? 'https://www.sandbox.paypal.com/cgi-bin/webscr' : 'https://www.paypal.com/cgi-bin/webscr', $params );
+
+        // Check to see if the request was valid.
+        if ( ! is_wp_error( $response ) && $response['response']['code'] < 300 && strstr( $response['body'], 'VERIFIED' ) ) {
+            $invoice->add_note( 'Received valid response from PayPal IPN: ' . $response['body'], false, false, true );
+            wpinv_error_log( 'Received valid response from PayPal IPN: ' . $response['body'], false );
+            return true;
+        }
+
+        $invoice->add_note( 'IPN message:' . wp_json_encode( $posted ), false, false, true );
+
+        if ( is_wp_error( $response ) ) {
+            $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response->get_error_message(), false, false, true );
+            wpinv_error_log( $response->get_error_message(), 'Received invalid response from PayPal IPN' );
+            return false;
+        }
+
+        $invoice->add_note( 'Received invalid response from PayPal IPN: ' . $response['body'], false, false, true );
+        wpinv_error_log( $response['body'], 'Received invalid response from PayPal IPN' );
+        return false;
+
+    }
+
+    /**
+     * Check currency from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $currency currency to validate.
+     */
+    protected function validate_ipn_currency( $invoice, $currency ) {
 
-		if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
-
-			/* translators: %s: currency code. */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ), false, false, true );
-
-			wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
-
-		wpinv_error_log( $currency, 'Validated IPN Currency', false );
-	}
+        if ( strtolower( $invoice->get_currency() ) !== strtolower( $currency ) ) {
+
+            /* translators: %s: currency code. */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal currencies do not match (code %s).', 'invoicing' ), $currency ), false, false, true );
+
+            wpinv_error_log( "Currencies do not match: {$currency} instead of {$invoice->get_currency()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
+
+        wpinv_error_log( $currency, 'Validated IPN Currency', false );
+    }
 
-	/**
-	 * Check payment amount from IPN matches the invoice.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param float   $amount amount to validate.
-	 */
-	protected function validate_ipn_amount( $invoice, $amount ) {
-		if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
+    /**
+     * Check payment amount from IPN matches the invoice.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param float   $amount amount to validate.
+     */
+    protected function validate_ipn_amount( $invoice, $amount ) {
+        if ( number_format( $invoice->get_total(), 2, '.', '' ) !== number_format( $amount, 2, '.', '' ) ) {
 
-			/* translators: %s: Amount. */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ), false, false, true );
+            /* translators: %s: Amount. */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal amounts do not match (gross %s).', 'invoicing' ), $amount ), false, false, true );
 
-			wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            wpinv_error_log( "Amounts do not match: {$amount} instead of {$invoice->get_total()}", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( $amount, 'Validated IPN Amount', false );
-	}
+        wpinv_error_log( $amount, 'Validated IPN Amount', false );
+    }
 
-	/**
-	 * Verify receiver email from PayPal.
-	 *
-	 * @param WPInv_Invoice $invoice          Invoice object.
-	 * @param string   $receiver_email Email to validate.
-	 */
-	protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
-		$paypal_email = $this->gateway->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
+    /**
+     * Verify receiver email from PayPal.
+     *
+     * @param WPInv_Invoice $invoice          Invoice object.
+     * @param string   $receiver_email Email to validate.
+     */
+    protected function validate_ipn_receiver_email( $invoice, $receiver_email ) {
+        $paypal_email = $this->gateway->is_sandbox( $invoice ) ? wpinv_get_option( 'paypal_sandbox_email', wpinv_get_option( 'paypal_email', '' ) ) : wpinv_get_option( 'paypal_email', '' );
 
-		if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
-			wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your PayPal email is {$paypal_email}." );
-
-			/* translators: %s: email address . */
-			$invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ) );
-			$invoice->add_note( wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ), false, false, true );
+        if ( $receiver_email && strcasecmp( trim( $receiver_email ), trim( $paypal_email ) ) !== 0 ) {
+            wpinv_record_gateway_error( 'IPN Error', "IPN Response is for another account: {$receiver_email}. Your PayPal email is {$paypal_email}." );
+
+            /* translators: %s: email address . */
+            $invoice->update_status( 'wpi-processing', wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ) );
+            $invoice->add_note( wp_sprintf( __( 'Validation error: PayPal IPN response from a different email address (%s). Your PayPal email is %s.', 'invoicing' ), $receiver_email, $paypal_email ), false, false, true );
 
-			return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email PayPal is {$paypal_email}.", 'IPN Error', __FILE__, __LINE__, true );
-		}
+            return wpinv_error_log( "IPN Response is for another account: {$receiver_email}. Your email PayPal is {$paypal_email}.", 'IPN Error', __FILE__, __LINE__, true );
+        }
 
-		wpinv_error_log( 'Validated PayPal Email', false );
-	}
-
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_web_accept( $invoice, $posted ) {
+        wpinv_error_log( 'Validated PayPal Email', false );
+    }
+
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_web_accept( $invoice, $posted ) {
 
-		// Collect payment details
-		$payment_status = strtolower( $posted['payment_status'] );
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        // Collect payment details
+        $payment_status = strtolower( $posted['payment_status'] );
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
 
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Update the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
-			$invoice->save();
-		}
+        // Update the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->set_transaction_id( wpinv_clean( $posted['txn_id'] ) );
+            $invoice->save();
+        }
 
-		$invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
+        $invoice->add_system_note( __( 'Processing invoice IPN', 'invoicing' ) );
 
-		// Process a refund.
-		if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
+        // Process a refund.
+        if ( 'refunded' === $payment_status || 'reversed' === $payment_status ) {
 
-			update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
+            update_post_meta( $invoice->get_id(), 'refunded_remotely', 1 );
 
-			if ( ! $invoice->is_refunded() ) {
-				$invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
-			}
+            if ( ! $invoice->is_refunded() ) {
+                $invoice->update_status( 'wpi-refunded', $posted['reason_code'] );
+            }
 
-			return wpinv_error_log( $posted['reason_code'], false );
-		}
+            return wpinv_error_log( $posted['reason_code'], false );
+        }
 
-		// Process payments.
-		if ( 'completed' === $payment_status ) {
+        // Process payments.
+        if ( 'completed' === $payment_status ) {
 
-			if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
-				return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
-			}
+            if ( $invoice->is_paid() && 'wpi_processing' != $invoice->get_status() ) {
+                return wpinv_error_log( 'Aborting, Invoice #' . $invoice->get_number() . ' is already paid.', false );
+            }
 
-			$this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
+            $this->validate_ipn_amount( $invoice, $posted['mc_gross'] );
 
-			$note = '';
+            $note = '';
 
-			if ( ! empty( $posted['mc_fee'] ) ) {
-				$note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
-			}
+            if ( ! empty( $posted['mc_fee'] ) ) {
+                $note = sprintf( __( 'PayPal Transaction Fee %s.', 'invoicing' ), sanitize_text_field( $posted['mc_fee'] ) );
+            }
 
-			if ( ! empty( $posted['payer_status'] ) ) {
-				$note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
-			}
+            if ( ! empty( $posted['payer_status'] ) ) {
+                $note = ' ' . sprintf( __( 'Buyer status %s.', 'invoicing' ), sanitize_text_field( $posted['payer_status'] ) );
+            }
 
-			$invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
-			return wpinv_error_log( 'Invoice marked as paid.', false );
+            $invoice->mark_paid( ( ! empty( $posted['txn_id'] ) ? sanitize_text_field( $posted['txn_id'] ) : '' ), trim( $note ) );
+            return wpinv_error_log( 'Invoice marked as paid.', false );
 
-		}
+        }
 
-		// Pending payments.
-		if ( 'pending' === $payment_status ) {
+        // Pending payments.
+        if ( 'pending' === $payment_status ) {
 
-			/* translators: %s: pending reason. */
-			$invoice->update_status( 'wpi-onhold', wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
-			$invoice->add_note( wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ), false, false, true );
+            /* translators: %s: pending reason. */
+            $invoice->update_status( 'wpi-onhold', wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ) );
+            $invoice->add_note( wp_sprintf( __( 'Payment pending (%s).', 'invoicing' ), $posted['pending_reason'] ), false, false, true );
 
-			return wpinv_error_log( 'Invoice marked as "payment held".', false );
-		}
+            return wpinv_error_log( 'Invoice marked as "payment held".', false );
+        }
 
-		/* translators: %s: payment status. */
-		$invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
+        /* translators: %s: payment status. */
+        $invoice->update_status( 'wpi-failed', sprintf( __( 'Payment %s via IPN.', 'invoicing' ), sanitize_text_field( $posted['payment_status'] ) ) );
 
-	}
+    }
 
-	/**
-	 * Handles one time payments.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_cart( $invoice, $posted ) {
-		$this->ipn_txn_web_accept( $invoice, $posted );
-	}
+    /**
+     * Handles one time payments.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_cart( $invoice, $posted ) {
+        $this->ipn_txn_web_accept( $invoice, $posted );
+    }
 
-	/**
-	 * Handles subscription sign ups.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_signup( $invoice, $posted ) {
+    /**
+     * Handles subscription sign ups.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_signup( $invoice, $posted ) {
 
-		wpinv_error_log( 'Processing subscription signup', false );
+        wpinv_error_log( 'Processing subscription signup', false );
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// Validate the IPN.
-		$business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
-		$this->validate_ipn_receiver_email( $invoice, $business_email );
-		$this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
+        // Validate the IPN.
+        $business_email = isset( $posted['business'] ) && is_email( $posted['business'] ) ? trim( $posted['business'] ) : trim( $posted['receiver_email'] );
+        $this->validate_ipn_receiver_email( $invoice, $business_email );
+        $this->validate_ipn_currency( $invoice, $posted['mc_currency'] );
 
-		// Activate the subscription.
-		$duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
-		$subscription->set_date_created( current_time( 'mysql' ) );
-		$subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
-		$subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
-		$subscription->activate();
+        // Activate the subscription.
+        $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() );
+        $subscription->set_date_created( current_time( 'mysql' ) );
+        $subscription->set_expiration( date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ) );
+        $subscription->set_profile_id( sanitize_text_field( $posted['subscr_id'] ) );
+        $subscription->activate();
 
-		// Set the transaction id.
-		if ( ! empty( $posted['txn_id'] ) ) {
-			$invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-			$invoice->set_transaction_id( $posted['txn_id'] );
-		}
+        // Set the transaction id.
+        if ( ! empty( $posted['txn_id'] ) ) {
+            $invoice->add_note( sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+            $invoice->set_transaction_id( $posted['txn_id'] );
+        }
 
-		// Update the payment status.
-		$invoice->mark_paid();
+        // Update the payment status.
+        $invoice->mark_paid();
 
-		$invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		wpinv_error_log( 'Subscription started.', false );
-	}
+        wpinv_error_log( 'Subscription started.', false );
+    }
 
-	/**
-	 * Handles subscription renewals.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_payment( $invoice, $posted ) {
+    /**
+     * Handles subscription renewals.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_payment( $invoice, $posted ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
+        wpinv_error_log( 'Found subscription #' . $subscription->get_id(), false );
 
-		// PayPal sends a subscr_payment for the first payment too.
-		$date_completed = getpaid_format_date( $invoice->get_date_completed() );
-		$date_created   = getpaid_format_date( $invoice->get_date_created() );
-		$today_date     = getpaid_format_date( current_time( 'mysql' ) );
-		$payment_date   = getpaid_format_date( $posted['payment_date'] );
-		$subscribe_date = getpaid_format_date( $subscription->get_date_created() );
-		$dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
+        // PayPal sends a subscr_payment for the first payment too.
+        $date_completed = getpaid_format_date( $invoice->get_date_completed() );
+        $date_created   = getpaid_format_date( $invoice->get_date_created() );
+        $today_date     = getpaid_format_date( current_time( 'mysql' ) );
+        $payment_date   = getpaid_format_date( $posted['payment_date'] );
+        $subscribe_date = getpaid_format_date( $subscription->get_date_created() );
+        $dates          = array_filter( compact( 'date_completed', 'date_created', 'subscribe_date' ) );
 
-		foreach ( $dates as $date ) {
+        foreach ( $dates as $date ) {
 
-			if ( $date !== $today_date && $date !== $payment_date ) {
-				continue;
-			}
+            if ( $date !== $today_date && $date !== $payment_date ) {
+                continue;
+            }
 
-			if ( ! empty( $posted['txn_id'] ) ) {
-				$invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
-				$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
-			}
+            if ( ! empty( $posted['txn_id'] ) ) {
+                $invoice->set_transaction_id( sanitize_text_field( $posted['txn_id'] ) );
+                $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), sanitize_text_field( $posted['txn_id'] ) ), false, false, true );
+            }
 
-			return $invoice->mark_paid();
-
-		}
+            return $invoice->mark_paid();
+
+        }
 
-		wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
-
-		// Abort if the payment is already recorded.
-		if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
-			return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
-		}
-
-		$args = array(
-			'transaction_id' => $posted['txn_id'],
-			'gateway'        => $this->id,
-		);
-
-		$invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
+        wpinv_error_log( 'Processing subscription renewal payment for the invoice ' . $invoice->get_id(), false );
+
+        // Abort if the payment is already recorded.
+        if ( wpinv_get_id_by_transaction_id( $posted['txn_id'] ) ) {
+            return wpinv_error_log( 'Aborting, Transaction ' . $posted['txn_id'] . ' has already been processed', false );
+        }
+
+        $args = array(
+            'transaction_id' => $posted['txn_id'],
+            'gateway'        => $this->id,
+        );
+
+        $invoice = wpinv_get_invoice( $subscription->add_payment( $args ) );
 
-		if ( empty( $invoice ) ) {
-			return;
-		}
+        if ( empty( $invoice ) ) {
+            return;
+        }
 
-		$invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
-		$invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Transaction ID: %s', 'invoicing' ), $posted['txn_id'] ), false, false, true );
+        $invoice->add_note( wp_sprintf( __( 'PayPal Subscription ID: %s', 'invoicing' ), $posted['subscr_id'] ), false, false, true );
 
-		$subscription->renew();
-		wpinv_error_log( 'Subscription renewed.', false );
+        $subscription->renew();
+        wpinv_error_log( 'Subscription renewed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription cancelations.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 */
-	protected function ipn_txn_subscr_cancel( $invoice ) {
+    /**
+     * Handles subscription cancelations.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     */
+    protected function ipn_txn_subscr_cancel( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
-
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription completions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_eot( $invoice ) {
+    /**
+     * Handles subscription completions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_eot( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
-		$subscription->complete();
-		wpinv_error_log( 'Subscription completed.', false );
+        wpinv_error_log( 'Processing subscription end of life for the invoice ' . $invoice->get_id(), false );
+        $subscription->complete();
+        wpinv_error_log( 'Subscription completed.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription fails.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_subscr_failed( $invoice ) {
+    /**
+     * Handles subscription fails.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_subscr_failed( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
 
-		wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
-		$subscription->failing();
-		wpinv_error_log( 'Subscription marked as failing.', false );
+        wpinv_error_log( 'Processing subscription payment failure for the invoice ' . $invoice->get_id(), false );
+        $subscription->failing();
+        wpinv_error_log( 'Subscription marked as failing.', false );
 
-	}
+    }
 
-	/**
-	 * Handles subscription suspensions.
-	 *
-	 * @param WPInv_Invoice $invoice  Invoice object.
-	 * @param array    $posted Posted data.
-	 */
-	protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
+    /**
+     * Handles subscription suspensions.
+     *
+     * @param WPInv_Invoice $invoice  Invoice object.
+     * @param array    $posted Posted data.
+     */
+    protected function ipn_txn_recurring_payment_suspended_due_to_max_failed_payment( $invoice ) {
 
-		// Make sure the invoice has a subscription.
-		$subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
+        // Make sure the invoice has a subscription.
+        $subscription = getpaid_subscriptions()->get_invoice_subscription( $invoice );
 
-		if ( empty( $subscription ) ) {
-			return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
-		}
-
-		wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
-		$subscription->cancel();
-		wpinv_error_log( 'Subscription cancelled.', false );
-	}
+        if ( empty( $subscription ) ) {
+            return wpinv_error_log( 'Aborting, Subscription for the invoice ' . $invoice->get_id() . ' not found', false );
+        }
+
+        wpinv_error_log( 'Processing subscription cancellation due to max failed payment for the invoice ' . $invoice->get_id(), false );
+        $subscription->cancel();
+        wpinv_error_log( 'Subscription cancelled.', false );
+    }
 
 }