Repository navigation
Expand file tree
/
Copy pathtranslatable-object.php
More file actions
731 lines (630 loc) · 19.2 KB
/
Copy pathtranslatable-object.php
File metadata and controls
731 lines (630 loc) · 19.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
<?php
/**
* @package Polylang
*/
use WP_Syntex\Polylang\Model\Languages;
defined( 'ABSPATH' ) || exit;
/**
* Abstract class to use for object types that support at least one language.
*
* @since 3.4
*
* @phpstan-type DBInfo array{
* table: non-empty-string,
* id_column: non-empty-string,
* default_alias: non-empty-string
* }
*/
abstract class PLL_Translatable_Object {
/**
* Model for the languages.
*
* @var Languages
*/
protected $languages;
/**
* Polylang's options.
*
* @var \WP_Syntex\Polylang\Options\Options
*/
protected $options;
/**
* Internal non persistent cache object.
*
* @var PLL_Cache<mixed>
*/
protected $cache;
/**
* List of taxonomies to cache.
*
* @var string[]
* @see PLL_Translatable_Object::get_object_term()
*
* @phpstan-var list<non-empty-string>
*/
protected $tax_to_cache = array();
/**
* Taxonomy name for the languages.
*
* @var string
*
* @phpstan-var non-empty-string
*/
protected $tax_language;
/**
* Identifier that must be unique for each type of content.
* Also used when checking capabilities.
*
* @var string
*
* @phpstan-var non-empty-string
*/
protected $type;
/**
* Identifier for each type of content to used for cache type.
*
* @var string
*
* @phpstan-var non-empty-string
*/
protected $cache_type;
/**
* Object type to use when registering the taxonomy.
* Left empty for posts.
*
* @var string|null
*
* @phpstan-var non-empty-string|null
*/
protected $object_type = null;
/**
* Constructor.
*
* @since 3.4
*
* @param PLL_Model $model Instance of `PLL_Model`.
*/
public function __construct( PLL_Model $model ) {
$this->languages = $model->languages;
$this->options = $model->options;
$this->cache = $model->cache;
$this->tax_to_cache[] = $this->tax_language;
/*
* Register our taxonomy as soon as possible.
*/
$this->register_language_taxonomy();
}
/**
* Registers the language taxonomy.
*
* @since 3.7
*
* @return void
*/
protected function register_language_taxonomy(): void {
register_taxonomy(
$this->tax_language,
(array) $this->object_type,
array(
'label' => false,
'public' => false,
'query_var' => false,
'rewrite' => false,
'_pll' => true,
)
);
$this->add_sanitization_hooks( $this->tax_language );
}
/**
* Hooks sanitization for a Polylang taxonomy that stores serialized data in term descriptions.
*
* @since 3.8.10
*
* @param string $taxonomy Taxonomy name.
* @return void
*
* @phpstan-param non-empty-string $taxonomy
*/
protected function add_sanitization_hooks( string $taxonomy ): void {
add_filter( "pre_{$taxonomy}_description", array( $this, 'sanitize_description' ), 0 );
add_filter( "get_{$taxonomy}", array( $this, 'sanitize_term' ), 0 );
}
/**
* Empties the description of a term hydrated from the database when it holds a disallowed serialized type.
*
* `get_{$taxonomy}` is fired by `get_term()`, whatever the sanitization context, and thus covers the
* terms hydrated by `get_terms()` and `wp_get_object_terms()` too. Only the returned object is modified,
* the stored value is left untouched.
*
* @since 3.8.10
*
* @param mixed $term Term object, may be anything another callback returned.
* @return mixed The term, with a sanitized description.
*/
public function sanitize_term( $term ) {
if ( $term instanceof WP_Term && $this->has_disallowed_type( $term->description ) ) {
$term->description = '';
}
return $term;
}
/**
* Drops serialized values that contain a disallowed PHP type.
*
* @since 3.8.10
*
* @param mixed $description Term description.
* @return string Empty string for a non-string value or when a disallowed type is found, unchanged otherwise.
*/
public function sanitize_description( $description ) {
if ( ! is_string( $description ) || '' === $description ) {
return '';
}
return $this->has_disallowed_type( $description ) ? '' : $description;
}
/**
* Tells if a serialized value contains a disallowed PHP type.
*
* Leading and trailing whitespace is trimmed first, matching `is_serialized()` and `maybe_unserialize()`.
*
* The regex scans the whole blob for disallowed PHP serialization type tokens (`O:`, `C:`, `E:`, `r:`, `R:`),
* including inside serialized string payloads. It does not parse `s:"…"` boundaries.
*
* Allowed serialized types: array, string, int, float, null and bool.
*
* @since 3.8.10
*
* @param string $description Term description.
* @return bool
*/
private function has_disallowed_type( string $description ): bool {
$description = trim( $description );
if ( '' === $description ) {
return false;
}
return 0 !== preg_match( '#[OCErR]:\d+[:;]#', $description );
}
/**
* Returns the language taxonomy name.
*
* @since 3.4
*
* @return string
*
* @phpstan-return non-empty-string
*/
public function get_tax_language() {
return $this->tax_language;
}
/**
* Returns the type of object.
*
* @since 3.4
*
* @return string
*
* @phpstan-return non-empty-string
*/
public function get_type() {
return $this->type;
}
/**
* Adds hooks.
*
* @since 3.4
*
* @return static
*/
public function init() {
return $this;
}
/**
* Stores the object's language into the database.
*
* @since 3.4
*
* @param int $id Object ID.
* @param PLL_Language|string|int $lang Language (object, slug, or term ID).
* @return bool True when successfully assigned. False otherwise (or if the given language is already assigned to
* the object).
*/
public function set_language( $id, $lang ) {
$id = pll_sanitize_id( $id );
if ( empty( $id ) ) {
return false;
}
$old_lang = $this->get_language( $id );
$old_lang = $old_lang ? $old_lang->get_tax_prop( $this->tax_language, 'term_id' ) : 0;
$lang = $this->languages->get( $lang );
$lang = $lang ? $lang->get_tax_prop( $this->tax_language, 'term_id' ) : 0;
if ( $old_lang === $lang ) {
return false;
}
$term_taxonomy_ids = wp_set_object_terms( $id, $lang, $this->tax_language );
wp_cache_set_last_changed( $this->cache_type );
return is_array( $term_taxonomy_ids );
}
/**
* Returns the language of an object.
*
* @since 0.1
* @since 3.4 Renamed the parameter $post_id into $id.
*
* @param int $id Object ID.
* @return PLL_Language|false A `PLL_Language` object. `false` if no language is associated to that object or if the
* ID is invalid.
*/
public function get_language( $id ) {
$id = pll_sanitize_id( $id );
if ( empty( $id ) ) {
return false;
}
// Get the language and make sure it is a PLL_Language object.
$lang = $this->get_object_term( $id, $this->tax_language );
if ( empty( $lang ) ) {
return false;
}
return $this->languages->get( $lang->term_id );
}
/**
* Removes the term language from the database.
*
* @since 3.4
*
* @param int $id Term ID.
* @return void
*/
public function delete_language( $id ) {
$id = pll_sanitize_id( $id );
if ( empty( $id ) ) {
return;
}
wp_delete_object_term_relationships( $id, $this->tax_language );
}
/**
* Wraps `wp_get_object_terms()` to cache it for multiple objects.
*
* @since 3.8
*
* @param int[] $object_ids Array of object IDs.
* @param string $taxonomy Taxonomy name.
* @return array<int,WP_Term> Array of terms with object ID as key.
*/
protected function get_object_terms( array $object_ids, string $taxonomy ) {
$object_ids = pll_sanitize_ids( $object_ids );
if ( empty( $object_ids ) ) {
return array();
}
$cached_values = $this->get_from_object_term_cache( $object_ids, $taxonomy );
$all_term_ids = array_values( $cached_values );
_prime_term_caches( $all_term_ids, false );
$terms = array();
foreach ( $cached_values as $object_id => $term_id ) {
/** @var WP_Term $term */
$term = get_term( $term_id );
$terms[ $object_id ] = $term;
}
return $terms;
}
/**
* Caches all object-relationship terms.
*
* @since 3.8.1
*
* @param int[] $object_ids Array of object IDs.
*
* @return int[][][]
*/
protected function update_object_term_cache( array $object_ids ) {
$non_cached_ids = array();
foreach ( $this->tax_to_cache as $tax ) {
$non_cached_ids = array_merge( $non_cached_ids, _get_non_cached_ids( $object_ids, "{$tax}_relationships" ) );
}
if ( empty( $non_cached_ids ) ) {
return array();
}
$terms = wp_get_object_terms(
array_unique( $non_cached_ids ),
$this->tax_to_cache,
array(
'fields' => 'all_with_object_id',
'update_term_meta_cache' => false,
)
);
if ( ! is_array( $terms ) ) {
return array();
}
$object_terms = array();
foreach ( $terms as $term ) {
$object_terms[ $term->taxonomy ][ $term->object_id ][] = $term->term_id;
}
foreach ( $non_cached_ids as $id ) {
foreach ( $this->tax_to_cache as $tax ) {
if ( ! isset( $object_terms[ $tax ][ $id ] ) ) {
$object_terms[ $tax ][ $id ] = array();
}
}
}
foreach ( $object_terms as $tax => $data ) {
wp_cache_add_multiple( $data, "{$tax}_relationships" );
}
return $object_terms;
}
/**
* Caches all object-relationship terms and returns them for the specified taxonomy.
*
* @since 3.8
*
* @param int[] $object_ids Array of object IDs to retrieve terms for.
* @param string $taxonomy Taxonomy name.
*
* @return int[] Array of term IDs with object ID as key.
*/
protected function get_from_object_term_cache( array $object_ids, string $taxonomy ): array {
$values = wp_cache_get_multiple( $object_ids, "{$taxonomy}_relationships" );
// If values are missing, then update the cache and replace missed values by freshly cached ones.
$object_terms = $this->update_object_term_cache( $object_ids );
if ( isset( $object_terms[ $taxonomy ] ) ) {
$values = array_replace( $values, $object_terms[ $taxonomy ] );
}
$sanitized_values = array();
foreach ( $values as $object_id => $term_ids ) {
if ( ! is_array( $term_ids ) ) {
continue;
}
$id = reset( $term_ids );
if ( ! is_numeric( $id ) || empty( $id ) ) {
continue;
}
$sanitized_values[ $object_id ] = (int) $id;
}
return $sanitized_values;
}
/**
* Returns terms associated to the given object in the given taxonomy.
*
* @since 1.2
* @since 3.8 Returns null if the associated term doesn't exist.
*
* @param int $object_id Object ID.
* @param string $taxonomy Polylang taxonomy depending if we are looking for a post (or term, or else) language.
* @return WP_Term|null The term associated to the object in the requested taxonomy if it exists, `null` otherwise.
*/
public function get_object_term( $object_id, $taxonomy ) {
$terms = $this->get_object_terms( array( $object_id ), $taxonomy );
return $terms[ $object_id ] ?? null;
}
/**
* A JOIN clause to add to sql queries when filtering by language is needed directly in query.
*
* @since 3.4
*
* @param string $alias Optional alias for object table.
* @return string The JOIN clause.
*
* @phpstan-return non-empty-string
*/
public function join_clause( $alias = '' ) {
global $wpdb;
$db = $this->get_db_infos();
if ( empty( $alias ) ) {
$alias = $db['default_alias'];
}
return " INNER JOIN {$wpdb->term_relationships} AS pll_tr ON pll_tr.object_id = {$alias}.{$db['id_column']}";
}
/**
* A WHERE clause to add to sql queries when filtering by language is needed directly in query.
*
* @since 1.2
*
* @param PLL_Language|PLL_Language[]|string|string[] $lang A `PLL_Language` object, or a comma separated list of language slugs, or an array of language slugs or objects.
* @return string The WHERE clause.
*/
public function where_clause( $lang ) {
/*
* $lang is an object.
* This is generally the case if the query is coming from Polylang.
*/
if ( $lang instanceof PLL_Language ) {
return ' AND pll_tr.term_taxonomy_id = ' . absint( $lang->get_tax_prop( $this->tax_language, 'term_taxonomy_id' ) );
}
/*
* $lang is an array of objects, an array of slugs, or a comma separated list of slugs.
* The comma separated list of slugs can happen if the query is coming from outside with a 'lang' parameter.
*/
$languages = is_array( $lang ) ? $lang : explode( ',', $lang );
$languages_tt_ids = array();
foreach ( $languages as $language ) {
$language = $this->languages->get( $language );
if ( ! empty( $language ) ) {
$languages_tt_ids[] = absint( $language->get_tax_prop( $this->tax_language, 'term_taxonomy_id' ) );
}
}
if ( empty( $languages_tt_ids ) ) {
return '';
}
return ' AND pll_tr.term_taxonomy_id IN ( ' . implode( ',', $languages_tt_ids ) . ' )';
}
/**
* Returns the IDs of the objects without language.
*
* @since 3.4
*
* @param int $limit Max number of objects to return. `-1` to return all of them.
* @param array $args The object args.
* @return int[] Array of object IDs.
*
* @phpstan-param -1|positive-int $limit
* @phpstan-return list<positive-int>
*/
public function get_objects_with_no_lang( $limit, array $args = array() ) {
$language_ids = array();
foreach ( $this->languages->get_list() as $language ) {
$language_ids[] = $language->get_tax_prop( $this->get_tax_language(), 'term_taxonomy_id' );
}
$language_ids = array_filter( $language_ids );
if ( empty( $language_ids ) ) {
return array();
}
$object_ids = $this->query_objects_with_no_lang( $language_ids, $limit, $args );
return array_values( pll_sanitize_ids( $object_ids ) );
}
/**
* Returns object IDs without language.
* Can be overridden by child classes in case queried object doesn't use
* `wp_cache_set_last_changed()` or another cache system.
*
* @since 3.4
* @since 3.7 Changed all parameters.
*
* @param int[] $language_ids List of language `term_taxonomy_id`.
* @param int $limit Max number of objects to return. `-1` to return all of them.
* @param array $args The object args.
* @return string[] An array of numeric object IDs.
*
* @phpstan-param array<positive-int> $language_ids
* @phpstan-param -1|positive-int $limit
* @phpstan-param array<empty> $args
*/
protected function query_objects_with_no_lang( array $language_ids, $limit, array $args = array() ) {
$key = "{$this->cache_type}_no_lang:" . md5( maybe_serialize( $language_ids ) . maybe_serialize( $args ) . $limit );
$object_ids = $this->get_from_cache( $key );
if ( is_array( $object_ids ) ) {
return $object_ids;
}
$object_ids = $this->get_raw_objects_with_no_lang( $language_ids, $limit, $args );
$this->set_to_cache( $key, $object_ids );
return $object_ids;
}
/**
* Fetches the IDs of the objects without language.
*
* @since 3.7
*
* @param int[] $language_ids List of language `term_taxonomy_id`.
* @param int $limit Max number of objects to return. `-1` to return all of them.
* @param array $args The object args.
* @return string[]
*
* @phpstan-param array<positive-int> $language_ids
* @phpstan-param -1|positive-int $limit
* @phpstan-param array<empty> $args
*/
protected function get_raw_objects_with_no_lang( array $language_ids, $limit, array $args = array() ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
global $wpdb;
$db = $this->get_db_infos();
return $wpdb->get_col(
$wpdb->prepare(
sprintf(
"SELECT %%i FROM %%i
WHERE %%i NOT IN (
SELECT object_id FROM {$wpdb->term_relationships} WHERE term_taxonomy_id IN (%s)
)
LIMIT %%d",
implode( ',', array_fill( 0, count( $language_ids ), '%d' ) )
),
array_merge(
array( $db['id_column'], $db['table'], $db['id_column'] ),
$language_ids,
array( $limit >= 1 ? $limit : 4294967295 )
)
)
);
}
/**
* Assigns a language to object in mass.
*
* @since 1.2
* @since 3.4 Moved from PLL_Admin_Model class.
*
* @param int[] $ids Array of post ids or term ids.
* @param PLL_Language $lang Language to assign to the posts or terms.
* @return void
*/
public function set_language_in_mass( $ids, $lang ) {
global $wpdb;
$tt_id = $lang->get_tax_prop( $this->tax_language, 'term_taxonomy_id' );
if ( empty( $tt_id ) ) {
return;
}
$ids = array_map( 'intval', $ids );
$ids = array_filter( $ids );
if ( empty( $ids ) ) {
return;
}
$values = array();
foreach ( $ids as $id ) {
$values[] = $wpdb->prepare( '( %d, %d )', $id, $tt_id );
}
// PHPCS:ignore WordPress.DB.PreparedSQL.NotPrepared
$wpdb->query( "INSERT INTO {$wpdb->term_relationships} ( object_id, term_taxonomy_id ) VALUES " . implode( ',', array_unique( $values ) ) );
// Updating term count is mandatory (thanks to AndyDeGroo).
$lang->update_count();
clean_term_cache( $ids, $this->tax_language );
// Invalidate our cache.
wp_cache_set_last_changed( $this->cache_type );
}
/**
* Returns the description to use for the "language properties" in the REST API.
*
* @since 3.7
* @see WP_Syntex\Polylang\REST\V2\Languages::get_item_schema()
*
* @return string
*/
public function get_rest_description(): string {
/* translators: %s is the name of a database table. */
return sprintf( __( 'Language taxonomy properties for table %s.', 'polylang' ), $this->get_db_infos()['table'] );
}
/**
* Fetches the value from the cache. Handles backward compatibility with WordPress < 6.9.
*
* @since 3.8
*
* @param string $key The cache key.
* @return mixed|false The cached value, false if not found.
*/
private function get_from_cache( string $key ) {
$last_changed = wp_cache_get_last_changed( $this->cache_type );
if ( ! function_exists( 'wp_cache_get_salted' ) ) {
// Backward compatibility with WordPress < 6.9.
$cache_key = "{$key}:{$last_changed}";
return wp_cache_get( $cache_key, $this->cache_type );
}
return wp_cache_get_salted( $key, $this->cache_type, $last_changed );
}
/**
* Stores the value in the cache. Handles backward compatibility with WordPress < 6.9.
*
* @since 3.8
*
* @param string $key The cache key.
* @param mixed $value The value to store in the cache.
* @return bool True if the value has been stored, false otherwise.
*/
private function set_to_cache( string $key, $value ): bool {
$last_changed = wp_cache_get_last_changed( $this->cache_type );
if ( ! function_exists( 'wp_cache_set_salted' ) ) {
// Backward compatibility with WordPress < 6.9.
$cache_key = "{$key}:{$last_changed}";
return wp_cache_set( $cache_key, $value, $this->cache_type );
}
return wp_cache_set_salted( $key, $value, $this->cache_type, $last_changed );
}
/**
* Returns database-related information that can be used in some of this class methods.
* These are specific to the table containing the objects.
*
* @see PLL_Translatable_Object::join_clause()
* @see PLL_Translatable_Object::get_raw_objects_with_no_lang()
*
* @since 3.4.3
*
* @return string[] {
* @type string $table Name of the table.
* @type string $id_column Name of the column containing the object's ID.
* @type string $default_alias Default alias corresponding to the object's table.
* }
* @phpstan-return DBInfo
*/
abstract protected function get_db_infos();
}