wpml-translation-basket.class.php
7.81 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
<?php
use WPML\LIB\WP\Cache;
use \WPML\Collect\Support\Traits\Macroable;
use WPML\FP\Logic;
use WPML\FP\Str;
use function \WPML\FP\System\sanitizeString;
use function \WPML\FP\pipe;
use function \WPML\FP\curryN;
/**
* @method static int get_batch_id_from_name( string $basket_name )
*/
class WPML_Translation_Basket {
use Macroable;
/** @var wpdb $wpdb */
private $wpdb;
public function __construct( \wpdb $wpdb ) {
$this->wpdb = $wpdb;
}
/**
* Returns an array representation of the current translation basket
*
* @param bool|false $force if true reloads the baskets contents from the database
*
* @return array
*/
function get_basket( $force = false ) {
$basket = TranslationProxy_Basket::get_basket( $force );
$basket = $basket ? $basket : array();
return $basket;
}
/**
* @return bool|TranslationProxy_Project
*/
public function get_project() {
return TranslationProxy::get_current_project();
}
function get_item_types() {
return TranslationProxy_Basket::get_basket_items_types();
}
/**
* Returns a batch instance by basket- or batch-name
*
* @param string $basket_name
*
* @return WPML_Translation_Batch
*/
function get_basket_batch( $basket_name ) {
return new WPML_Translation_Batch( $this->wpdb, self::get_batch_id_from_name( $basket_name ) );
}
/**
* Sets the remote target languages before committing the basket to a translation service.
*
* @param array $remote_languages
*/
function set_remote_target_languages( $remote_languages ) {
TranslationProxy_Basket::set_remote_target_languages( $remote_languages );
}
/**
* Removes all items from the current translation basket.
*/
function delete_all_items() {
TranslationProxy_Basket::delete_all_items_from_basket();
}
/**
* Returns the name of the current translation basket.
*
* @return bool|string
*/
function get_name() {
return TranslationProxy_Basket::get_basket_name();
}
function set_name( $basket_name ) {
TranslationProxy_Basket::set_basket_name( $basket_name );
}
function set_options( array $batch_options ) {
TranslationProxy_Basket::set_options( $batch_options );
}
/** @return array */
function get_options() {
return TranslationProxy_Basket::get_options();
}
/**
* @param string $basket_name
* @param int $basket_name_max_length
*
* @return array
*/
function check_basket_name( $basket_name, $basket_name_max_length ) {
$result = array(
'modified' => false,
'valid' => true,
'message' => '',
'new_value' => '',
);
$old_value = $basket_name;
$basket_name = strip_tags( $basket_name );
if ( mb_strlen( $basket_name ) > $basket_name_max_length ) {
$result['valid'] = true;
$result['message'] = sprintf(
__( 'The length of the batch name exceeds the maximum length of %s', 'wpml-translation-management' ),
$basket_name_max_length
);
$result['new_value'] = $this->get_unique_basket_name( $basket_name, $basket_name_max_length );
} elseif ( self::get_batch_id_from_name( $basket_name ) ) {
$result['valid'] = true;
$result['new_value'] = $this->get_unique_basket_name( $basket_name, $basket_name_max_length );
$result['message'] = __(
'This batch name already exists and was modified to ensure unique naming',
'wpml-translation-management'
);
} elseif ( count( $basket_name_array = explode( '|', $basket_name ) ) === 1 ) {
$result['valid'] = true;
$result['new_value'] = $this->get_unique_basket_name( $basket_name, $basket_name_max_length );
$result['message'] = __(
'The batch name was appended with the source language of its elements.',
'wpml-translation-management'
);
}
$result['modified'] = $result['new_value'] !== '' && $result['new_value'] !== $old_value;
$result['message'] = $result['modified'] || ! $result['valid'] ? $result['message'] : '';
return $result;
}
/**
* Returns a unique name derived from an input name for a Translation Proxy Basket
*
* @param string $name
* @param bool|int $max_length
*
* @return bool|string
*/
function get_unique_basket_name( $name, $max_length ) {
$basket_name_array = explode( '|', $name );
$name = count( $basket_name_array ) === 1
|| ( ! is_numeric( $basket_name_array[ count( $basket_name_array ) - 1 ] )
&& $basket_name_array[ count( $basket_name_array ) - 1 ] !== $this->get_source_language() )
|| ( is_numeric( $basket_name_array[ count( $basket_name_array ) - 1 ] )
&& $basket_name_array[ count( $basket_name_array ) - 2 ] !== $this->get_source_language() )
? $name . '|' . $this->get_source_language() : $name;
$name = mb_strlen( $name ) > $max_length
? $this->sanitize_basket_name( $name, $max_length ) : $name;
if ( self::get_batch_id_from_name( $name ) ) {
$suffix = 2;
$name = $this->sanitize_basket_name( $name, $max_length - mb_strlen( (string) $suffix ) - 1 );
while ( self::get_batch_id_from_name( $name . '|' . $suffix ) ) {
$suffix ++;
$name = $this->sanitize_basket_name( $name, $max_length - mb_strlen( (string) $suffix ) - 1 );
}
$name .= '|' . $suffix;
}
return $name;
}
/**
* @return string
*/
public function get_source_language() {
return TranslationProxy_Basket::get_source_language();
}
/**
* @param int $package_id
*/
public function remove_package( $package_id ) {
TranslationProxy_Basket::delete_item_from_basket( $package_id, 'package' );
}
/**
* @param int $id
* @param string $kind
*/
public function remove_item( $id, $kind ) {
TranslationProxy_Basket::delete_item_from_basket( $id, $kind );
}
/**
* Merge the basket portion with the saved basket
*
* @param array $basket_portion
*/
public function update_basket( $basket_portion = array() ) {
TranslationProxy_Basket::update_basket( $basket_portion );
}
private function sanitize_basket_name( $basket_name, $max_length ) {
// input basket name is separated by pipes so we explode it
$to_trim = mb_strlen( $basket_name ) - $max_length;
if ( $to_trim <= 0 ) {
return $basket_name;
}
$basket_name_array = explode( '|', $basket_name );
$wpml_flag = count( $basket_name_array ) < 3;
if ( $wpml_flag === false && count( $basket_name_array ) < 2 ) {
return mb_substr( $basket_name, $max_length - 1 );
}
// first we trim the middle part holding the "WPML"
if ( $wpml_flag ) {
list( $basket_name_array, $to_trim ) = $this->shorten_basket_name( $basket_name_array, 1, $to_trim );
}
// then trim the site name first, if that's not enough move the array index and also trim the language
for ( $i = 0; $i <= 1; $i ++ ) {
if ( $to_trim > 0 ) {
list( $basket_name_array, $to_trim ) = $this->shorten_basket_name( $basket_name_array, 0, $to_trim );
$basket_name_array = array_filter( $basket_name_array );
} else {
break;
}
}
$basket_name_array = array_filter( $basket_name_array );
return implode( '|', $basket_name_array );
}
private function shorten_basket_name( $name_array, $index, $to_trim ) {
if ( mb_strlen( $name_array [ $index ] ) > $to_trim ) {
$name_array[ $index ] = mb_substr( $name_array[ $index ], 0, mb_strlen( $name_array [ $index ] ) - $to_trim - 1 );
$name_array = array_filter( $name_array );
$to_trim = 0;
} else {
$to_trim = $to_trim - mb_strlen( $name_array [ $index ] ) - 1; // subtract one here since we lose a downstroke
unset( $name_array [ $index ] );
}
return array( $name_array, $to_trim );
}
}
/**
* Returns the batch id for a given basket or batch name
*
* @param string $basket_name
*
* @return int|bool
*/
WPML_Translation_Basket::macro(
'get_batch_id_from_name',
curryN(
1,
Cache::memorizeWithCheck(
'get_batch_id_from_name',
Logic::isNotEmpty(),
0,
pipe(
Str::replace( '"', '\\"' ),
sanitizeString(),
TranslationProxy_Batch::getBatchId()
)
)
)
);