Wordpress 3.5
[autoinstalls/wordpress.git] / wp-includes / functions.php
1 <?php
2 /**
3  * Main WordPress API
4  *
5  * @package WordPress
6  */
7
8 require( ABSPATH . WPINC . '/option.php' );
9
10 /**
11  * Converts given date string into a different format.
12  *
13  * $format should be either a PHP date format string, e.g. 'U' for a Unix
14  * timestamp, or 'G' for a Unix timestamp assuming that $date is GMT.
15  *
16  * If $translate is true then the given date and format string will
17  * be passed to date_i18n() for translation.
18  *
19  * @since 0.71
20  *
21  * @param string $format Format of the date to return.
22  * @param string $date Date string to convert.
23  * @param bool $translate Whether the return date should be translated. Default is true.
24  * @return string|int Formatted date string, or Unix timestamp.
25  */
26 function mysql2date( $format, $date, $translate = true ) {
27         if ( empty( $date ) )
28                 return false;
29
30         if ( 'G' == $format )
31                 return strtotime( $date . ' +0000' );
32
33         $i = strtotime( $date );
34
35         if ( 'U' == $format )
36                 return $i;
37
38         if ( $translate )
39                 return date_i18n( $format, $i );
40         else
41                 return date( $format, $i );
42 }
43
44 /**
45  * Retrieve the current time based on specified type.
46  *
47  * The 'mysql' type will return the time in the format for MySQL DATETIME field.
48  * The 'timestamp' type will return the current timestamp.
49  *
50  * If $gmt is set to either '1' or 'true', then both types will use GMT time.
51  * if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
52  *
53  * @since 1.0.0
54  *
55  * @param string $type Either 'mysql' or 'timestamp'.
56  * @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
57  * @return int|string String if $type is 'gmt', int if $type is 'timestamp'.
58  */
59 function current_time( $type, $gmt = 0 ) {
60         switch ( $type ) {
61                 case 'mysql':
62                         return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) ) );
63                         break;
64                 case 'timestamp':
65                         return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
66                         break;
67         }
68 }
69
70 /**
71  * Retrieve the date in localized format, based on timestamp.
72  *
73  * If the locale specifies the locale month and weekday, then the locale will
74  * take over the format for the date. If it isn't, then the date format string
75  * will be used instead.
76  *
77  * @since 0.71
78  *
79  * @param string $dateformatstring Format to display the date.
80  * @param int $unixtimestamp Optional. Unix timestamp.
81  * @param bool $gmt Optional, default is false. Whether to convert to GMT for time.
82  * @return string The date, translated if locale specifies it.
83  */
84 function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
85         global $wp_locale;
86         $i = $unixtimestamp;
87
88         if ( false === $i ) {
89                 if ( ! $gmt )
90                         $i = current_time( 'timestamp' );
91                 else
92                         $i = time();
93                 // we should not let date() interfere with our
94                 // specially computed timestamp
95                 $gmt = true;
96         }
97
98         // store original value for language with untypical grammars
99         // see http://core.trac.wordpress.org/ticket/9396
100         $req_format = $dateformatstring;
101
102         $datefunc = $gmt? 'gmdate' : 'date';
103
104         if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
105                 $datemonth = $wp_locale->get_month( $datefunc( 'm', $i ) );
106                 $datemonth_abbrev = $wp_locale->get_month_abbrev( $datemonth );
107                 $dateweekday = $wp_locale->get_weekday( $datefunc( 'w', $i ) );
108                 $dateweekday_abbrev = $wp_locale->get_weekday_abbrev( $dateweekday );
109                 $datemeridiem = $wp_locale->get_meridiem( $datefunc( 'a', $i ) );
110                 $datemeridiem_capital = $wp_locale->get_meridiem( $datefunc( 'A', $i ) );
111                 $dateformatstring = ' '.$dateformatstring;
112                 $dateformatstring = preg_replace( "/([^\\\])D/", "\\1" . backslashit( $dateweekday_abbrev ), $dateformatstring );
113                 $dateformatstring = preg_replace( "/([^\\\])F/", "\\1" . backslashit( $datemonth ), $dateformatstring );
114                 $dateformatstring = preg_replace( "/([^\\\])l/", "\\1" . backslashit( $dateweekday ), $dateformatstring );
115                 $dateformatstring = preg_replace( "/([^\\\])M/", "\\1" . backslashit( $datemonth_abbrev ), $dateformatstring );
116                 $dateformatstring = preg_replace( "/([^\\\])a/", "\\1" . backslashit( $datemeridiem ), $dateformatstring );
117                 $dateformatstring = preg_replace( "/([^\\\])A/", "\\1" . backslashit( $datemeridiem_capital ), $dateformatstring );
118
119                 $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
120         }
121         $timezone_formats = array( 'P', 'I', 'O', 'T', 'Z', 'e' );
122         $timezone_formats_re = implode( '|', $timezone_formats );
123         if ( preg_match( "/$timezone_formats_re/", $dateformatstring ) ) {
124                 $timezone_string = get_option( 'timezone_string' );
125                 if ( $timezone_string ) {
126                         $timezone_object = timezone_open( $timezone_string );
127                         $date_object = date_create( null, $timezone_object );
128                         foreach( $timezone_formats as $timezone_format ) {
129                                 if ( false !== strpos( $dateformatstring, $timezone_format ) ) {
130                                         $formatted = date_format( $date_object, $timezone_format );
131                                         $dateformatstring = ' '.$dateformatstring;
132                                         $dateformatstring = preg_replace( "/([^\\\])$timezone_format/", "\\1" . backslashit( $formatted ), $dateformatstring );
133                                         $dateformatstring = substr( $dateformatstring, 1, strlen( $dateformatstring ) -1 );
134                                 }
135                         }
136                 }
137         }
138         $j = @$datefunc( $dateformatstring, $i );
139         // allow plugins to redo this entirely for languages with untypical grammars
140         $j = apply_filters('date_i18n', $j, $req_format, $i, $gmt);
141         return $j;
142 }
143
144 /**
145  * Convert integer number to format based on the locale.
146  *
147  * @since 2.3.0
148  *
149  * @param int $number The number to convert based on locale.
150  * @param int $decimals Precision of the number of decimal places.
151  * @return string Converted number in string format.
152  */
153 function number_format_i18n( $number, $decimals = 0 ) {
154         global $wp_locale;
155         $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
156         return apply_filters( 'number_format_i18n', $formatted );
157 }
158
159 /**
160  * Convert number of bytes largest unit bytes will fit into.
161  *
162  * It is easier to read 1kB than 1024 bytes and 1MB than 1048576 bytes. Converts
163  * number of bytes to human readable number by taking the number of that unit
164  * that the bytes will go into it. Supports TB value.
165  *
166  * Please note that integers in PHP are limited to 32 bits, unless they are on
167  * 64 bit architecture, then they have 64 bit size. If you need to place the
168  * larger size then what PHP integer type will hold, then use a string. It will
169  * be converted to a double, which should always have 64 bit length.
170  *
171  * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
172  * @link http://en.wikipedia.org/wiki/Byte
173  *
174  * @since 2.3.0
175  *
176  * @param int|string $bytes Number of bytes. Note max integer size for integers.
177  * @param int $decimals Precision of number of decimal places. Deprecated.
178  * @return bool|string False on failure. Number string on success.
179  */
180 function size_format( $bytes, $decimals = 0 ) {
181         $quant = array(
182                 // ========================= Origin ====
183                 'TB' => 1099511627776,  // pow( 1024, 4)
184                 'GB' => 1073741824,     // pow( 1024, 3)
185                 'MB' => 1048576,        // pow( 1024, 2)
186                 'kB' => 1024,           // pow( 1024, 1)
187                 'B ' => 1,              // pow( 1024, 0)
188         );
189         foreach ( $quant as $unit => $mag )
190                 if ( doubleval($bytes) >= $mag )
191                         return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
192
193         return false;
194 }
195
196 /**
197  * Get the week start and end from the datetime or date string from mysql.
198  *
199  * @since 0.71
200  *
201  * @param string $mysqlstring Date or datetime field type from mysql.
202  * @param int $start_of_week Optional. Start of the week as an integer.
203  * @return array Keys are 'start' and 'end'.
204  */
205 function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
206         $my = substr( $mysqlstring, 0, 4 ); // Mysql string Year
207         $mm = substr( $mysqlstring, 8, 2 ); // Mysql string Month
208         $md = substr( $mysqlstring, 5, 2 ); // Mysql string day
209         $day = mktime( 0, 0, 0, $md, $mm, $my ); // The timestamp for mysqlstring day.
210         $weekday = date( 'w', $day ); // The day of the week from the timestamp
211         if ( !is_numeric($start_of_week) )
212                 $start_of_week = get_option( 'start_of_week' );
213
214         if ( $weekday < $start_of_week )
215                 $weekday += 7;
216
217         $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week ); // The most recent week start day on or before $day
218         $end = $start + 7 * DAY_IN_SECONDS - 1; // $start + 7 days - 1 second
219         return compact( 'start', 'end' );
220 }
221
222 /**
223  * Unserialize value only if it was serialized.
224  *
225  * @since 2.0.0
226  *
227  * @param string $original Maybe unserialized original, if is needed.
228  * @return mixed Unserialized data can be any type.
229  */
230 function maybe_unserialize( $original ) {
231         if ( is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
232                 return @unserialize( $original );
233         return $original;
234 }
235
236 /**
237  * Check value to find if it was serialized.
238  *
239  * If $data is not an string, then returned value will always be false.
240  * Serialized data is always a string.
241  *
242  * @since 2.0.5
243  *
244  * @param mixed $data Value to check to see if was serialized.
245  * @return bool False if not serialized and true if it was.
246  */
247 function is_serialized( $data ) {
248         // if it isn't a string, it isn't serialized
249         if ( ! is_string( $data ) )
250                 return false;
251         $data = trim( $data );
252         if ( 'N;' == $data )
253                 return true;
254         $length = strlen( $data );
255         if ( $length < 4 )
256                 return false;
257         if ( ':' !== $data[1] )
258                 return false;
259         $lastc = $data[$length-1];
260         if ( ';' !== $lastc && '}' !== $lastc )
261                 return false;
262         $token = $data[0];
263         switch ( $token ) {
264                 case 's' :
265                         if ( '"' !== $data[$length-2] )
266                                 return false;
267                 case 'a' :
268                 case 'O' :
269                         return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
270                 case 'b' :
271                 case 'i' :
272                 case 'd' :
273                         return (bool) preg_match( "/^{$token}:[0-9.E-]+;\$/", $data );
274         }
275         return false;
276 }
277
278 /**
279  * Check whether serialized data is of string type.
280  *
281  * @since 2.0.5
282  *
283  * @param mixed $data Serialized data
284  * @return bool False if not a serialized string, true if it is.
285  */
286 function is_serialized_string( $data ) {
287         // if it isn't a string, it isn't a serialized string
288         if ( !is_string( $data ) )
289                 return false;
290         $data = trim( $data );
291         $length = strlen( $data );
292         if ( $length < 4 )
293                 return false;
294         elseif ( ':' !== $data[1] )
295                 return false;
296         elseif ( ';' !== $data[$length-1] )
297                 return false;
298         elseif ( $data[0] !== 's' )
299                 return false;
300         elseif ( '"' !== $data[$length-2] )
301                 return false;
302         else
303                 return true;
304 }
305
306 /**
307  * Serialize data, if needed.
308  *
309  * @since 2.0.5
310  *
311  * @param mixed $data Data that might be serialized.
312  * @return mixed A scalar data
313  */
314 function maybe_serialize( $data ) {
315         if ( is_array( $data ) || is_object( $data ) )
316                 return serialize( $data );
317
318         // Double serialization is required for backward compatibility.
319         // See http://core.trac.wordpress.org/ticket/12930
320         if ( is_serialized( $data ) )
321                 return serialize( $data );
322
323         return $data;
324 }
325
326 /**
327  * Retrieve post title from XMLRPC XML.
328  *
329  * If the title element is not part of the XML, then the default post title from
330  * the $post_default_title will be used instead.
331  *
332  * @package WordPress
333  * @subpackage XMLRPC
334  * @since 0.71
335  *
336  * @global string $post_default_title Default XMLRPC post title.
337  *
338  * @param string $content XMLRPC XML Request content
339  * @return string Post title
340  */
341 function xmlrpc_getposttitle( $content ) {
342         global $post_default_title;
343         if ( preg_match( '/<title>(.+?)<\/title>/is', $content, $matchtitle ) ) {
344                 $post_title = $matchtitle[1];
345         } else {
346                 $post_title = $post_default_title;
347         }
348         return $post_title;
349 }
350
351 /**
352  * Retrieve the post category or categories from XMLRPC XML.
353  *
354  * If the category element is not found, then the default post category will be
355  * used. The return type then would be what $post_default_category. If the
356  * category is found, then it will always be an array.
357  *
358  * @package WordPress
359  * @subpackage XMLRPC
360  * @since 0.71
361  *
362  * @global string $post_default_category Default XMLRPC post category.
363  *
364  * @param string $content XMLRPC XML Request content
365  * @return string|array List of categories or category name.
366  */
367 function xmlrpc_getpostcategory( $content ) {
368         global $post_default_category;
369         if ( preg_match( '/<category>(.+?)<\/category>/is', $content, $matchcat ) ) {
370                 $post_category = trim( $matchcat[1], ',' );
371                 $post_category = explode( ',', $post_category );
372         } else {
373                 $post_category = $post_default_category;
374         }
375         return $post_category;
376 }
377
378 /**
379  * XMLRPC XML content without title and category elements.
380  *
381  * @package WordPress
382  * @subpackage XMLRPC
383  * @since 0.71
384  *
385  * @param string $content XMLRPC XML Request content
386  * @return string XMLRPC XML Request content without title and category elements.
387  */
388 function xmlrpc_removepostdata( $content ) {
389         $content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
390         $content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
391         $content = trim( $content );
392         return $content;
393 }
394
395 /**
396  * Check content for video and audio links to add as enclosures.
397  *
398  * Will not add enclosures that have already been added and will
399  * remove enclosures that are no longer in the post. This is called as
400  * pingbacks and trackbacks.
401  *
402  * @package WordPress
403  * @since 1.5.0
404  *
405  * @uses $wpdb
406  *
407  * @param string $content Post Content
408  * @param int $post_ID Post ID
409  */
410 function do_enclose( $content, $post_ID ) {
411         global $wpdb;
412
413         //TODO: Tidy this ghetto code up and make the debug code optional
414         include_once( ABSPATH . WPINC . '/class-IXR.php' );
415
416         $post_links = array();
417
418         $pung = get_enclosed( $post_ID );
419
420         $ltrs = '\w';
421         $gunk = '/#~:.?+=&%@!\-';
422         $punc = '.:?\-';
423         $any = $ltrs . $gunk . $punc;
424
425         preg_match_all( "{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp );
426
427         foreach ( $pung as $link_test ) {
428                 if ( !in_array( $link_test, $post_links_temp[0] ) ) { // link no longer in post
429                         $mids = $wpdb->get_col( $wpdb->prepare("SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE (%s)", $post_ID, like_escape( $link_test ) . '%') );
430                         foreach ( $mids as $mid )
431                                 delete_metadata_by_mid( 'post', $mid );
432                 }
433         }
434
435         foreach ( (array) $post_links_temp[0] as $link_test ) {
436                 if ( !in_array( $link_test, $pung ) ) { // If we haven't pung it already
437                         $test = @parse_url( $link_test );
438                         if ( false === $test )
439                                 continue;
440                         if ( isset( $test['query'] ) )
441                                 $post_links[] = $link_test;
442                         elseif ( isset($test['path']) && ( $test['path'] != '/' ) &&  ($test['path'] != '' ) )
443                                 $post_links[] = $link_test;
444                 }
445         }
446
447         foreach ( (array) $post_links as $url ) {
448                 if ( $url != '' && !$wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE (%s)", $post_ID, like_escape( $url ) . '%' ) ) ) {
449
450                         if ( $headers = wp_get_http_headers( $url) ) {
451                                 $len = isset( $headers['content-length'] ) ? (int) $headers['content-length'] : 0;
452                                 $type = isset( $headers['content-type'] ) ? $headers['content-type'] : '';
453                                 $allowed_types = array( 'video', 'audio' );
454
455                                 // Check to see if we can figure out the mime type from
456                                 // the extension
457                                 $url_parts = @parse_url( $url );
458                                 if ( false !== $url_parts ) {
459                                         $extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );
460                                         if ( !empty( $extension ) ) {
461                                                 foreach ( wp_get_mime_types() as $exts => $mime ) {
462                                                         if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
463                                                                 $type = $mime;
464                                                                 break;
465                                                         }
466                                                 }
467                                         }
468                                 }
469
470                                 if ( in_array( substr( $type, 0, strpos( $type, "/" ) ), $allowed_types ) ) {
471                                         add_post_meta( $post_ID, 'enclosure', "$url\n$len\n$mime\n" );
472                                 }
473                         }
474                 }
475         }
476 }
477
478 /**
479  * Perform a HTTP HEAD or GET request.
480  *
481  * If $file_path is a writable filename, this will do a GET request and write
482  * the file to that path.
483  *
484  * @since 2.5.0
485  *
486  * @param string $url URL to fetch.
487  * @param string|bool $file_path Optional. File path to write request to.
488  * @param int $red (private) The number of Redirects followed, Upon 5 being hit, returns false.
489  * @return bool|string False on failure and string of headers if HEAD request.
490  */
491 function wp_get_http( $url, $file_path = false, $red = 1 ) {
492         @set_time_limit( 60 );
493
494         if ( $red > 5 )
495                 return false;
496
497         $options = array();
498         $options['redirection'] = 5;
499
500         if ( false == $file_path )
501                 $options['method'] = 'HEAD';
502         else
503                 $options['method'] = 'GET';
504
505         $response = wp_remote_request($url, $options);
506
507         if ( is_wp_error( $response ) )
508                 return false;
509
510         $headers = wp_remote_retrieve_headers( $response );
511         $headers['response'] = wp_remote_retrieve_response_code( $response );
512
513         // WP_HTTP no longer follows redirects for HEAD requests.
514         if ( 'HEAD' == $options['method'] && in_array($headers['response'], array(301, 302)) && isset( $headers['location'] ) ) {
515                 return wp_get_http( $headers['location'], $file_path, ++$red );
516         }
517
518         if ( false == $file_path )
519                 return $headers;
520
521         // GET request - write it to the supplied filename
522         $out_fp = fopen($file_path, 'w');
523         if ( !$out_fp )
524                 return $headers;
525
526         fwrite( $out_fp,  wp_remote_retrieve_body( $response ) );
527         fclose($out_fp);
528         clearstatcache();
529
530         return $headers;
531 }
532
533 /**
534  * Retrieve HTTP Headers from URL.
535  *
536  * @since 1.5.1
537  *
538  * @param string $url
539  * @param bool $deprecated Not Used.
540  * @return bool|string False on failure, headers on success.
541  */
542 function wp_get_http_headers( $url, $deprecated = false ) {
543         if ( !empty( $deprecated ) )
544                 _deprecated_argument( __FUNCTION__, '2.7' );
545
546         $response = wp_remote_head( $url );
547
548         if ( is_wp_error( $response ) )
549                 return false;
550
551         return wp_remote_retrieve_headers( $response );
552 }
553
554 /**
555  * Whether today is a new day.
556  *
557  * @since 0.71
558  * @uses $day Today
559  * @uses $previousday Previous day
560  *
561  * @return int 1 when new day, 0 if not a new day.
562  */
563 function is_new_day() {
564         global $currentday, $previousday;
565         if ( $currentday != $previousday )
566                 return 1;
567         else
568                 return 0;
569 }
570
571 /**
572  * Build URL query based on an associative and, or indexed array.
573  *
574  * This is a convenient function for easily building url queries. It sets the
575  * separator to '&' and uses _http_build_query() function.
576  *
577  * @see _http_build_query() Used to build the query
578  * @link http://us2.php.net/manual/en/function.http-build-query.php more on what
579  *              http_build_query() does.
580  *
581  * @since 2.3.0
582  *
583  * @param array $data URL-encode key/value pairs.
584  * @return string URL encoded string
585  */
586 function build_query( $data ) {
587         return _http_build_query( $data, null, '&', '', false );
588 }
589
590 // from php.net (modified by Mark Jaquith to behave like the native PHP5 function)
591 function _http_build_query($data, $prefix=null, $sep=null, $key='', $urlencode=true) {
592         $ret = array();
593
594         foreach ( (array) $data as $k => $v ) {
595                 if ( $urlencode)
596                         $k = urlencode($k);
597                 if ( is_int($k) && $prefix != null )
598                         $k = $prefix.$k;
599                 if ( !empty($key) )
600                         $k = $key . '%5B' . $k . '%5D';
601                 if ( $v === null )
602                         continue;
603                 elseif ( $v === FALSE )
604                         $v = '0';
605
606                 if ( is_array($v) || is_object($v) )
607                         array_push($ret,_http_build_query($v, '', $sep, $k, $urlencode));
608                 elseif ( $urlencode )
609                         array_push($ret, $k.'='.urlencode($v));
610                 else
611                         array_push($ret, $k.'='.$v);
612         }
613
614         if ( null === $sep )
615                 $sep = ini_get('arg_separator.output');
616
617         return implode($sep, $ret);
618 }
619
620 /**
621  * Retrieve a modified URL query string.
622  *
623  * You can rebuild the URL and append a new query variable to the URL query by
624  * using this function. You can also retrieve the full URL with query data.
625  *
626  * Adding a single key & value or an associative array. Setting a key value to
627  * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER
628  * value. Additional values provided are expected to be encoded appropriately
629  * with urlencode() or rawurlencode().
630  *
631  * @since 1.5.0
632  *
633  * @param mixed $param1 Either newkey or an associative_array
634  * @param mixed $param2 Either newvalue or oldquery or uri
635  * @param mixed $param3 Optional. Old query or uri
636  * @return string New URL query string.
637  */
638 function add_query_arg() {
639         $ret = '';
640         $args = func_get_args();
641         if ( is_array( $args[0] ) ) {
642                 if ( count( $args ) < 2 || false === $args[1] )
643                         $uri = $_SERVER['REQUEST_URI'];
644                 else
645                         $uri = $args[1];
646         } else {
647                 if ( count( $args ) < 3 || false === $args[2] )
648                         $uri = $_SERVER['REQUEST_URI'];
649                 else
650                         $uri = $args[2];
651         }
652
653         if ( $frag = strstr( $uri, '#' ) )
654                 $uri = substr( $uri, 0, -strlen( $frag ) );
655         else
656                 $frag = '';
657
658         if ( 0 === stripos( 'http://', $uri ) ) {
659                 $protocol = 'http://';
660                 $uri = substr( $uri, 7 );
661         } elseif ( 0 === stripos( 'https://', $uri ) ) {
662                 $protocol = 'https://';
663                 $uri = substr( $uri, 8 );
664         } else {
665                 $protocol = '';
666         }
667
668         if ( strpos( $uri, '?' ) !== false ) {
669                 $parts = explode( '?', $uri, 2 );
670                 if ( 1 == count( $parts ) ) {
671                         $base = '?';
672                         $query = $parts[0];
673                 } else {
674                         $base = $parts[0] . '?';
675                         $query = $parts[1];
676                 }
677         } elseif ( $protocol || strpos( $uri, '=' ) === false ) {
678                 $base = $uri . '?';
679                 $query = '';
680         } else {
681                 $base = '';
682                 $query = $uri;
683         }
684
685         wp_parse_str( $query, $qs );
686         $qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
687         if ( is_array( $args[0] ) ) {
688                 $kayvees = $args[0];
689                 $qs = array_merge( $qs, $kayvees );
690         } else {
691                 $qs[ $args[0] ] = $args[1];
692         }
693
694         foreach ( $qs as $k => $v ) {
695                 if ( $v === false )
696                         unset( $qs[$k] );
697         }
698
699         $ret = build_query( $qs );
700         $ret = trim( $ret, '?' );
701         $ret = preg_replace( '#=(&|$)#', '$1', $ret );
702         $ret = $protocol . $base . $ret . $frag;
703         $ret = rtrim( $ret, '?' );
704         return $ret;
705 }
706
707 /**
708  * Removes an item or list from the query string.
709  *
710  * @since 1.5.0
711  *
712  * @param string|array $key Query key or keys to remove.
713  * @param bool $query When false uses the $_SERVER value.
714  * @return string New URL query string.
715  */
716 function remove_query_arg( $key, $query=false ) {
717         if ( is_array( $key ) ) { // removing multiple keys
718                 foreach ( $key as $k )
719                         $query = add_query_arg( $k, false, $query );
720                 return $query;
721         }
722         return add_query_arg( $key, false, $query );
723 }
724
725 /**
726  * Walks the array while sanitizing the contents.
727  *
728  * @since 0.71
729  *
730  * @param array $array Array to used to walk while sanitizing contents.
731  * @return array Sanitized $array.
732  */
733 function add_magic_quotes( $array ) {
734         foreach ( (array) $array as $k => $v ) {
735                 if ( is_array( $v ) ) {
736                         $array[$k] = add_magic_quotes( $v );
737                 } else {
738                         $array[$k] = addslashes( $v );
739                 }
740         }
741         return $array;
742 }
743
744 /**
745  * HTTP request for URI to retrieve content.
746  *
747  * @since 1.5.1
748  * @uses wp_remote_get()
749  *
750  * @param string $uri URI/URL of web page to retrieve.
751  * @return bool|string HTTP content. False on failure.
752  */
753 function wp_remote_fopen( $uri ) {
754         $parsed_url = @parse_url( $uri );
755
756         if ( !$parsed_url || !is_array( $parsed_url ) )
757                 return false;
758
759         $options = array();
760         $options['timeout'] = 10;
761
762         $response = wp_remote_get( $uri, $options );
763
764         if ( is_wp_error( $response ) )
765                 return false;
766
767         return wp_remote_retrieve_body( $response );
768 }
769
770 /**
771  * Set up the WordPress query.
772  *
773  * @since 2.0.0
774  *
775  * @param string $query_vars Default WP_Query arguments.
776  */
777 function wp( $query_vars = '' ) {
778         global $wp, $wp_query, $wp_the_query;
779         $wp->main( $query_vars );
780
781         if ( !isset($wp_the_query) )
782                 $wp_the_query = $wp_query;
783 }
784
785 /**
786  * Retrieve the description for the HTTP status.
787  *
788  * @since 2.3.0
789  *
790  * @param int $code HTTP status code.
791  * @return string Empty string if not found, or description if found.
792  */
793 function get_status_header_desc( $code ) {
794         global $wp_header_to_desc;
795
796         $code = absint( $code );
797
798         if ( !isset( $wp_header_to_desc ) ) {
799                 $wp_header_to_desc = array(
800                         100 => 'Continue',
801                         101 => 'Switching Protocols',
802                         102 => 'Processing',
803
804                         200 => 'OK',
805                         201 => 'Created',
806                         202 => 'Accepted',
807                         203 => 'Non-Authoritative Information',
808                         204 => 'No Content',
809                         205 => 'Reset Content',
810                         206 => 'Partial Content',
811                         207 => 'Multi-Status',
812                         226 => 'IM Used',
813
814                         300 => 'Multiple Choices',
815                         301 => 'Moved Permanently',
816                         302 => 'Found',
817                         303 => 'See Other',
818                         304 => 'Not Modified',
819                         305 => 'Use Proxy',
820                         306 => 'Reserved',
821                         307 => 'Temporary Redirect',
822
823                         400 => 'Bad Request',
824                         401 => 'Unauthorized',
825                         402 => 'Payment Required',
826                         403 => 'Forbidden',
827                         404 => 'Not Found',
828                         405 => 'Method Not Allowed',
829                         406 => 'Not Acceptable',
830                         407 => 'Proxy Authentication Required',
831                         408 => 'Request Timeout',
832                         409 => 'Conflict',
833                         410 => 'Gone',
834                         411 => 'Length Required',
835                         412 => 'Precondition Failed',
836                         413 => 'Request Entity Too Large',
837                         414 => 'Request-URI Too Long',
838                         415 => 'Unsupported Media Type',
839                         416 => 'Requested Range Not Satisfiable',
840                         417 => 'Expectation Failed',
841                         422 => 'Unprocessable Entity',
842                         423 => 'Locked',
843                         424 => 'Failed Dependency',
844                         426 => 'Upgrade Required',
845
846                         500 => 'Internal Server Error',
847                         501 => 'Not Implemented',
848                         502 => 'Bad Gateway',
849                         503 => 'Service Unavailable',
850                         504 => 'Gateway Timeout',
851                         505 => 'HTTP Version Not Supported',
852                         506 => 'Variant Also Negotiates',
853                         507 => 'Insufficient Storage',
854                         510 => 'Not Extended'
855                 );
856         }
857
858         if ( isset( $wp_header_to_desc[$code] ) )
859                 return $wp_header_to_desc[$code];
860         else
861                 return '';
862 }
863
864 /**
865  * Set HTTP status header.
866  *
867  * @since 2.0.0
868  * @uses apply_filters() Calls 'status_header' on status header string, HTTP
869  *              HTTP code, HTTP code description, and protocol string as separate
870  *              parameters.
871  *
872  * @param int $header HTTP status code
873  * @return unknown
874  */
875 function status_header( $header ) {
876         $text = get_status_header_desc( $header );
877
878         if ( empty( $text ) )
879                 return false;
880
881         $protocol = $_SERVER["SERVER_PROTOCOL"];
882         if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
883                 $protocol = 'HTTP/1.0';
884         $status_header = "$protocol $header $text";
885         if ( function_exists( 'apply_filters' ) )
886                 $status_header = apply_filters( 'status_header', $status_header, $header, $text, $protocol );
887
888         return @header( $status_header, true, $header );
889 }
890
891 /**
892  * Gets the header information to prevent caching.
893  *
894  * The several different headers cover the different ways cache prevention is handled
895  * by different browsers
896  *
897  * @since 2.8.0
898  *
899  * @uses apply_filters()
900  * @return array The associative array of header names and field values.
901  */
902 function wp_get_nocache_headers() {
903         $headers = array(
904                 'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
905                 'Last-Modified' => '',
906                 'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
907                 'Pragma' => 'no-cache',
908         );
909
910         if ( function_exists('apply_filters') ) {
911                 $headers = (array) apply_filters('nocache_headers', $headers);
912         }
913         return $headers;
914 }
915
916 /**
917  * Sets the headers to prevent caching for the different browsers.
918  *
919  * Different browsers support different nocache headers, so several headers must
920  * be sent so that all of them get the point that no caching should occur.
921  *
922  * @since 2.0.0
923  * @uses wp_get_nocache_headers()
924  */
925 function nocache_headers() {
926         $headers = wp_get_nocache_headers();
927         foreach( $headers as $name => $field_value )
928                 @header("{$name}: {$field_value}");
929         if ( empty( $headers['Last-Modified'] ) && function_exists( 'header_remove' ) )
930                 @header_remove( 'Last-Modified' );
931 }
932
933 /**
934  * Set the headers for caching for 10 days with JavaScript content type.
935  *
936  * @since 2.1.0
937  */
938 function cache_javascript_headers() {
939         $expiresOffset = 10 * DAY_IN_SECONDS;
940         header( "Content-Type: text/javascript; charset=" . get_bloginfo( 'charset' ) );
941         header( "Vary: Accept-Encoding" ); // Handle proxies
942         header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $expiresOffset ) . " GMT" );
943 }
944
945 /**
946  * Retrieve the number of database queries during the WordPress execution.
947  *
948  * @since 2.0.0
949  *
950  * @return int Number of database queries
951  */
952 function get_num_queries() {
953         global $wpdb;
954         return $wpdb->num_queries;
955 }
956
957 /**
958  * Whether input is yes or no. Must be 'y' to be true.
959  *
960  * @since 1.0.0
961  *
962  * @param string $yn Character string containing either 'y' or 'n'
963  * @return bool True if yes, false on anything else
964  */
965 function bool_from_yn( $yn ) {
966         return ( strtolower( $yn ) == 'y' );
967 }
968
969 /**
970  * Loads the feed template from the use of an action hook.
971  *
972  * If the feed action does not have a hook, then the function will die with a
973  * message telling the visitor that the feed is not valid.
974  *
975  * It is better to only have one hook for each feed.
976  *
977  * @since 2.1.0
978  * @uses $wp_query Used to tell if the use a comment feed.
979  * @uses do_action() Calls 'do_feed_$feed' hook, if a hook exists for the feed.
980  */
981 function do_feed() {
982         global $wp_query;
983
984         $feed = get_query_var( 'feed' );
985
986         // Remove the pad, if present.
987         $feed = preg_replace( '/^_+/', '', $feed );
988
989         if ( $feed == '' || $feed == 'feed' )
990                 $feed = get_default_feed();
991
992         $hook = 'do_feed_' . $feed;
993         if ( !has_action($hook) ) {
994                 $message = sprintf( __( 'ERROR: %s is not a valid feed template.' ), esc_html($feed));
995                 wp_die( $message, '', array( 'response' => 404 ) );
996         }
997
998         do_action( $hook, $wp_query->is_comment_feed );
999 }
1000
1001 /**
1002  * Load the RDF RSS 0.91 Feed template.
1003  *
1004  * @since 2.1.0
1005  */
1006 function do_feed_rdf() {
1007         load_template( ABSPATH . WPINC . '/feed-rdf.php' );
1008 }
1009
1010 /**
1011  * Load the RSS 1.0 Feed Template.
1012  *
1013  * @since 2.1.0
1014  */
1015 function do_feed_rss() {
1016         load_template( ABSPATH . WPINC . '/feed-rss.php' );
1017 }
1018
1019 /**
1020  * Load either the RSS2 comment feed or the RSS2 posts feed.
1021  *
1022  * @since 2.1.0
1023  *
1024  * @param bool $for_comments True for the comment feed, false for normal feed.
1025  */
1026 function do_feed_rss2( $for_comments ) {
1027         if ( $for_comments )
1028                 load_template( ABSPATH . WPINC . '/feed-rss2-comments.php' );
1029         else
1030                 load_template( ABSPATH . WPINC . '/feed-rss2.php' );
1031 }
1032
1033 /**
1034  * Load either Atom comment feed or Atom posts feed.
1035  *
1036  * @since 2.1.0
1037  *
1038  * @param bool $for_comments True for the comment feed, false for normal feed.
1039  */
1040 function do_feed_atom( $for_comments ) {
1041         if ($for_comments)
1042                 load_template( ABSPATH . WPINC . '/feed-atom-comments.php');
1043         else
1044                 load_template( ABSPATH . WPINC . '/feed-atom.php' );
1045 }
1046
1047 /**
1048  * Display the robots.txt file content.
1049  *
1050  * The echo content should be with usage of the permalinks or for creating the
1051  * robots.txt file.
1052  *
1053  * @since 2.1.0
1054  * @uses do_action() Calls 'do_robotstxt' hook for displaying robots.txt rules.
1055  */
1056 function do_robots() {
1057         header( 'Content-Type: text/plain; charset=utf-8' );
1058
1059         do_action( 'do_robotstxt' );
1060
1061         $output = "User-agent: *\n";
1062         $public = get_option( 'blog_public' );
1063         if ( '0' == $public ) {
1064                 $output .= "Disallow: /\n";
1065         } else {
1066                 $site_url = parse_url( site_url() );
1067                 $path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : '';
1068                 $output .= "Disallow: $path/wp-admin/\n";
1069                 $output .= "Disallow: $path/wp-includes/\n";
1070         }
1071
1072         echo apply_filters('robots_txt', $output, $public);
1073 }
1074
1075 /**
1076  * Test whether blog is already installed.
1077  *
1078  * The cache will be checked first. If you have a cache plugin, which saves the
1079  * cache values, then this will work. If you use the default WordPress cache,
1080  * and the database goes away, then you might have problems.
1081  *
1082  * Checks for the option siteurl for whether WordPress is installed.
1083  *
1084  * @since 2.1.0
1085  * @uses $wpdb
1086  *
1087  * @return bool Whether blog is already installed.
1088  */
1089 function is_blog_installed() {
1090         global $wpdb;
1091
1092         // Check cache first. If options table goes away and we have true cached, oh well.
1093         if ( wp_cache_get( 'is_blog_installed' ) )
1094                 return true;
1095
1096         $suppress = $wpdb->suppress_errors();
1097         if ( ! defined( 'WP_INSTALLING' ) ) {
1098                 $alloptions = wp_load_alloptions();
1099         }
1100         // If siteurl is not set to autoload, check it specifically
1101         if ( !isset( $alloptions['siteurl'] ) )
1102                 $installed = $wpdb->get_var( "SELECT option_value FROM $wpdb->options WHERE option_name = 'siteurl'" );
1103         else
1104                 $installed = $alloptions['siteurl'];
1105         $wpdb->suppress_errors( $suppress );
1106
1107         $installed = !empty( $installed );
1108         wp_cache_set( 'is_blog_installed', $installed );
1109
1110         if ( $installed )
1111                 return true;
1112
1113         // If visiting repair.php, return true and let it take over.
1114         if ( defined( 'WP_REPAIRING' ) )
1115                 return true;
1116
1117         $suppress = $wpdb->suppress_errors();
1118
1119         // Loop over the WP tables. If none exist, then scratch install is allowed.
1120         // If one or more exist, suggest table repair since we got here because the options
1121         // table could not be accessed.
1122         $wp_tables = $wpdb->tables();
1123         foreach ( $wp_tables as $table ) {
1124                 // The existence of custom user tables shouldn't suggest an insane state or prevent a clean install.
1125                 if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table )
1126                         continue;
1127                 if ( defined( 'CUSTOM_USER_META_TABLE' ) && CUSTOM_USER_META_TABLE == $table )
1128                         continue;
1129
1130                 if ( ! $wpdb->get_results( "DESCRIBE $table;" ) )
1131                         continue;
1132
1133                 // One or more tables exist. We are insane.
1134
1135                 wp_load_translations_early();
1136
1137                 // Die with a DB error.
1138                 $wpdb->error = sprintf( __( 'One or more database tables are unavailable. The database may need to be <a href="%s">repaired</a>.' ), 'maint/repair.php?referrer=is_blog_installed' );
1139                 dead_db();
1140         }
1141
1142         $wpdb->suppress_errors( $suppress );
1143
1144         wp_cache_set( 'is_blog_installed', false );
1145
1146         return false;
1147 }
1148
1149 /**
1150  * Retrieve URL with nonce added to URL query.
1151  *
1152  * @package WordPress
1153  * @subpackage Security
1154  * @since 2.0.4
1155  *
1156  * @param string $actionurl URL to add nonce action
1157  * @param string $action Optional. Nonce action name
1158  * @return string URL with nonce action added.
1159  */
1160 function wp_nonce_url( $actionurl, $action = -1 ) {
1161         $actionurl = str_replace( '&amp;', '&', $actionurl );
1162         return esc_html( add_query_arg( '_wpnonce', wp_create_nonce( $action ), $actionurl ) );
1163 }
1164
1165 /**
1166  * Retrieve or display nonce hidden field for forms.
1167  *
1168  * The nonce field is used to validate that the contents of the form came from
1169  * the location on the current site and not somewhere else. The nonce does not
1170  * offer absolute protection, but should protect against most cases. It is very
1171  * important to use nonce field in forms.
1172  *
1173  * The $action and $name are optional, but if you want to have better security,
1174  * it is strongly suggested to set those two parameters. It is easier to just
1175  * call the function without any parameters, because validation of the nonce
1176  * doesn't require any parameters, but since crackers know what the default is
1177  * it won't be difficult for them to find a way around your nonce and cause
1178  * damage.
1179  *
1180  * The input name will be whatever $name value you gave. The input value will be
1181  * the nonce creation value.
1182  *
1183  * @package WordPress
1184  * @subpackage Security
1185  * @since 2.0.4
1186  *
1187  * @param string $action Optional. Action name.
1188  * @param string $name Optional. Nonce name.
1189  * @param bool $referer Optional, default true. Whether to set the referer field for validation.
1190  * @param bool $echo Optional, default true. Whether to display or return hidden form field.
1191  * @return string Nonce field.
1192  */
1193 function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
1194         $name = esc_attr( $name );
1195         $nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
1196
1197         if ( $referer )
1198                 $nonce_field .= wp_referer_field( false );
1199
1200         if ( $echo )
1201                 echo $nonce_field;
1202
1203         return $nonce_field;
1204 }
1205
1206 /**
1207  * Retrieve or display referer hidden field for forms.
1208  *
1209  * The referer link is the current Request URI from the server super global. The
1210  * input name is '_wp_http_referer', in case you wanted to check manually.
1211  *
1212  * @package WordPress
1213  * @subpackage Security
1214  * @since 2.0.4
1215  *
1216  * @param bool $echo Whether to echo or return the referer field.
1217  * @return string Referer field.
1218  */
1219 function wp_referer_field( $echo = true ) {
1220         $ref = esc_attr( $_SERVER['REQUEST_URI'] );
1221         $referer_field = '<input type="hidden" name="_wp_http_referer" value="'. $ref . '" />';
1222
1223         if ( $echo )
1224                 echo $referer_field;
1225         return $referer_field;
1226 }
1227
1228 /**
1229  * Retrieve or display original referer hidden field for forms.
1230  *
1231  * The input name is '_wp_original_http_referer' and will be either the same
1232  * value of {@link wp_referer_field()}, if that was posted already or it will
1233  * be the current page, if it doesn't exist.
1234  *
1235  * @package WordPress
1236  * @subpackage Security
1237  * @since 2.0.4
1238  *
1239  * @param bool $echo Whether to echo the original http referer
1240  * @param string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to.
1241  * @return string Original referer field.
1242  */
1243 function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
1244         $jump_back_to = ( 'previous' == $jump_back_to ) ? wp_get_referer() : $_SERVER['REQUEST_URI'];
1245         $ref = ( wp_get_original_referer() ) ? wp_get_original_referer() : $jump_back_to;
1246         $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( stripslashes( $ref ) ) . '" />';
1247         if ( $echo )
1248                 echo $orig_referer_field;
1249         return $orig_referer_field;
1250 }
1251
1252 /**
1253  * Retrieve referer from '_wp_http_referer' or HTTP referer. If it's the same
1254  * as the current request URL, will return false.
1255  *
1256  * @package WordPress
1257  * @subpackage Security
1258  * @since 2.0.4
1259  *
1260  * @return string|bool False on failure. Referer URL on success.
1261  */
1262 function wp_get_referer() {
1263         $ref = false;
1264         if ( ! empty( $_REQUEST['_wp_http_referer'] ) )
1265                 $ref = $_REQUEST['_wp_http_referer'];
1266         else if ( ! empty( $_SERVER['HTTP_REFERER'] ) )
1267                 $ref = $_SERVER['HTTP_REFERER'];
1268
1269         if ( $ref && $ref !== $_SERVER['REQUEST_URI'] )
1270                 return $ref;
1271         return false;
1272 }
1273
1274 /**
1275  * Retrieve original referer that was posted, if it exists.
1276  *
1277  * @package WordPress
1278  * @subpackage Security
1279  * @since 2.0.4
1280  *
1281  * @return string|bool False if no original referer or original referer if set.
1282  */
1283 function wp_get_original_referer() {
1284         if ( !empty( $_REQUEST['_wp_original_http_referer'] ) )
1285                 return $_REQUEST['_wp_original_http_referer'];
1286         return false;
1287 }
1288
1289 /**
1290  * Recursive directory creation based on full path.
1291  *
1292  * Will attempt to set permissions on folders.
1293  *
1294  * @since 2.0.1
1295  *
1296  * @param string $target Full path to attempt to create.
1297  * @return bool Whether the path was created. True if path already exists.
1298  */
1299 function wp_mkdir_p( $target ) {
1300         $wrapper = null;
1301
1302         // strip the protocol
1303         if( wp_is_stream( $target ) ) {
1304                 list( $wrapper, $target ) = explode( '://', $target, 2 );
1305         }
1306
1307         // from php.net/mkdir user contributed notes
1308         $target = str_replace( '//', '/', $target );
1309
1310         // put the wrapper back on the target
1311         if( $wrapper !== null ) {
1312                 $target = $wrapper . '://' . $target;
1313         }
1314
1315         // safe mode fails with a trailing slash under certain PHP versions.
1316         $target = rtrim($target, '/'); // Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
1317         if ( empty($target) )
1318                 $target = '/';
1319
1320         if ( file_exists( $target ) )
1321                 return @is_dir( $target );
1322
1323         // Attempting to create the directory may clutter up our display.
1324         if ( @mkdir( $target ) ) {
1325                 $stat = @stat( dirname( $target ) );
1326                 $dir_perms = $stat['mode'] & 0007777;  // Get the permission bits.
1327                 @chmod( $target, $dir_perms );
1328                 return true;
1329         } elseif ( is_dir( dirname( $target ) ) ) {
1330                         return false;
1331         }
1332
1333         // If the above failed, attempt to create the parent node, then try again.
1334         if ( ( $target != '/' ) && ( wp_mkdir_p( dirname( $target ) ) ) )
1335                 return wp_mkdir_p( $target );
1336
1337         return false;
1338 }
1339
1340 /**
1341  * Test if a give filesystem path is absolute ('/foo/bar', 'c:\windows').
1342  *
1343  * @since 2.5.0
1344  *
1345  * @param string $path File path
1346  * @return bool True if path is absolute, false is not absolute.
1347  */
1348 function path_is_absolute( $path ) {
1349         // this is definitive if true but fails if $path does not exist or contains a symbolic link
1350         if ( realpath($path) == $path )
1351                 return true;
1352
1353         if ( strlen($path) == 0 || $path[0] == '.' )
1354                 return false;
1355
1356         // windows allows absolute paths like this
1357         if ( preg_match('#^[a-zA-Z]:\\\\#', $path) )
1358                 return true;
1359
1360         // a path starting with / or \ is absolute; anything else is relative
1361         return ( $path[0] == '/' || $path[0] == '\\' );
1362 }
1363
1364 /**
1365  * Join two filesystem paths together (e.g. 'give me $path relative to $base').
1366  *
1367  * If the $path is absolute, then it the full path is returned.
1368  *
1369  * @since 2.5.0
1370  *
1371  * @param string $base
1372  * @param string $path
1373  * @return string The path with the base or absolute path.
1374  */
1375 function path_join( $base, $path ) {
1376         if ( path_is_absolute($path) )
1377                 return $path;
1378
1379         return rtrim($base, '/') . '/' . ltrim($path, '/');
1380 }
1381
1382 /**
1383  * Determines a writable directory for temporary files.
1384  * Function's preference is the return value of <code>sys_get_temp_dir()</code>,
1385  * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR,
1386  * before finally defaulting to /tmp/
1387  *
1388  * In the event that this function does not find a writable location,
1389  * It may be overridden by the <code>WP_TEMP_DIR</code> constant in
1390  * your <code>wp-config.php</code> file.
1391  *
1392  * @since 2.5.0
1393  *
1394  * @return string Writable temporary directory
1395  */
1396 function get_temp_dir() {
1397         static $temp;
1398         if ( defined('WP_TEMP_DIR') )
1399                 return trailingslashit(WP_TEMP_DIR);
1400
1401         if ( $temp )
1402                 return trailingslashit( rtrim( $temp, '\\' ) );
1403
1404         $is_win = ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) );
1405
1406         if ( function_exists('sys_get_temp_dir') ) {
1407                 $temp = sys_get_temp_dir();
1408                 if ( @is_dir( $temp ) && ( $is_win ? win_is_writable( $temp ) : @is_writable( $temp ) ) ) {
1409                         return trailingslashit( rtrim( $temp, '\\' ) );
1410                 }
1411         }
1412
1413         $temp = ini_get('upload_tmp_dir');
1414         if ( is_dir( $temp ) && ( $is_win ? win_is_writable( $temp ) : @is_writable( $temp ) ) )
1415                 return trailingslashit( rtrim( $temp, '\\' ) );
1416
1417         $temp = WP_CONTENT_DIR . '/';
1418         if ( is_dir( $temp ) && ( $is_win ? win_is_writable( $temp ) : @is_writable( $temp ) ) )
1419                 return $temp;
1420
1421         $temp = '/tmp/';
1422         return $temp;
1423 }
1424
1425 /**
1426  * Workaround for Windows bug in is_writable() function
1427  *
1428  * @since 2.8.0
1429  *
1430  * @param string $path
1431  * @return bool
1432  */
1433 function win_is_writable( $path ) {
1434         /* will work in despite of Windows ACLs bug
1435          * NOTE: use a trailing slash for folders!!!
1436          * see http://bugs.php.net/bug.php?id=27609
1437          * see http://bugs.php.net/bug.php?id=30931
1438          */
1439
1440         if ( $path[strlen( $path ) - 1] == '/' ) // recursively return a temporary file path
1441                 return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp');
1442         else if ( is_dir( $path ) )
1443                 return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
1444         // check tmp file for read/write capabilities
1445         $should_delete_tmp_file = !file_exists( $path );
1446         $f = @fopen( $path, 'a' );
1447         if ( $f === false )
1448                 return false;
1449         fclose( $f );
1450         if ( $should_delete_tmp_file )
1451                 unlink( $path );
1452         return true;
1453 }
1454
1455 /**
1456  * Get an array containing the current upload directory's path and url.
1457  *
1458  * Checks the 'upload_path' option, which should be from the web root folder,
1459  * and if it isn't empty it will be used. If it is empty, then the path will be
1460  * 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will
1461  * override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.
1462  *
1463  * The upload URL path is set either by the 'upload_url_path' option or by using
1464  * the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.
1465  *
1466  * If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in
1467  * the administration settings panel), then the time will be used. The format
1468  * will be year first and then month.
1469  *
1470  * If the path couldn't be created, then an error will be returned with the key
1471  * 'error' containing the error message. The error suggests that the parent
1472  * directory is not writable by the server.
1473  *
1474  * On success, the returned array will have many indices:
1475  * 'path' - base directory and sub directory or full path to upload directory.
1476  * 'url' - base url and sub directory or absolute URL to upload directory.
1477  * 'subdir' - sub directory if uploads use year/month folders option is on.
1478  * 'basedir' - path without subdir.
1479  * 'baseurl' - URL path without subdir.
1480  * 'error' - set to false.
1481  *
1482  * @since 2.0.0
1483  * @uses apply_filters() Calls 'upload_dir' on returned array.
1484  *
1485  * @param string $time Optional. Time formatted in 'yyyy/mm'.
1486  * @return array See above for description.
1487  */
1488 function wp_upload_dir( $time = null ) {
1489         $siteurl = get_option( 'siteurl' );
1490         $upload_path = trim( get_option( 'upload_path' ) );
1491
1492         if ( empty( $upload_path ) || 'wp-content/uploads' == $upload_path ) {
1493                 $dir = WP_CONTENT_DIR . '/uploads';
1494         } elseif ( 0 !== strpos( $upload_path, ABSPATH ) ) {
1495                 // $dir is absolute, $upload_path is (maybe) relative to ABSPATH
1496                 $dir = path_join( ABSPATH, $upload_path );
1497         } else {
1498                 $dir = $upload_path;
1499         }
1500
1501         if ( !$url = get_option( 'upload_url_path' ) ) {
1502                 if ( empty($upload_path) || ( 'wp-content/uploads' == $upload_path ) || ( $upload_path == $dir ) )
1503                         $url = WP_CONTENT_URL . '/uploads';
1504                 else
1505                         $url = trailingslashit( $siteurl ) . $upload_path;
1506         }
1507
1508         // Obey the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
1509         // We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
1510         if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {
1511                 $dir = ABSPATH . UPLOADS;
1512                 $url = trailingslashit( $siteurl ) . UPLOADS;
1513         }
1514
1515         // If multisite (and if not the main site in a post-MU network)
1516         if ( is_multisite() && ! ( is_main_site() && defined( 'MULTISITE' ) ) ) {
1517
1518                 if ( ! get_site_option( 'ms_files_rewriting' ) ) {
1519                         // If ms-files rewriting is disabled (networks created post-3.5), it is fairly straightforward:
1520                         // Append sites/%d if we're not on the main site (for post-MU networks). (The extra directory
1521                         // prevents a four-digit ID from conflicting with a year-based directory for the main site.
1522                         // But if a MU-era network has disabled ms-files rewriting manually, they don't need the extra
1523                         // directory, as they never had wp-content/uploads for the main site.)
1524
1525                         if ( defined( 'MULTISITE' ) )
1526                                 $ms_dir = '/sites/' . get_current_blog_id();
1527                         else
1528                                 $ms_dir = '/' . get_current_blog_id();
1529
1530                         $dir .= $ms_dir;
1531                         $url .= $ms_dir;
1532
1533                 } elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {
1534                         // Handle the old-form ms-files.php rewriting if the network still has that enabled.
1535                         // When ms-files rewriting is enabled, then we only listen to UPLOADS when:
1536                         //   1) we are not on the main site in a post-MU network,
1537                         //      as wp-content/uploads is used there, and
1538                         //   2) we are not switched, as ms_upload_constants() hardcodes
1539                         //      these constants to reflect the original blog ID.
1540                         //
1541                         // Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
1542                         // (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
1543                         // as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
1544                         // rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
1545
1546                         if ( defined( 'BLOGUPLOADDIR' ) )
1547                                 $dir = untrailingslashit( BLOGUPLOADDIR );
1548                         else
1549                                 $dir = ABSPATH . UPLOADS;
1550                         $url = trailingslashit( $siteurl ) . 'files';
1551                 }
1552         }
1553
1554         $basedir = $dir;
1555         $baseurl = $url;
1556
1557         $subdir = '';
1558         if ( get_option( 'uploads_use_yearmonth_folders' ) ) {
1559                 // Generate the yearly and monthly dirs
1560                 if ( !$time )
1561                         $time = current_time( 'mysql' );
1562                 $y = substr( $time, 0, 4 );
1563                 $m = substr( $time, 5, 2 );
1564                 $subdir = "/$y/$m";
1565         }
1566
1567         $dir .= $subdir;
1568         $url .= $subdir;
1569
1570         $uploads = apply_filters( 'upload_dir',
1571                 array(
1572                         'path'    => $dir,
1573                         'url'     => $url,
1574                         'subdir'  => $subdir,
1575                         'basedir' => $basedir,
1576                         'baseurl' => $baseurl,
1577                         'error'   => false,
1578                 ) );
1579
1580         // Make sure we have an uploads dir
1581         if ( ! wp_mkdir_p( $uploads['path'] ) ) {
1582                 if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
1583                         $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
1584                 else
1585                         $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
1586
1587                 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path );
1588                 $uploads['error'] = $message;
1589         }
1590
1591         return $uploads;
1592 }
1593
1594 /**
1595  * Get a filename that is sanitized and unique for the given directory.
1596  *
1597  * If the filename is not unique, then a number will be added to the filename
1598  * before the extension, and will continue adding numbers until the filename is
1599  * unique.
1600  *
1601  * The callback is passed three parameters, the first one is the directory, the
1602  * second is the filename, and the third is the extension.
1603  *
1604  * @since 2.5.0
1605  *
1606  * @param string $dir
1607  * @param string $filename
1608  * @param mixed $unique_filename_callback Callback.
1609  * @return string New filename, if given wasn't unique.
1610  */
1611 function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
1612         // sanitize the file name before we begin processing
1613         $filename = sanitize_file_name($filename);
1614
1615         // separate the filename into a name and extension
1616         $info = pathinfo($filename);
1617         $ext = !empty($info['extension']) ? '.' . $info['extension'] : '';
1618         $name = basename($filename, $ext);
1619
1620         // edge case: if file is named '.ext', treat as an empty name
1621         if ( $name === $ext )
1622                 $name = '';
1623
1624         // Increment the file number until we have a unique file to save in $dir. Use callback if supplied.
1625         if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
1626                 $filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
1627         } else {
1628                 $number = '';
1629
1630                 // change '.ext' to lower case
1631                 if ( $ext && strtolower($ext) != $ext ) {
1632                         $ext2 = strtolower($ext);
1633                         $filename2 = preg_replace( '|' . preg_quote($ext) . '$|', $ext2, $filename );
1634
1635                         // check for both lower and upper case extension or image sub-sizes may be overwritten
1636                         while ( file_exists($dir . "/$filename") || file_exists($dir . "/$filename2") ) {
1637                                 $new_number = $number + 1;
1638                                 $filename = str_replace( "$number$ext", "$new_number$ext", $filename );
1639                                 $filename2 = str_replace( "$number$ext2", "$new_number$ext2", $filename2 );
1640                                 $number = $new_number;
1641                         }
1642                         return $filename2;
1643                 }
1644
1645                 while ( file_exists( $dir . "/$filename" ) ) {
1646                         if ( '' == "$number$ext" )
1647                                 $filename = $filename . ++$number . $ext;
1648                         else
1649                                 $filename = str_replace( "$number$ext", ++$number . $ext, $filename );
1650                 }
1651         }
1652
1653         return $filename;
1654 }
1655
1656 /**
1657  * Create a file in the upload folder with given content.
1658  *
1659  * If there is an error, then the key 'error' will exist with the error message.
1660  * If success, then the key 'file' will have the unique file path, the 'url' key
1661  * will have the link to the new file. and the 'error' key will be set to false.
1662  *
1663  * This function will not move an uploaded file to the upload folder. It will
1664  * create a new file with the content in $bits parameter. If you move the upload
1665  * file, read the content of the uploaded file, and then you can give the
1666  * filename and content to this function, which will add it to the upload
1667  * folder.
1668  *
1669  * The permissions will be set on the new file automatically by this function.
1670  *
1671  * @since 2.0.0
1672  *
1673  * @param string $name
1674  * @param null $deprecated Never used. Set to null.
1675  * @param mixed $bits File content
1676  * @param string $time Optional. Time formatted in 'yyyy/mm'.
1677  * @return array
1678  */
1679 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
1680         if ( !empty( $deprecated ) )
1681                 _deprecated_argument( __FUNCTION__, '2.0' );
1682
1683         if ( empty( $name ) )
1684                 return array( 'error' => __( 'Empty filename' ) );
1685
1686         $wp_filetype = wp_check_filetype( $name );
1687         if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) )
1688                 return array( 'error' => __( 'Invalid file type' ) );
1689
1690         $upload = wp_upload_dir( $time );
1691
1692         if ( $upload['error'] !== false )
1693                 return $upload;
1694
1695         $upload_bits_error = apply_filters( 'wp_upload_bits', array( 'name' => $name, 'bits' => $bits, 'time' => $time ) );
1696         if ( !is_array( $upload_bits_error ) ) {
1697                 $upload[ 'error' ] = $upload_bits_error;
1698                 return $upload;
1699         }
1700
1701         $filename = wp_unique_filename( $upload['path'], $name );
1702
1703         $new_file = $upload['path'] . "/$filename";
1704         if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {
1705                 if ( 0 === strpos( $upload['basedir'], ABSPATH ) )
1706                         $error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir'];
1707                 else
1708                         $error_path = basename( $upload['basedir'] ) . $upload['subdir'];
1709
1710                 $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path );
1711                 return array( 'error' => $message );
1712         }
1713
1714         $ifp = @ fopen( $new_file, 'wb' );
1715         if ( ! $ifp )
1716                 return array( 'error' => sprintf( __( 'Could not write file %s' ), $new_file ) );
1717
1718         @fwrite( $ifp, $bits );
1719         fclose( $ifp );
1720         clearstatcache();
1721
1722         // Set correct file permissions
1723         $stat = @ stat( dirname( $new_file ) );
1724         $perms = $stat['mode'] & 0007777;
1725         $perms = $perms & 0000666;
1726         @ chmod( $new_file, $perms );
1727         clearstatcache();
1728
1729         // Compute the URL
1730         $url = $upload['url'] . "/$filename";
1731
1732         return array( 'file' => $new_file, 'url' => $url, 'error' => false );
1733 }
1734
1735 /**
1736  * Retrieve the file type based on the extension name.
1737  *
1738  * @package WordPress
1739  * @since 2.5.0
1740  * @uses apply_filters() Calls 'ext2type' hook on default supported types.
1741  *
1742  * @param string $ext The extension to search.
1743  * @return string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found.
1744  */
1745 function wp_ext2type( $ext ) {
1746         $ext2type = apply_filters( 'ext2type', array(
1747                 'audio'       => array( 'aac', 'ac3',  'aif',  'aiff', 'm3a',  'm4a',   'm4b',  'mka',  'mp1',  'mp2',  'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
1748                 'video'       => array( 'asf', 'avi',  'divx', 'dv',   'flv',  'm4v',   'mkv',  'mov',  'mp4',  'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt',  'rm', 'vob', 'wmv' ),
1749                 'document'    => array( 'doc', 'docx', 'docm', 'dotm', 'odt',  'pages', 'pdf',  'rtf',  'wp',   'wpd' ),
1750                 'spreadsheet' => array( 'numbers',     'ods',  'xls',  'xlsx', 'xlsm',  'xlsb' ),
1751                 'interactive' => array( 'swf', 'key',  'ppt',  'pptx', 'pptm', 'pps',   'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ),
1752                 'text'        => array( 'asc', 'csv',  'tsv',  'txt' ),
1753                 'archive'     => array( 'bz2', 'cab',  'dmg',  'gz',   'rar',  'sea',   'sit',  'sqx',  'tar',  'tgz',  'zip', '7z' ),
1754                 'code'        => array( 'css', 'htm',  'html', 'php',  'js' ),
1755         ));
1756         foreach ( $ext2type as $type => $exts )
1757                 if ( in_array( $ext, $exts ) )
1758                         return $type;
1759 }
1760
1761 /**
1762  * Retrieve the file type from the file name.
1763  *
1764  * You can optionally define the mime array, if needed.
1765  *
1766  * @since 2.0.4
1767  *
1768  * @param string $filename File name or path.
1769  * @param array $mimes Optional. Key is the file extension with value as the mime type.
1770  * @return array Values with extension first and mime type.
1771  */
1772 function wp_check_filetype( $filename, $mimes = null ) {
1773         if ( empty($mimes) )
1774                 $mimes = get_allowed_mime_types();
1775         $type = false;
1776         $ext = false;
1777
1778         foreach ( $mimes as $ext_preg => $mime_match ) {
1779                 $ext_preg = '!\.(' . $ext_preg . ')$!i';
1780                 if ( preg_match( $ext_preg, $filename, $ext_matches ) ) {
1781                         $type = $mime_match;
1782                         $ext = $ext_matches[1];
1783                         break;
1784                 }
1785         }
1786
1787         return compact( 'ext', 'type' );
1788 }
1789
1790 /**
1791  * Attempt to determine the real file type of a file.
1792  * If unable to, the file name extension will be used to determine type.
1793  *
1794  * If it's determined that the extension does not match the file's real type,
1795  * then the "proper_filename" value will be set with a proper filename and extension.
1796  *
1797  * Currently this function only supports validating images known to getimagesize().
1798  *
1799  * @since 3.0.0
1800  *
1801  * @param string $file Full path to the image.
1802  * @param string $filename The filename of the image (may differ from $file due to $file being in a tmp directory)
1803  * @param array $mimes Optional. Key is the file extension with value as the mime type.
1804  * @return array Values for the extension, MIME, and either a corrected filename or false if original $filename is valid
1805  */
1806 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
1807
1808         $proper_filename = false;
1809
1810         // Do basic extension validation and MIME mapping
1811         $wp_filetype = wp_check_filetype( $filename, $mimes );
1812         extract( $wp_filetype );
1813
1814         // We can't do any further validation without a file to work with
1815         if ( ! file_exists( $file ) )
1816                 return compact( 'ext', 'type', 'proper_filename' );
1817
1818         // We're able to validate images using GD
1819         if ( $type && 0 === strpos( $type, 'image/' ) && function_exists('getimagesize') ) {
1820
1821                 // Attempt to figure out what type of image it actually is
1822                 $imgstats = @getimagesize( $file );
1823
1824                 // If getimagesize() knows what kind of image it really is and if the real MIME doesn't match the claimed MIME
1825                 if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
1826                         // This is a simplified array of MIMEs that getimagesize() can detect and their extensions
1827                         // You shouldn't need to use this filter, but it's here just in case
1828                         $mime_to_ext = apply_filters( 'getimagesize_mimes_to_exts', array(
1829                                 'image/jpeg' => 'jpg',
1830                                 'image/png'  => 'png',
1831                                 'image/gif'  => 'gif',
1832                                 'image/bmp'  => 'bmp',
1833                                 'image/tiff' => 'tif',
1834                         ) );
1835
1836                         // Replace whatever is after the last period in the filename with the correct extension
1837                         if ( ! empty( $mime_to_ext[ $imgstats['mime'] ] ) ) {
1838                                 $filename_parts = explode( '.', $filename );
1839                                 array_pop( $filename_parts );
1840                                 $filename_parts[] = $mime_to_ext[ $imgstats['mime'] ];
1841                                 $new_filename = implode( '.', $filename_parts );
1842
1843                                 if ( $new_filename != $filename )
1844                                         $proper_filename = $new_filename; // Mark that it changed
1845
1846                                 // Redefine the extension / MIME
1847                                 $wp_filetype = wp_check_filetype( $new_filename, $mimes );
1848                                 extract( $wp_filetype );
1849                         }
1850                 }
1851         }
1852
1853         // Let plugins try and validate other types of files
1854         // Should return an array in the style of array( 'ext' => $ext, 'type' => $type, 'proper_filename' => $proper_filename )
1855         return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes );
1856 }
1857
1858 /**
1859  * Retrieve list of mime types and file extensions.
1860  *
1861  * @since 3.5.0
1862  *
1863  * @uses apply_filters() Calls 'mime_types' on returned array. This filter should
1864  * be used to add types, not remove them. To remove types use the upload_mimes filter.
1865  *
1866  * @return array Array of mime types keyed by the file extension regex corresponding to those types.
1867  */
1868 function wp_get_mime_types() {
1869         // Accepted MIME types are set here as PCRE unless provided.
1870         return apply_filters( 'mime_types', array(
1871         // Image formats
1872         'jpg|jpeg|jpe' => 'image/jpeg',
1873         'gif' => 'image/gif',
1874         'png' => 'image/png',
1875         'bmp' => 'image/bmp',
1876         'tif|tiff' => 'image/tiff',
1877         'ico' => 'image/x-icon',
1878         // Video formats
1879         'asf|asx|wax|wmv|wmx' => 'video/asf',
1880         'avi' => 'video/avi',
1881         'divx' => 'video/divx',
1882         'flv' => 'video/x-flv',
1883         'mov|qt' => 'video/quicktime',
1884         'mpeg|mpg|mpe' => 'video/mpeg',
1885         'mp4|m4v' => 'video/mp4',
1886         'ogv' => 'video/ogg',
1887         'mkv' => 'video/x-matroska',
1888         // Text formats
1889         'txt|asc|c|cc|h' => 'text/plain',
1890         'csv' => 'text/csv',
1891         'tsv' => 'text/tab-separated-values',
1892         'ics' => 'text/calendar',
1893         'rtx' => 'text/richtext',
1894         'css' => 'text/css',
1895         'htm|html' => 'text/html',
1896         // Audio formats
1897         'mp3|m4a|m4b' => 'audio/mpeg',
1898         'ra|ram' => 'audio/x-realaudio',
1899         'wav' => 'audio/wav',
1900         'ogg|oga' => 'audio/ogg',
1901         'mid|midi' => 'audio/midi',
1902         'wma' => 'audio/wma',
1903         'mka' => 'audio/x-matroska',
1904         // Misc application formats
1905         'rtf' => 'application/rtf',
1906         'js' => 'application/javascript',
1907         'pdf' => 'application/pdf',
1908         'swf' => 'application/x-shockwave-flash',
1909         'class' => 'application/java',
1910         'tar' => 'application/x-tar',
1911         'zip' => 'application/zip',
1912         'gz|gzip' => 'application/x-gzip',
1913         'rar' => 'application/rar',
1914         '7z' => 'application/x-7z-compressed',
1915         'exe' => 'application/x-msdownload',
1916         // MS Office formats
1917         'doc' => 'application/msword',
1918         'pot|pps|ppt' => 'application/vnd.ms-powerpoint',
1919         'wri' => 'application/vnd.ms-write',
1920         'xla|xls|xlt|xlw' => 'application/vnd.ms-excel',
1921         'mdb' => 'application/vnd.ms-access',
1922         'mpp' => 'application/vnd.ms-project',
1923         'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
1924         'docm' => 'application/vnd.ms-word.document.macroEnabled.12',
1925         'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
1926         'dotm' => 'application/vnd.ms-word.template.macroEnabled.12',
1927         'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
1928         'xlsm' => 'application/vnd.ms-excel.sheet.macroEnabled.12',
1929         'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
1930         'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
1931         'xltm' => 'application/vnd.ms-excel.template.macroEnabled.12',
1932         'xlam' => 'application/vnd.ms-excel.addin.macroEnabled.12',
1933         'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
1934         'pptm' => 'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
1935         'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
1936         'ppsm' => 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
1937         'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template',
1938         'potm' => 'application/vnd.ms-powerpoint.template.macroEnabled.12',
1939         'ppam' => 'application/vnd.ms-powerpoint.addin.macroEnabled.12',
1940         'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
1941         'sldm' => 'application/vnd.ms-powerpoint.slide.macroEnabled.12',
1942         'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
1943         // OpenOffice formats
1944         'odt' => 'application/vnd.oasis.opendocument.text',
1945         'odp' => 'application/vnd.oasis.opendocument.presentation',
1946         'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
1947         'odg' => 'application/vnd.oasis.opendocument.graphics',
1948         'odc' => 'application/vnd.oasis.opendocument.chart',
1949         'odb' => 'application/vnd.oasis.opendocument.database',
1950         'odf' => 'application/vnd.oasis.opendocument.formula',
1951         // WordPerfect formats
1952         'wp|wpd' => 'application/wordperfect',
1953         ) );
1954 }
1955 /**
1956  * Retrieve list of allowed mime types and file extensions.
1957  *
1958  * @since 2.8.6
1959  *
1960  * @uses apply_filters() Calls 'upload_mimes' on returned array
1961  * @uses wp_get_upload_mime_types() to fetch the list of mime types
1962  *
1963  * @return array Array of mime types keyed by the file extension regex corresponding to those types.
1964  */
1965 function get_allowed_mime_types() {
1966         return apply_filters( 'upload_mimes', wp_get_mime_types() );
1967 }
1968
1969 /**
1970  * Display "Are You Sure" message to confirm the action being taken.
1971  *
1972  * If the action has the nonce explain message, then it will be displayed along
1973  * with the "Are you sure?" message.
1974  *
1975  * @package WordPress
1976  * @subpackage Security
1977  * @since 2.0.4
1978  *
1979  * @param string $action The nonce action.
1980  */
1981 function wp_nonce_ays( $action ) {
1982         $title = __( 'WordPress Failure Notice' );
1983         if ( 'log-out' == $action ) {
1984                 $html = sprintf( __( 'You are attempting to log out of %s' ), get_bloginfo( 'name' ) ) . '</p><p>';
1985                 $html .= sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url() );
1986         } else {
1987                 $html = __( 'Are you sure you want to do this?' );
1988                 if ( wp_get_referer() )
1989                         $html .= "</p><p><a href='" . esc_url( remove_query_arg( 'updated', wp_get_referer() ) ) . "'>" . __( 'Please try again.' ) . "</a>";
1990         }
1991
1992         wp_die( $html, $title, array('response' => 403) );
1993 }
1994
1995 /**
1996  * Kill WordPress execution and display HTML message with error message.
1997  *
1998  * This function complements the die() PHP function. The difference is that
1999  * HTML will be displayed to the user. It is recommended to use this function
2000  * only, when the execution should not continue any further. It is not
2001  * recommended to call this function very often and try to handle as many errors
2002  * as possible silently.
2003  *
2004  * @since 2.0.4
2005  *
2006  * @param string $message Error message.
2007  * @param string $title Error title.
2008  * @param string|array $args Optional arguments to control behavior.
2009  */
2010 function wp_die( $message = '', $title = '', $args = array() ) {
2011         if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
2012                 $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
2013         elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2014                 $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
2015         else
2016                 $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
2017
2018         call_user_func( $function, $message, $title, $args );
2019 }
2020
2021 /**
2022  * Kill WordPress execution and display HTML message with error message.
2023  *
2024  * This is the default handler for wp_die if you want a custom one for your
2025  * site then you can overload using the wp_die_handler filter in wp_die
2026  *
2027  * @since 3.0.0
2028  * @access private
2029  *
2030  * @param string $message Error message.
2031  * @param string $title Error title.
2032  * @param string|array $args Optional arguments to control behavior.
2033  */
2034 function _default_wp_die_handler( $message, $title = '', $args = array() ) {
2035         $defaults = array( 'response' => 500 );
2036         $r = wp_parse_args($args, $defaults);
2037
2038         $have_gettext = function_exists('__');
2039
2040         if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
2041                 if ( empty( $title ) ) {
2042                         $error_data = $message->get_error_data();
2043                         if ( is_array( $error_data ) && isset( $error_data['title'] ) )
2044                                 $title = $error_data['title'];
2045                 }
2046                 $errors = $message->get_error_messages();
2047                 switch ( count( $errors ) ) :
2048                 case 0 :
2049                         $message = '';
2050                         break;
2051                 case 1 :
2052                         $message = "<p>{$errors[0]}</p>";
2053                         break;
2054                 default :
2055                         $message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
2056                         break;
2057                 endswitch;
2058         } elseif ( is_string( $message ) ) {
2059                 $message = "<p>$message</p>";
2060         }
2061
2062         if ( isset( $r['back_link'] ) && $r['back_link'] ) {
2063                 $back_text = $have_gettext? __('&laquo; Back') : '&laquo; Back';
2064                 $message .= "\n<p><a href='javascript:history.back()'>$back_text</a></p>";
2065         }
2066
2067         if ( ! did_action( 'admin_head' ) ) :
2068                 if ( !headers_sent() ) {
2069                         status_header( $r['response'] );
2070                         nocache_headers();
2071                         header( 'Content-Type: text/html; charset=utf-8' );
2072                 }
2073
2074                 if ( empty($title) )
2075                         $title = $have_gettext ? __('WordPress &rsaquo; Error') : 'WordPress &rsaquo; Error';
2076
2077                 $text_direction = 'ltr';
2078                 if ( isset($r['text_direction']) && 'rtl' == $r['text_direction'] )
2079                         $text_direction = 'rtl';
2080                 elseif ( function_exists( 'is_rtl' ) && is_rtl() )
2081                         $text_direction = 'rtl';
2082 ?>
2083 <!DOCTYPE html>
2084 <!-- Ticket #11289, IE bug fix: always pad the error page with enough characters such that it is greater than 512 bytes, even after gzip compression abcdefghijklmnopqrstuvwxyz1234567890aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz11223344556677889900abacbcbdcdcededfefegfgfhghgihihjijikjkjlklkmlmlnmnmononpopoqpqprqrqsrsrtstsubcbcdcdedefefgfabcadefbghicjkldmnoepqrfstugvwxhyz1i234j567k890laabmbccnddeoeffpgghqhiirjjksklltmmnunoovppqwqrrxsstytuuzvvw0wxx1yyz2z113223434455666777889890091abc2def3ghi4jkl5mno6pqr7stu8vwx9yz11aab2bcc3dd4ee5ff6gg7hh8ii9j0jk1kl2lmm3nnoo4p5pq6qrr7ss8tt9uuvv0wwx1x2yyzz13aba4cbcb5dcdc6dedfef8egf9gfh0ghg1ihi2hji3jik4jkj5lkl6kml7mln8mnm9ono
2085 -->
2086 <html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists( 'language_attributes' ) && function_exists( 'is_rtl' ) ) language_attributes(); else echo "dir='$text_direction'"; ?>>
2087 <head>
2088         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2089         <title><?php echo $title ?></title>
2090         <style type="text/css">
2091                 html {
2092                         background: #f9f9f9;
2093                 }
2094                 body {
2095                         background: #fff;
2096                         color: #333;
2097                         font-family: sans-serif;
2098                         margin: 2em auto;
2099                         padding: 1em 2em;
2100                         -webkit-border-radius: 3px;
2101                         border-radius: 3px;
2102                         border: 1px solid #dfdfdf;
2103                         max-width: 700px;
2104                 }
2105                 h1 {
2106                         border-bottom: 1px solid #dadada;
2107                         clear: both;
2108                         color: #666;
2109                         font: 24px Georgia, "Times New Roman", Times, serif;
2110                         margin: 30px 0 0 0;
2111                         padding: 0;
2112                         padding-bottom: 7px;
2113                 }
2114                 #error-page {
2115                         margin-top: 50px;
2116                 }
2117                 #error-page p {
2118                         font-size: 14px;
2119                         line-height: 1.5;
2120                         margin: 25px 0 20px;
2121                 }
2122                 #error-page code {
2123                         font-family: Consolas, Monaco, monospace;
2124                 }
2125                 ul li {
2126                         margin-bottom: 10px;
2127                         font-size: 14px ;
2128                 }
2129                 a {
2130                         color: #21759B;
2131                         text-decoration: none;
2132                 }
2133                 a:hover {
2134                         color: #D54E21;
2135                 }
2136                 .button {
2137                         display: inline-block;
2138                         text-decoration: none;
2139                         font-size: 14px;
2140                         line-height: 23px;
2141                         height: 24px;
2142                         margin: 0;
2143                         padding: 0 10px 1px;
2144                         cursor: pointer;
2145                         border-width: 1px;
2146                         border-style: solid;
2147                         -webkit-border-radius: 3px;
2148                         border-radius: 3px;
2149                         white-space: nowrap;
2150                         -webkit-box-sizing: border-box;
2151                         -moz-box-sizing:    border-box;
2152                         box-sizing:         border-box;
2153                         background: #f3f3f3;
2154                         background-image: -webkit-gradient(linear, left top, left bottom, from(#fefefe), to(#f4f4f4));
2155                         background-image: -webkit-linear-gradient(top, #fefefe, #f4f4f4);
2156                         background-image:    -moz-linear-gradient(top, #fefefe, #f4f4f4);
2157                         background-image:      -o-linear-gradient(top, #fefefe, #f4f4f4);
2158                         background-image:   linear-gradient(to bottom, #fefefe, #f4f4f4);
2159                         border-color: #bbb;
2160                         color: #333;
2161                         text-shadow: 0 1px 0 #fff;
2162                 }
2163
2164                 .button.button-large {
2165                         height: 29px;
2166                         line-height: 28px;
2167                         padding: 0 12px;
2168                 }
2169
2170                 .button:hover,
2171                 .button:focus {
2172                         background: #f3f3f3;
2173                         background-image: -webkit-gradient(linear, left top, left bottom, from(#fff), to(#f3f3f3));
2174                         background-image: -webkit-linear-gradient(top, #fff, #f3f3f3);
2175                         background-image:    -moz-linear-gradient(top, #fff, #f3f3f3);
2176                         background-image:     -ms-linear-gradient(top, #fff, #f3f3f3);
2177                         background-image:      -o-linear-gradient(top, #fff, #f3f3f3);
2178                         background-image:   linear-gradient(to bottom, #fff, #f3f3f3);
2179                         border-color: #999;
2180                         color: #222;
2181                 }
2182
2183                 .button:focus  {
2184                         -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,.2);
2185                         box-shadow: 1px 1px 1px rgba(0,0,0,.2);
2186                 }
2187
2188                 .button:active {
2189                         outline: none;
2190                         background: #eee;
2191                         background-image: -webkit-gradient(linear, left top, left bottom, from(#f4f4f4), to(#fefefe));
2192                         background-image: -webkit-linear-gradient(top, #f4f4f4, #fefefe);
2193                         background-image:    -moz-linear-gradient(top, #f4f4f4, #fefefe);
2194                         background-image:     -ms-linear-gradient(top, #f4f4f4, #fefefe);
2195                         background-image:      -o-linear-gradient(top, #f4f4f4, #fefefe);
2196                         background-image:   linear-gradient(to bottom, #f4f4f4, #fefefe);
2197                         border-color: #999;
2198                         color: #333;
2199                         text-shadow: 0 -1px 0 #fff;
2200                         -webkit-box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
2201                         box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
2202                 }
2203
2204                 <?php if ( 'rtl' == $text_direction ) : ?>
2205                 body { font-family: Tahoma, Arial; }
2206                 <?php endif; ?>
2207         </style>
2208 </head>
2209 <body id="error-page">
2210 <?php endif; // ! did_action( 'admin_head' ) ?>
2211         <?php echo $message; ?>
2212 </body>
2213 </html>
2214 <?php
2215         die();
2216 }
2217
2218 /**
2219  * Kill WordPress execution and display XML message with error message.
2220  *
2221  * This is the handler for wp_die when processing XMLRPC requests.
2222  *
2223  * @since 3.2.0
2224  * @access private
2225  *
2226  * @param string $message Error message.
2227  * @param string $title Error title.
2228  * @param string|array $args Optional arguments to control behavior.
2229  */
2230 function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
2231         global $wp_xmlrpc_server;
2232         $defaults = array( 'response' => 500 );
2233
2234         $r = wp_parse_args($args, $defaults);
2235
2236         if ( $wp_xmlrpc_server ) {
2237                 $error = new IXR_Error( $r['response'] , $message);
2238                 $wp_xmlrpc_server->output( $error->getXml() );
2239         }
2240         die();
2241 }
2242
2243 /**
2244  * Kill WordPress ajax execution.
2245  *
2246  * This is the handler for wp_die when processing Ajax requests.
2247  *
2248  * @since 3.4.0
2249  * @access private
2250  *
2251  * @param string $message Optional. Response to print.
2252  */
2253 function _ajax_wp_die_handler( $message = '' ) {
2254         if ( is_scalar( $message ) )
2255                 die( (string) $message );
2256         die( '0' );
2257 }
2258
2259 /**
2260  * Kill WordPress execution.
2261  *
2262  * This is the handler for wp_die when processing APP requests.
2263  *
2264  * @since 3.4.0
2265  * @access private
2266  *
2267  * @param string $message Optional. Response to print.
2268  */
2269 function _scalar_wp_die_handler( $message = '' ) {
2270         if ( is_scalar( $message ) )
2271                 die( (string) $message );
2272         die();
2273 }
2274
2275 /**
2276  * Send a JSON response back to an Ajax request.
2277  *
2278  * @since 3.5.0
2279  *
2280  * @param mixed $response Variable (usually an array or object) to encode as JSON, then print and die.
2281  */
2282 function wp_send_json( $response ) {
2283         @header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
2284         echo json_encode( $response );
2285         if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
2286                 wp_die();
2287         else
2288                 die;
2289 }
2290
2291 /**
2292  * Send a JSON response back to an Ajax request, indicating success.
2293  *
2294  * @since 3.5.0
2295  *
2296  * @param mixed $data Data to encode as JSON, then print and die.
2297  */
2298 function wp_send_json_success( $data = null ) {
2299         $response = array( 'success' => true );
2300
2301         if ( isset( $data ) )
2302                 $response['data'] = $data;
2303
2304         wp_send_json( $response );
2305 }
2306
2307 /**
2308  * Send a JSON response back to an Ajax request, indicating failure.
2309  *
2310  * @since 3.5.0
2311  *
2312  * @param mixed $data Data to encode as JSON, then print and die.
2313  */
2314 function wp_send_json_error( $data = null ) {
2315         $response = array( 'success' => false );
2316
2317         if ( isset( $data ) )
2318                 $response['data'] = $data;
2319
2320         wp_send_json( $response );
2321 }
2322
2323 /**
2324  * Retrieve the WordPress home page URL.
2325  *
2326  * If the constant named 'WP_HOME' exists, then it will be used and returned by
2327  * the function. This can be used to counter the redirection on your local
2328  * development environment.
2329  *
2330  * @access private
2331  * @package WordPress
2332  * @since 2.2.0
2333  *
2334  * @param string $url URL for the home location
2335  * @return string Homepage location.
2336  */
2337 function _config_wp_home( $url = '' ) {
2338         if ( defined( 'WP_HOME' ) )
2339                 return untrailingslashit( WP_HOME );
2340         return $url;
2341 }
2342
2343 /**
2344  * Retrieve the WordPress site URL.
2345  *
2346  * If the constant named 'WP_SITEURL' is defined, then the value in that
2347  * constant will always be returned. This can be used for debugging a site on
2348  * your localhost while not having to change the database to your URL.
2349  *
2350  * @access private
2351  * @package WordPress
2352  * @since 2.2.0
2353  *
2354  * @param string $url URL to set the WordPress site location.
2355  * @return string The WordPress Site URL
2356  */
2357 function _config_wp_siteurl( $url = '' ) {
2358         if ( defined( 'WP_SITEURL' ) )
2359                 return untrailingslashit( WP_SITEURL );
2360         return $url;
2361 }
2362
2363 /**
2364  * Set the localized direction for MCE plugin.
2365  *
2366  * Will only set the direction to 'rtl', if the WordPress locale has the text
2367  * direction set to 'rtl'.
2368  *
2369  * Fills in the 'directionality', 'plugins', and 'theme_advanced_button1' array
2370  * keys. These keys are then returned in the $input array.
2371  *
2372  * @access private
2373  * @package WordPress
2374  * @subpackage MCE
2375  * @since 2.1.0
2376  *
2377  * @param array $input MCE plugin array.
2378  * @return array Direction set for 'rtl', if needed by locale.
2379  */
2380 function _mce_set_direction( $input ) {
2381         if ( is_rtl() ) {
2382                 $input['directionality'] = 'rtl';
2383                 $input['plugins'] .= ',directionality';
2384                 $input['theme_advanced_buttons1'] .= ',ltr';
2385         }
2386
2387         return $input;
2388 }
2389
2390 /**
2391  * Convert smiley code to the icon graphic file equivalent.
2392  *
2393  * You can turn off smilies, by going to the write setting screen and unchecking
2394  * the box, or by setting 'use_smilies' option to false or removing the option.
2395  *
2396  * Plugins may override the default smiley list by setting the $wpsmiliestrans
2397  * to an array, with the key the code the blogger types in and the value the
2398  * image file.
2399  *
2400  * The $wp_smiliessearch global is for the regular expression and is set each
2401  * time the function is called.
2402  *
2403  * The full list of smilies can be found in the function and won't be listed in
2404  * the description. Probably should create a Codex page for it, so that it is
2405  * available.
2406  *
2407  * @global array $wpsmiliestrans
2408  * @global array $wp_smiliessearch
2409  * @since 2.2.0
2410  */
2411 function smilies_init() {
2412         global $wpsmiliestrans, $wp_smiliessearch;
2413
2414         // don't bother setting up smilies if they are disabled
2415         if ( !get_option( 'use_smilies' ) )
2416                 return;
2417
2418         if ( !isset( $wpsmiliestrans ) ) {
2419                 $wpsmiliestrans = array(
2420                 ':mrgreen:' => 'icon_mrgreen.gif',
2421                 ':neutral:' => 'icon_neutral.gif',
2422                 ':twisted:' => 'icon_twisted.gif',
2423                   ':arrow:' => 'icon_arrow.gif',
2424                   ':shock:' => 'icon_eek.gif',
2425                   ':smile:' => 'icon_smile.gif',
2426                     ':???:' => 'icon_confused.gif',
2427                    ':cool:' => 'icon_cool.gif',
2428                    ':evil:' => 'icon_evil.gif',
2429                    ':grin:' => 'icon_biggrin.gif',
2430                    ':idea:' => 'icon_idea.gif',
2431                    ':oops:' => 'icon_redface.gif',
2432                    ':razz:' => 'icon_razz.gif',
2433                    ':roll:' => 'icon_rolleyes.gif',
2434                    ':wink:' => 'icon_wink.gif',
2435                     ':cry:' => 'icon_cry.gif',
2436                     ':eek:' => 'icon_surprised.gif',
2437                     ':lol:' => 'icon_lol.gif',
2438                     ':mad:' => 'icon_mad.gif',
2439                     ':sad:' => 'icon_sad.gif',
2440                       '8-)' => 'icon_cool.gif',
2441                       '8-O' => 'icon_eek.gif',
2442                       ':-(' => 'icon_sad.gif',
2443                       ':-)' => 'icon_smile.gif',
2444                       ':-?' => 'icon_confused.gif',
2445                       ':-D' => 'icon_biggrin.gif',
2446                       ':-P' => 'icon_razz.gif',
2447                       ':-o' => 'icon_surprised.gif',
2448                       ':-x' => 'icon_mad.gif',
2449                       ':-|' => 'icon_neutral.gif',
2450                       ';-)' => 'icon_wink.gif',
2451                 // This one transformation breaks regular text with frequency.
2452                 //     '8)' => 'icon_cool.gif',
2453                        '8O' => 'icon_eek.gif',
2454                        ':(' => 'icon_sad.gif',
2455                        ':)' => 'icon_smile.gif',
2456                        ':?' => 'icon_confused.gif',
2457                        ':D' => 'icon_biggrin.gif',
2458                        ':P' => 'icon_razz.gif',
2459                        ':o' => 'icon_surprised.gif',
2460                        ':x' => 'icon_mad.gif',
2461                        ':|' => 'icon_neutral.gif',
2462                        ';)' => 'icon_wink.gif',
2463                       ':!:' => 'icon_exclaim.gif',
2464                       ':?:' => 'icon_question.gif',
2465                 );
2466         }
2467
2468         if (count($wpsmiliestrans) == 0) {
2469                 return;
2470         }
2471
2472         /*
2473          * NOTE: we sort the smilies in reverse key order. This is to make sure
2474          * we match the longest possible smilie (:???: vs :?) as the regular
2475          * expression used below is first-match
2476          */
2477         krsort($wpsmiliestrans);
2478
2479         $wp_smiliessearch = '/(?:\s|^)';
2480
2481         $subchar = '';
2482         foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
2483                 $firstchar = substr($smiley, 0, 1);
2484                 $rest = substr($smiley, 1);
2485
2486                 // new subpattern?
2487                 if ($firstchar != $subchar) {
2488                         if ($subchar != '') {
2489                                 $wp_smiliessearch .= ')|(?:\s|^)';
2490                         }
2491                         $subchar = $firstchar;
2492                         $wp_smiliessearch .= preg_quote($firstchar, '/') . '(?:';
2493                 } else {
2494                         $wp_smiliessearch .= '|';
2495                 }
2496                 $wp_smiliessearch .= preg_quote($rest, '/');
2497         }
2498
2499         $wp_smiliessearch .= ')(?:\s|$)/m';
2500 }
2501
2502 /**
2503  * Merge user defined arguments into defaults array.
2504  *
2505  * This function is used throughout WordPress to allow for both string or array
2506  * to be merged into another array.
2507  *
2508  * @since 2.2.0
2509  *
2510  * @param string|array $args Value to merge with $defaults
2511  * @param array $defaults Array that serves as the defaults.
2512  * @return array Merged user defined values with defaults.
2513  */
2514 function wp_parse_args( $args, $defaults = '' ) {
2515         if ( is_object( $args ) )
2516                 $r = get_object_vars( $args );
2517         elseif ( is_array( $args ) )
2518                 $r =& $args;
2519         else
2520                 wp_parse_str( $args, $r );
2521
2522         if ( is_array( $defaults ) )
2523                 return array_merge( $defaults, $r );
2524         return $r;
2525 }
2526
2527 /**
2528  * Clean up an array, comma- or space-separated list of IDs.
2529  *
2530  * @since 3.0.0
2531  *
2532  * @param array|string $list
2533  * @return array Sanitized array of IDs
2534  */
2535 function wp_parse_id_list( $list ) {
2536         if ( !is_array($list) )
2537                 $list = preg_split('/[\s,]+/', $list);
2538
2539         return array_unique(array_map('absint', $list));
2540 }
2541
2542 /**
2543  * Extract a slice of an array, given a list of keys.
2544  *
2545  * @since 3.1.0
2546  *
2547  * @param array $array The original array
2548  * @param array $keys The list of keys
2549  * @return array The array slice
2550  */
2551 function wp_array_slice_assoc( $array, $keys ) {
2552         $slice = array();
2553         foreach ( $keys as $key )
2554                 if ( isset( $array[ $key ] ) )
2555                         $slice[ $key ] = $array[ $key ];
2556
2557         return $slice;
2558 }
2559
2560 /**
2561  * Filters a list of objects, based on a set of key => value arguments.
2562  *
2563  * @since 3.0.0
2564  *
2565  * @param array $list An array of objects to filter
2566  * @param array $args An array of key => value arguments to match against each object
2567  * @param string $operator The logical operation to perform. 'or' means only one element
2568  *      from the array needs to match; 'and' means all elements must match. The default is 'and'.
2569  * @param bool|string $field A field from the object to place instead of the entire object
2570  * @return array A list of objects or object fields
2571  */
2572 function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
2573         if ( ! is_array( $list ) )
2574                 return array();
2575
2576         $list = wp_list_filter( $list, $args, $operator );
2577
2578         if ( $field )
2579                 $list = wp_list_pluck( $list, $field );
2580
2581         return $list;
2582 }
2583
2584 /**
2585  * Filters a list of objects, based on a set of key => value arguments.
2586  *
2587  * @since 3.1.0
2588  *
2589  * @param array $list An array of objects to filter
2590  * @param array $args An array of key => value arguments to match against each object
2591  * @param string $operator The logical operation to perform:
2592  *    'AND' means all elements from the array must match;
2593  *    'OR' means only one element needs to match;
2594  *    'NOT' means no elements may match.
2595  *   The default is 'AND'.
2596  * @return array
2597  */
2598 function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
2599         if ( ! is_array( $list ) )
2600                 return array();
2601
2602         if ( empty( $args ) )
2603                 return $list;
2604
2605         $operator = strtoupper( $operator );
2606         $count = count( $args );
2607         $filtered = array();
2608
2609         foreach ( $list as $key => $obj ) {
2610                 $to_match = (array) $obj;
2611
2612                 $matched = 0;
2613                 foreach ( $args as $m_key => $m_value ) {
2614                         if ( array_key_exists( $m_key, $to_match ) && $m_value == $to_match[ $m_key ] )
2615                                 $matched++;
2616                 }
2617
2618                 if ( ( 'AND' == $operator && $matched == $count )
2619                   || ( 'OR' == $operator && $matched > 0 )
2620                   || ( 'NOT' == $operator && 0 == $matched ) ) {
2621                         $filtered[$key] = $obj;
2622                 }
2623         }
2624
2625         return $filtered;
2626 }
2627
2628 /**
2629  * Pluck a certain field out of each object in a list.
2630  *
2631  * @since 3.1.0
2632  *
2633  * @param array $list A list of objects or arrays
2634  * @param int|string $field A field from the object to place instead of the entire object
2635  * @return array
2636  */
2637 function wp_list_pluck( $list, $field ) {
2638         foreach ( $list as $key => $value ) {
2639                 if ( is_object( $value ) )
2640                         $list[ $key ] = $value->$field;
2641                 else
2642                         $list[ $key ] = $value[ $field ];
2643         }
2644
2645         return $list;
2646 }
2647
2648 /**
2649  * Determines if Widgets library should be loaded.
2650  *
2651  * Checks to make sure that the widgets library hasn't already been loaded. If
2652  * it hasn't, then it will load the widgets library and run an action hook.
2653  *
2654  * @since 2.2.0
2655  * @uses add_action() Calls '_admin_menu' hook with 'wp_widgets_add_menu' value.
2656  */
2657 function wp_maybe_load_widgets() {
2658         if ( ! apply_filters('load_default_widgets', true) )
2659                 return;
2660         require_once( ABSPATH . WPINC . '/default-widgets.php' );
2661         add_action( '_admin_menu', 'wp_widgets_add_menu' );
2662 }
2663
2664 /**
2665  * Append the Widgets menu to the themes main menu.
2666  *
2667  * @since 2.2.0
2668  * @uses $submenu The administration submenu list.
2669  */
2670 function wp_widgets_add_menu() {
2671         global $submenu;
2672
2673         if ( ! current_theme_supports( 'widgets' ) )
2674                 return;
2675
2676         $submenu['themes.php'][7] = array( __( 'Widgets' ), 'edit_theme_options', 'widgets.php' );
2677         ksort( $submenu['themes.php'], SORT_NUMERIC );
2678 }
2679
2680 /**
2681  * Flush all output buffers for PHP 5.2.
2682  *
2683  * Make sure all output buffers are flushed before our singletons our destroyed.
2684  *
2685  * @since 2.2.0
2686  */
2687 function wp_ob_end_flush_all() {
2688         $levels = ob_get_level();
2689         for ($i=0; $i<$levels; $i++)
2690                 ob_end_flush();
2691 }
2692
2693 /**
2694  * Load custom DB error or display WordPress DB error.
2695  *
2696  * If a file exists in the wp-content directory named db-error.php, then it will
2697  * be loaded instead of displaying the WordPress DB error. If it is not found,
2698  * then the WordPress DB error will be displayed instead.
2699  *
2700  * The WordPress DB error sets the HTTP status header to 500 to try to prevent
2701  * search engines from caching the message. Custom DB messages should do the
2702  * same.
2703  *
2704  * This function was backported to the the WordPress 2.3.2, but originally was
2705  * added in WordPress 2.5.0.
2706  *
2707  * @since 2.3.2
2708  * @uses $wpdb
2709  */
2710 function dead_db() {
2711         global $wpdb;
2712
2713         // Load custom DB error template, if present.
2714         if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
2715                 require_once( WP_CONTENT_DIR . '/db-error.php' );
2716                 die();
2717         }
2718
2719         // If installing or in the admin, provide the verbose message.
2720         if ( defined('WP_INSTALLING') || defined('WP_ADMIN') )
2721                 wp_die($wpdb->error);
2722
2723         // Otherwise, be terse.
2724         status_header( 500 );
2725         nocache_headers();
2726         header( 'Content-Type: text/html; charset=utf-8' );
2727
2728         wp_load_translations_early();
2729 ?>
2730 <!DOCTYPE html>
2731 <html xmlns="http://www.w3.org/1999/xhtml"<?php if ( is_rtl() ) echo ' dir="rtl"'; ?>>
2732 <head>
2733 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2734         <title><?php _e( 'Database Error' ); ?></title>
2735
2736 </head>
2737 <body>
2738         <h1><?php _e( 'Error establishing a database connection' ); ?></h1>
2739 </body>
2740 </html>
2741 <?php
2742         die();
2743 }
2744
2745 /**
2746  * Converts value to nonnegative integer.
2747  *
2748  * @since 2.5.0
2749  *
2750  * @param mixed $maybeint Data you wish to have converted to a nonnegative integer
2751  * @return int An nonnegative integer
2752  */
2753 function absint( $maybeint ) {
2754         return abs( intval( $maybeint ) );
2755 }
2756
2757 /**
2758  * Determines if the blog can be accessed over SSL.
2759  *
2760  * Determines if blog can be accessed over SSL by using cURL to access the site
2761  * using the https in the siteurl. Requires cURL extension to work correctly.
2762  *
2763  * @since 2.5.0
2764  *
2765  * @param string $url
2766  * @return bool Whether SSL access is available
2767  */
2768 function url_is_accessable_via_ssl($url)
2769 {
2770         if ( in_array( 'curl', get_loaded_extensions() ) ) {
2771                 $ssl = set_url_scheme( $url, 'https' );
2772
2773                 $ch = curl_init();
2774                 curl_setopt($ch, CURLOPT_URL, $ssl);
2775                 curl_setopt($ch, CURLOPT_FAILONERROR, true);
2776                 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
2777                 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
2778                 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
2779
2780                 curl_exec($ch);
2781
2782                 $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
2783                 curl_close ($ch);
2784
2785                 if ($status == 200 || $status == 401) {
2786                         return true;
2787                 }
2788         }
2789         return false;
2790 }
2791
2792 /**
2793  * Marks a function as deprecated and informs when it has been used.
2794  *
2795  * There is a hook deprecated_function_run that will be called that can be used
2796  * to get the backtrace up to what file and function called the deprecated
2797  * function.
2798  *
2799  * The current behavior is to trigger a user error if WP_DEBUG is true.
2800  *
2801  * This function is to be used in every function that is deprecated.
2802  *
2803  * @package WordPress
2804  * @subpackage Debug
2805  * @since 2.5.0
2806  * @access private
2807  *
2808  * @uses do_action() Calls 'deprecated_function_run' and passes the function name, what to use instead,
2809  *   and the version the function was deprecated in.
2810  * @uses apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
2811  *   trigger or false to not trigger error.
2812  *
2813  * @param string $function The function that was called
2814  * @param string $version The version of WordPress that deprecated the function
2815  * @param string $replacement Optional. The function that should have been called
2816  */
2817 function _deprecated_function( $function, $version, $replacement = null ) {
2818
2819         do_action( 'deprecated_function_run', $function, $replacement, $version );
2820
2821         // Allow plugin to filter the output error trigger
2822         if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
2823                 if ( ! is_null($replacement) )
2824                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
2825                 else
2826                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2827         }
2828 }
2829
2830 /**
2831  * Marks a file as deprecated and informs when it has been used.
2832  *
2833  * There is a hook deprecated_file_included that will be called that can be used
2834  * to get the backtrace up to what file and function included the deprecated
2835  * file.
2836  *
2837  * The current behavior is to trigger a user error if WP_DEBUG is true.
2838  *
2839  * This function is to be used in every file that is deprecated.
2840  *
2841  * @package WordPress
2842  * @subpackage Debug
2843  * @since 2.5.0
2844  * @access private
2845  *
2846  * @uses do_action() Calls 'deprecated_file_included' and passes the file name, what to use instead,
2847  *   the version in which the file was deprecated, and any message regarding the change.
2848  * @uses apply_filters() Calls 'deprecated_file_trigger_error' and expects boolean value of true to do
2849  *   trigger or false to not trigger error.
2850  *
2851  * @param string $file The file that was included
2852  * @param string $version The version of WordPress that deprecated the file
2853  * @param string $replacement Optional. The file that should have been included based on ABSPATH
2854  * @param string $message Optional. A message regarding the change
2855  */
2856 function _deprecated_file( $file, $version, $replacement = null, $message = '' ) {
2857
2858         do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
2859
2860         // Allow plugin to filter the output error trigger
2861         if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
2862                 $message = empty( $message ) ? '' : ' ' . $message;
2863                 if ( ! is_null( $replacement ) )
2864                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) . $message );
2865                 else
2866                         trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) . $message );
2867         }
2868 }
2869 /**
2870  * Marks a function argument as deprecated and informs when it has been used.
2871  *
2872  * This function is to be used whenever a deprecated function argument is used.
2873  * Before this function is called, the argument must be checked for whether it was
2874  * used by comparing it to its default value or evaluating whether it is empty.
2875  * For example:
2876  * <code>
2877  * if ( !empty($deprecated) )
2878  *      _deprecated_argument( __FUNCTION__, '3.0' );
2879  * </code>
2880  *
2881  * There is a hook deprecated_argument_run that will be called that can be used
2882  * to get the backtrace up to what file and function used the deprecated
2883  * argument.
2884  *
2885  * The current behavior is to trigger a user error if WP_DEBUG is true.
2886  *
2887  * @package WordPress
2888  * @subpackage Debug
2889  * @since 3.0.0
2890  * @access private
2891  *
2892  * @uses do_action() Calls 'deprecated_argument_run' and passes the function name, a message on the change,
2893  *   and the version in which the argument was deprecated.
2894  * @uses apply_filters() Calls 'deprecated_argument_trigger_error' and expects boolean value of true to do
2895  *   trigger or false to not trigger error.
2896  *
2897  * @param string $function The function that was called
2898  * @param string $version The version of WordPress that deprecated the argument used
2899  * @param string $message Optional. A message regarding the change.
2900  */
2901 function _deprecated_argument( $function, $version, $message = null ) {
2902
2903         do_action( 'deprecated_argument_run', $function, $message, $version );
2904
2905         // Allow plugin to filter the output error trigger
2906         if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
2907                 if ( ! is_null( $message ) )
2908                         trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s'), $function, $version, $message ) );
2909                 else
2910                         trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2911         }
2912 }
2913
2914 /**
2915  * Marks something as being incorrectly called.
2916  *
2917  * There is a hook doing_it_wrong_run that will be called that can be used
2918  * to get the backtrace up to what file and function called the deprecated
2919  * function.
2920  *
2921  * The current behavior is to trigger a user error if WP_DEBUG is true.
2922  *
2923  * @package WordPress
2924  * @subpackage Debug
2925  * @since 3.1.0
2926  * @access private
2927  *
2928  * @uses do_action() Calls 'doing_it_wrong_run' and passes the function arguments.
2929  * @uses apply_filters() Calls 'doing_it_wrong_trigger_error' and expects boolean value of true to do
2930  *   trigger or false to not trigger error.
2931  *
2932  * @param string $function The function that was called.
2933  * @param string $message A message explaining what has been done incorrectly.
2934  * @param string $version The version of WordPress where the message was added.
2935  */
2936 function _doing_it_wrong( $function, $message, $version ) {
2937
2938         do_action( 'doing_it_wrong_run', $function, $message, $version );
2939
2940         // Allow plugin to filter the output error trigger
2941         if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true ) ) {
2942                 $version = is_null( $version ) ? '' : sprintf( __( '(This message was added in version %s.)' ), $version );
2943                 $message .= ' ' . __( 'Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.' );
2944                 trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) );
2945         }
2946 }
2947
2948 /**
2949  * Is the server running earlier than 1.5.0 version of lighttpd?
2950  *
2951  * @since 2.5.0
2952  *
2953  * @return bool Whether the server is running lighttpd < 1.5.0
2954  */
2955 function is_lighttpd_before_150() {
2956         $server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] )? $_SERVER['SERVER_SOFTWARE'] : '' );
2957         $server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : '';
2958         return  'lighttpd' == $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' );
2959 }
2960
2961 /**
2962  * Does the specified module exist in the Apache config?
2963  *
2964  * @since 2.5.0
2965  *
2966  * @param string $mod e.g. mod_rewrite
2967  * @param bool $default The default return value if the module is not found
2968  * @return bool
2969  */
2970 function apache_mod_loaded($mod, $default = false) {
2971         global $is_apache;
2972
2973         if ( !$is_apache )
2974                 return false;
2975
2976         if ( function_exists('apache_get_modules') ) {
2977                 $mods = apache_get_modules();
2978                 if ( in_array($mod, $mods) )
2979                         return true;
2980         } elseif ( function_exists('phpinfo') ) {
2981                         ob_start();
2982                         phpinfo(8);
2983                         $phpinfo = ob_get_clean();
2984                         if ( false !== strpos($phpinfo, $mod) )
2985                                 return true;
2986         }
2987         return $default;
2988 }
2989
2990 /**
2991  * Check if IIS 7 supports pretty permalinks.
2992  *
2993  * @since 2.8.0
2994  *
2995  * @return bool
2996  */
2997 function iis7_supports_permalinks() {
2998         global $is_iis7;
2999
3000         $supports_permalinks = false;
3001         if ( $is_iis7 ) {
3002                 /* First we check if the DOMDocument class exists. If it does not exist,
3003                  * which is the case for PHP 4.X, then we cannot easily update the xml configuration file,
3004                  * hence we just bail out and tell user that pretty permalinks cannot be used.
3005                  * This is not a big issue because PHP 4.X is going to be deprecated and for IIS it
3006                  * is recommended to use PHP 5.X NTS.
3007                  * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
3008                  * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
3009                  * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
3010                  * via ISAPI then pretty permalinks will not work.
3011                  */
3012                 $supports_permalinks = class_exists('DOMDocument') && isset($_SERVER['IIS_UrlRewriteModule']) && ( php_sapi_name() == 'cgi-fcgi' );
3013         }
3014
3015         return apply_filters('iis7_supports_permalinks', $supports_permalinks);
3016 }
3017
3018 /**
3019  * File validates against allowed set of defined rules.
3020  *
3021  * A return value of '1' means that the $file contains either '..' or './'. A
3022  * return value of '2' means that the $file contains ':' after the first
3023  * character. A return value of '3' means that the file is not in the allowed
3024  * files list.
3025  *
3026  * @since 1.2.0
3027  *
3028  * @param string $file File path.
3029  * @param array $allowed_files List of allowed files.
3030  * @return int 0 means nothing is wrong, greater than 0 means something was wrong.
3031  */
3032 function validate_file( $file, $allowed_files = '' ) {
3033         if ( false !== strpos( $file, '..' ) )
3034                 return 1;
3035
3036         if ( false !== strpos( $file, './' ) )
3037                 return 1;
3038
3039         if ( ! empty( $allowed_files ) && ! in_array( $file, $allowed_files ) )
3040                 return 3;
3041
3042         if (':' == substr( $file, 1, 1 ) )
3043                 return 2;
3044
3045         return 0;
3046 }
3047
3048 /**
3049  * Determine if SSL is used.
3050  *
3051  * @since 2.6.0
3052  *
3053  * @return bool True if SSL, false if not used.
3054  */
3055 function is_ssl() {
3056         if ( isset($_SERVER['HTTPS']) ) {
3057                 if ( 'on' == strtolower($_SERVER['HTTPS']) )
3058                         return true;
3059                 if ( '1' == $_SERVER['HTTPS'] )
3060                         return true;
3061         } elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
3062                 return true;
3063         }
3064         return false;
3065 }
3066
3067 /**
3068  * Whether SSL login should be forced.
3069  *
3070  * @since 2.6.0
3071  *
3072  * @param string|bool $force Optional.
3073  * @return bool True if forced, false if not forced.
3074  */
3075 function force_ssl_login( $force = null ) {
3076         static $forced = false;
3077
3078         if ( !is_null( $force ) ) {
3079                 $old_forced = $forced;
3080                 $forced = $force;
3081                 return $old_forced;
3082         }
3083
3084         return $forced;
3085 }
3086
3087 /**
3088  * Whether to force SSL used for the Administration Screens.
3089  *
3090  * @since 2.6.0
3091  *
3092  * @param string|bool $force
3093  * @return bool True if forced, false if not forced.
3094  */
3095 function force_ssl_admin( $force = null ) {
3096         static $forced = false;
3097
3098         if ( !is_null( $force ) ) {
3099                 $old_forced = $forced;
3100                 $forced = $force;
3101                 return $old_forced;
3102         }
3103
3104         return $forced;
3105 }
3106
3107 /**
3108  * Guess the URL for the site.
3109  *
3110  * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
3111  * directory.
3112  *
3113  * @since 2.6.0
3114  *
3115  * @return string
3116  */
3117 function wp_guess_url() {
3118         if ( defined('WP_SITEURL') && '' != WP_SITEURL ) {
3119                 $url = WP_SITEURL;
3120         } else {
3121                 $schema = is_ssl() ? 'https://' : 'http://'; // set_url_scheme() is not defined yet
3122                 $url = preg_replace( '#/(wp-admin/.*|wp-login.php)#i', '', $schema . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
3123         }
3124
3125         return rtrim($url, '/');
3126 }
3127
3128 /**
3129  * Temporarily suspend cache additions.
3130  *
3131  * Stops more data being added to the cache, but still allows cache retrieval.
3132  * This is useful for actions, such as imports, when a lot of data would otherwise
3133  * be almost uselessly added to the cache.
3134  *
3135  * Suspension lasts for a single page load at most. Remember to call this
3136  * function again if you wish to re-enable cache adds earlier.
3137  *
3138  * @since 3.3.0
3139  *
3140  * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
3141  * @return bool The current suspend setting
3142  */
3143 function wp_suspend_cache_addition( $suspend = null ) {
3144         static $_suspend = false;
3145
3146         if ( is_bool( $suspend ) )
3147                 $_suspend = $suspend;
3148
3149         return $_suspend;
3150 }
3151
3152 /**
3153  * Suspend cache invalidation.
3154  *
3155  * Turns cache invalidation on and off. Useful during imports where you don't wont to do invalidations
3156  * every time a post is inserted. Callers must be sure that what they are doing won't lead to an inconsistent
3157  * cache when invalidation is suspended.
3158  *
3159  * @since 2.7.0
3160  *
3161  * @param bool $suspend Whether to suspend or enable cache invalidation
3162  * @return bool The current suspend setting
3163  */
3164 function wp_suspend_cache_invalidation($suspend = true) {
3165         global $_wp_suspend_cache_invalidation;
3166
3167         $current_suspend = $_wp_suspend_cache_invalidation;
3168         $_wp_suspend_cache_invalidation = $suspend;
3169         return $current_suspend;
3170 }
3171
3172 /**
3173  * Is main site?
3174  *
3175  *
3176  * @since 3.0.0
3177  * @package WordPress
3178  *
3179  * @param int $blog_id optional blog id to test (default current blog)
3180  * @return bool True if not multisite or $blog_id is main site
3181  */
3182 function is_main_site( $blog_id = '' ) {
3183         global $current_site;
3184
3185         if ( ! is_multisite() )
3186                 return true;
3187
3188         if ( ! $blog_id )
3189                 $blog_id = get_current_blog_id();
3190
3191         return $blog_id == $current_site->blog_id;
3192 }
3193
3194 /**
3195  * Whether global terms are enabled.
3196  *
3197  *
3198  * @since 3.0.0
3199  * @package WordPress
3200  *
3201  * @return bool True if multisite and global terms enabled
3202  */
3203 function global_terms_enabled() {
3204         if ( ! is_multisite() )
3205                 return false;
3206
3207         static $global_terms = null;
3208         if ( is_null( $global_terms ) ) {
3209                 $filter = apply_filters( 'global_terms_enabled', null );
3210                 if ( ! is_null( $filter ) )
3211                         $global_terms = (bool) $filter;
3212                 else
3213                         $global_terms = (bool) get_site_option( 'global_terms_enabled', false );
3214         }
3215         return $global_terms;
3216 }
3217
3218 /**
3219  * gmt_offset modification for smart timezone handling.
3220  *
3221  * Overrides the gmt_offset option if we have a timezone_string available.
3222  *
3223  * @since 2.8.0
3224  *
3225  * @return float|bool
3226  */
3227 function wp_timezone_override_offset() {
3228         if ( !$timezone_string = get_option( 'timezone_string' ) ) {
3229                 return false;
3230         }
3231
3232         $timezone_object = timezone_open( $timezone_string );
3233         $datetime_object = date_create();
3234         if ( false === $timezone_object || false === $datetime_object ) {
3235                 return false;
3236         }
3237         return round( timezone_offset_get( $timezone_object, $datetime_object ) / HOUR_IN_SECONDS, 2 );
3238 }
3239
3240 /**
3241  * {@internal Missing Short Description}}
3242  *
3243  * @since 2.9.0
3244  *
3245  * @param unknown_type $a
3246  * @param unknown_type $b
3247  * @return int
3248  */
3249 function _wp_timezone_choice_usort_callback( $a, $b ) {
3250         // Don't use translated versions of Etc
3251         if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) {
3252                 // Make the order of these more like the old dropdown
3253                 if ( 'GMT+' === substr( $a['city'], 0, 4 ) && 'GMT+' === substr( $b['city'], 0, 4 ) ) {
3254                         return -1 * ( strnatcasecmp( $a['city'], $b['city'] ) );
3255                 }
3256                 if ( 'UTC' === $a['city'] ) {
3257                         if ( 'GMT+' === substr( $b['city'], 0, 4 ) ) {
3258                                 return 1;
3259                         }
3260                         return -1;
3261                 }
3262                 if ( 'UTC' === $b['city'] ) {
3263                         if ( 'GMT+' === substr( $a['city'], 0, 4 ) ) {
3264                                 return -1;
3265                         }
3266                         return 1;
3267                 }
3268                 return strnatcasecmp( $a['city'], $b['city'] );
3269         }
3270         if ( $a['t_continent'] == $b['t_continent'] ) {
3271                 if ( $a['t_city'] == $b['t_city'] ) {
3272                         return strnatcasecmp( $a['t_subcity'], $b['t_subcity'] );
3273                 }
3274                 return strnatcasecmp( $a['t_city'], $b['t_city'] );
3275         } else {
3276                 // Force Etc to the bottom of the list
3277                 if ( 'Etc' === $a['continent'] ) {
3278                         return 1;
3279                 }
3280                 if ( 'Etc' === $b['continent'] ) {
3281                         return -1;
3282                 }
3283                 return strnatcasecmp( $a['t_continent'], $b['t_continent'] );
3284         }
3285 }
3286
3287 /**
3288  * Gives a nicely formatted list of timezone strings. // temporary! Not in final
3289  *
3290  * @since 2.9.0
3291  *
3292  * @param string $selected_zone Selected Zone
3293  * @return string
3294  */
3295 function wp_timezone_choice( $selected_zone ) {
3296         static $mo_loaded = false;
3297
3298         $continents = array( 'Africa', 'America', 'Antarctica', 'Arctic', 'Asia', 'Atlantic', 'Australia', 'Europe', 'Indian', 'Pacific');
3299
3300         // Load translations for continents and cities
3301         if ( !$mo_loaded ) {
3302                 $locale = get_locale();
3303                 $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
3304                 load_textdomain( 'continents-cities', $mofile );
3305                 $mo_loaded = true;
3306         }
3307
3308         $zonen = array();
3309         foreach ( timezone_identifiers_list() as $zone ) {
3310                 $zone = explode( '/', $zone );
3311                 if ( !in_array( $zone[0], $continents ) ) {
3312                         continue;
3313                 }
3314
3315                 // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
3316                 $exists = array(
3317                         0 => ( isset( $zone[0] ) && $zone[0] ),
3318                         1 => ( isset( $zone[1] ) && $zone[1] ),
3319                         2 => ( isset( $zone[2] ) && $zone[2] ),
3320                 );
3321                 $exists[3] = ( $exists[0] && 'Etc' !== $zone[0] );
3322                 $exists[4] = ( $exists[1] && $exists[3] );
3323                 $exists[5] = ( $exists[2] && $exists[3] );
3324
3325                 $zonen[] = array(
3326                         'continent'   => ( $exists[0] ? $zone[0] : '' ),
3327                         'city'        => ( $exists[1] ? $zone[1] : '' ),
3328                         'subcity'     => ( $exists[2] ? $zone[2] : '' ),
3329                         't_continent' => ( $exists[3] ? translate( str_replace( '_', ' ', $zone[0] ), 'continents-cities' ) : '' ),
3330                         't_city'      => ( $exists[4] ? translate( str_replace( '_', ' ', $zone[1] ), 'continents-cities' ) : '' ),
3331                         't_subcity'   => ( $exists[5] ? translate( str_replace( '_', ' ', $zone[2] ), 'continents-cities' ) : '' )
3332                 );
3333         }
3334         usort( $zonen, '_wp_timezone_choice_usort_callback' );
3335
3336         $structure = array();
3337
3338         if ( empty( $selected_zone ) ) {
3339                 $structure[] = '<option selected="selected" value="">' . __( 'Select a city' ) . '</option>';
3340         }
3341
3342         foreach ( $zonen as $key => $zone ) {
3343                 // Build value in an array to join later
3344                 $value = array( $zone['continent'] );
3345
3346                 if ( empty( $zone['city'] ) ) {
3347                         // It's at the continent level (generally won't happen)
3348                         $display = $zone['t_continent'];
3349                 } else {
3350                         // It's inside a continent group
3351
3352                         // Continent optgroup
3353                         if ( !isset( $zonen[$key - 1] ) || $zonen[$key - 1]['continent'] !== $zone['continent'] ) {
3354                                 $label = $zone['t_continent'];
3355                                 $structure[] = '<optgroup label="'. esc_attr( $label ) .'">';
3356                         }
3357
3358                         // Add the city to the value
3359                         $value[] = $zone['city'];
3360
3361                         $display = $zone['t_city'];
3362                         if ( !empty( $zone['subcity'] ) ) {
3363                                 // Add the subcity to the value
3364                                 $value[] = $zone['subcity'];
3365                                 $display .= ' - ' . $zone['t_subcity'];
3366                         }
3367                 }
3368
3369                 // Build the value
3370                 $value = join( '/', $value );
3371                 $selected = '';
3372                 if ( $value === $selected_zone ) {
3373                         $selected = 'selected="selected" ';
3374                 }
3375                 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $value ) . '">' . esc_html( $display ) . "</option>";
3376
3377                 // Close continent optgroup
3378                 if ( !empty( $zone['city'] ) && ( !isset($zonen[$key + 1]) || (isset( $zonen[$key + 1] ) && $zonen[$key + 1]['continent'] !== $zone['continent']) ) ) {
3379                         $structure[] = '</optgroup>';
3380                 }
3381         }
3382
3383         // Do UTC
3384         $structure[] = '<optgroup label="'. esc_attr__( 'UTC' ) .'">';
3385         $selected = '';
3386         if ( 'UTC' === $selected_zone )
3387                 $selected = 'selected="selected" ';
3388         $structure[] = '<option ' . $selected . 'value="' . esc_attr( 'UTC' ) . '">' . __('UTC') . '</option>';
3389         $structure[] = '</optgroup>';
3390
3391         // Do manual UTC offsets
3392         $structure[] = '<optgroup label="'. esc_attr__( 'Manual Offsets' ) .'">';
3393         $offset_range = array (-12, -11.5, -11, -10.5, -10, -9.5, -9, -8.5, -8, -7.5, -7, -6.5, -6, -5.5, -5, -4.5, -4, -3.5, -3, -2.5, -2, -1.5, -1, -0.5,
3394                 0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 5.75, 6, 6.5, 7, 7.5, 8, 8.5, 8.75, 9, 9.5, 10, 10.5, 11, 11.5, 12, 12.75, 13, 13.75, 14);
3395         foreach ( $offset_range as $offset ) {
3396                 if ( 0 <= $offset )
3397                         $offset_name = '+' . $offset;
3398                 else
3399                         $offset_name = (string) $offset;
3400
3401                 $offset_value = $offset_name;
3402                 $offset_name = str_replace(array('.25','.5','.75'), array(':15',':30',':45'), $offset_name);
3403                 $offset_name = 'UTC' . $offset_name;
3404                 $offset_value = 'UTC' . $offset_value;
3405                 $selected = '';
3406                 if ( $offset_value === $selected_zone )
3407                         $selected = 'selected="selected" ';
3408                 $structure[] = '<option ' . $selected . 'value="' . esc_attr( $offset_value ) . '">' . esc_html( $offset_name ) . "</option>";
3409
3410         }
3411         $structure[] = '</optgroup>';
3412
3413         return join( "\n", $structure );
3414 }
3415
3416 /**
3417  * Strip close comment and close php tags from file headers used by WP.
3418  * See http://core.trac.wordpress.org/ticket/8497
3419  *
3420  * @since 2.8.0
3421  *
3422  * @param string $str
3423  * @return string
3424  */
3425 function _cleanup_header_comment($str) {
3426         return trim(preg_replace("/\s*(?:\*\/|\?>).*/", '', $str));
3427 }
3428
3429 /**
3430  * Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.
3431  *
3432  * @since 2.9.0
3433  */
3434 function wp_scheduled_delete() {
3435         global $wpdb;
3436
3437         $delete_timestamp = time() - ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS );
3438
3439         $posts_to_delete = $wpdb->get_results($wpdb->prepare("SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wp_trash_meta_time' AND meta_value < '%d'", $delete_timestamp), ARRAY_A);
3440
3441         foreach ( (array) $posts_to_delete as $post ) {
3442                 $post_id = (int) $post['post_id'];
3443                 if ( !$post_id )
3444                         continue;
3445
3446                 $del_post = get_post($post_id);
3447
3448                 if ( !$del_post || 'trash' != $del_post->post_status ) {
3449                         delete_post_meta($post_id, '_wp_trash_meta_status');
3450                         delete_post_meta($post_id, '_wp_trash_meta_time');
3451                 } else {
3452                         wp_delete_post($post_id);
3453                 }
3454         }
3455
3456         $comments_to_delete = $wpdb->get_results($wpdb->prepare("SELECT comment_id FROM $wpdb->commentmeta WHERE meta_key = '_wp_trash_meta_time' AND meta_value < '%d'", $delete_timestamp), ARRAY_A);
3457
3458         foreach ( (array) $comments_to_delete as $comment ) {
3459                 $comment_id = (int) $comment['comment_id'];
3460                 if ( !$comment_id )
3461                         continue;
3462
3463                 $del_comment = get_comment($comment_id);
3464
3465                 if ( !$del_comment || 'trash' != $del_comment->comment_approved ) {
3466                         delete_comment_meta($comment_id, '_wp_trash_meta_time');
3467                         delete_comment_meta($comment_id, '_wp_trash_meta_status');
3468                 } else {
3469                         wp_delete_comment($comment_id);
3470                 }
3471         }
3472 }
3473
3474 /**
3475  * Retrieve metadata from a file.
3476  *
3477  * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
3478  * Each piece of metadata must be on its own line. Fields can not span multiple
3479  * lines, the value will get cut at the end of the first line.
3480  *
3481  * If the file data is not within that first 8kiB, then the author should correct
3482  * their plugin file and move the data headers to the top.
3483  *
3484  * @see http://codex.wordpress.org/File_Header
3485  *
3486  * @since 2.9.0
3487  * @param string $file Path to the file
3488  * @param array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name')
3489  * @param string $context If specified adds filter hook "extra_{$context}_headers"
3490  */
3491 function get_file_data( $file, $default_headers, $context = '' ) {
3492         // We don't need to write to the file, so just open for reading.
3493         $fp = fopen( $file, 'r' );
3494
3495         // Pull only the first 8kiB of the file in.
3496         $file_data = fread( $fp, 8192 );
3497
3498         // PHP will close file handle, but we are good citizens.
3499         fclose( $fp );
3500
3501         // Make sure we catch CR-only line endings.
3502         $file_data = str_replace( "\r", "\n", $file_data );
3503
3504         if ( $context && $extra_headers = apply_filters( "extra_{$context}_headers", array() ) ) {
3505                 $extra_headers = array_combine( $extra_headers, $extra_headers ); // keys equal values
3506                 $all_headers = array_merge( $extra_headers, (array) $default_headers );
3507         } else {
3508                 $all_headers = $default_headers;
3509         }
3510
3511         foreach ( $all_headers as $field => $regex ) {
3512                 if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] )
3513                         $all_headers[ $field ] = _cleanup_header_comment( $match[1] );
3514                 else
3515                         $all_headers[ $field ] = '';
3516         }
3517
3518         return $all_headers;
3519 }
3520
3521 /**
3522  * Used internally to tidy up the search terms.
3523  *
3524  * @access private
3525  * @since 2.9.0
3526  *
3527  * @param string $t
3528  * @return string
3529  */
3530 function _search_terms_tidy($t) {
3531         return trim($t, "\"'\n\r ");
3532 }
3533
3534 /**
3535  * Returns true.
3536  *
3537  * Useful for returning true to filters easily.
3538  *
3539  * @since 3.0.0
3540  * @see __return_false()
3541  * @return bool true
3542  */
3543 function __return_true() {
3544         return true;
3545 }
3546
3547 /**
3548  * Returns false.
3549  *
3550  * Useful for returning false to filters easily.
3551  *
3552  * @since 3.0.0
3553  * @see __return_true()
3554  * @return bool false
3555  */
3556 function __return_false() {
3557         return false;
3558 }
3559
3560 /**
3561  * Returns 0.
3562  *
3563  * Useful for returning 0 to filters easily.
3564  *
3565  * @since 3.0.0
3566  * @see __return_zero()
3567  * @return int 0
3568  */
3569 function __return_zero() {
3570         return 0;
3571 }
3572
3573 /**
3574  * Returns an empty array.
3575  *
3576  * Useful for returning an empty array to filters easily.
3577  *
3578  * @since 3.0.0
3579  * @see __return_zero()
3580  * @return array Empty array
3581  */
3582 function __return_empty_array() {
3583         return array();
3584 }
3585
3586 /**
3587  * Returns null.
3588  *
3589  * Useful for returning null to filters easily.
3590  *
3591  * @since 3.4.0
3592  * @return null
3593  */
3594 function __return_null() {
3595         return null;
3596 }
3597
3598 /**
3599  * Send a HTTP header to disable content type sniffing in browsers which support it.
3600  *
3601  * @link http://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx
3602  * @link http://src.chromium.org/viewvc/chrome?view=rev&revision=6985
3603  *
3604  * @since 3.0.0
3605  * @return none
3606  */
3607 function send_nosniff_header() {
3608         @header( 'X-Content-Type-Options: nosniff' );
3609 }
3610
3611 /**
3612  * Returns a MySQL expression for selecting the week number based on the start_of_week option.
3613  *
3614  * @internal
3615  * @since 3.0.0
3616  * @param string $column
3617  * @return string
3618  */
3619 function _wp_mysql_week( $column ) {
3620         switch ( $start_of_week = (int) get_option( 'start_of_week' ) ) {
3621         default :
3622         case 0 :
3623                 return "WEEK( $column, 0 )";
3624         case 1 :
3625                 return "WEEK( $column, 1 )";
3626         case 2 :
3627         case 3 :
3628         case 4 :
3629         case 5 :
3630         case 6 :
3631                 return "WEEK( DATE_SUB( $column, INTERVAL $start_of_week DAY ), 0 )";
3632         }
3633 }
3634
3635 /**
3636  * Finds hierarchy loops using a callback function that maps object IDs to parent IDs.
3637  *
3638  * @since 3.1.0
3639  * @access private
3640  *
3641  * @param callback $callback function that accepts ( ID, $callback_args ) and outputs parent_ID
3642  * @param int $start The ID to start the loop check at
3643  * @param int $start_parent the parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback
3644  * @param array $callback_args optional additional arguments to send to $callback
3645  * @return array IDs of all members of loop
3646  */
3647 function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) {
3648         $override = is_null( $start_parent ) ? array() : array( $start => $start_parent );
3649
3650         if ( !$arbitrary_loop_member = wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override, $callback_args ) )
3651                 return array();
3652
3653         return wp_find_hierarchy_loop_tortoise_hare( $callback, $arbitrary_loop_member, $override, $callback_args, true );
3654 }
3655
3656 /**
3657  * Uses the "The Tortoise and the Hare" algorithm to detect loops.
3658  *
3659  * For every step of the algorithm, the hare takes two steps and the tortoise one.
3660  * If the hare ever laps the tortoise, there must be a loop.
3661  *
3662  * @since 3.1.0
3663  * @access private
3664  *
3665  * @param callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID
3666  * @param int $start The ID to start the loop check at
3667  * @param array $override an array of ( ID => parent_ID, ... ) to use instead of $callback
3668  * @param array $callback_args optional additional arguments to send to $callback
3669  * @param bool $_return_loop Return loop members or just detect presence of loop?
3670  *             Only set to true if you already know the given $start is part of a loop
3671  *             (otherwise the returned array might include branches)
3672  * @return mixed scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop
3673  */
3674 function wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override = array(), $callback_args = array(), $_return_loop = false ) {
3675         $tortoise = $hare = $evanescent_hare = $start;
3676         $return = array();
3677
3678         // Set evanescent_hare to one past hare
3679         // Increment hare two steps
3680         while (
3681                 $tortoise
3682         &&
3683                 ( $evanescent_hare = isset( $override[$hare] ) ? $override[$hare] : call_user_func_array( $callback, array_merge( array( $hare ), $callback_args ) ) )
3684         &&
3685                 ( $hare = isset( $override[$evanescent_hare] ) ? $override[$evanescent_hare] : call_user_func_array( $callback, array_merge( array( $evanescent_hare ), $callback_args ) ) )
3686         ) {
3687                 if ( $_return_loop )
3688                         $return[$tortoise] = $return[$evanescent_hare] = $return[$hare] = true;
3689
3690                 // tortoise got lapped - must be a loop
3691                 if ( $tortoise == $evanescent_hare || $tortoise == $hare )
3692                         return $_return_loop ? $return : $tortoise;
3693
3694                 // Increment tortoise by one step
3695                 $tortoise = isset( $override[$tortoise] ) ? $override[$tortoise] : call_user_func_array( $callback, array_merge( array( $tortoise ), $callback_args ) );
3696         }
3697
3698         return false;
3699 }
3700
3701 /**
3702  * Send a HTTP header to limit rendering of pages to same origin iframes.
3703  *
3704  * @link https://developer.mozilla.org/en/the_x-frame-options_response_header
3705  *
3706  * @since 3.1.3
3707  * @return none
3708  */
3709 function send_frame_options_header() {
3710         @header( 'X-Frame-Options: SAMEORIGIN' );
3711 }
3712
3713 /**
3714  * Retrieve a list of protocols to allow in HTML attributes.
3715  *
3716  * @since 3.3.0
3717  * @see wp_kses()
3718  * @see esc_url()
3719  *
3720  * @return array Array of allowed protocols
3721  */
3722 function wp_allowed_protocols() {
3723         static $protocols;
3724
3725         if ( empty( $protocols ) ) {
3726                 $protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp' );
3727                 $protocols = apply_filters( 'kses_allowed_protocols', $protocols );
3728         }
3729
3730         return $protocols;
3731 }
3732
3733 /**
3734  * Return a comma separated string of functions that have been called to get to the current point in code.
3735  *
3736  * @link http://core.trac.wordpress.org/ticket/19589
3737  * @since 3.4
3738  *
3739  * @param string $ignore_class A class to ignore all function calls within - useful when you want to just give info about the callee
3740  * @param int $skip_frames A number of stack frames to skip - useful for unwinding back to the source of the issue
3741  * @param bool $pretty Whether or not you want a comma separated string or raw array returned
3742  * @return string|array Either a string containing a reversed comma separated trace or an array of individual calls.
3743  */
3744 function wp_debug_backtrace_summary( $ignore_class = null, $skip_frames = 0, $pretty = true ) {
3745         if ( version_compare( PHP_VERSION, '5.2.5', '>=' ) )
3746                 $trace = debug_backtrace( false );
3747         else
3748                 $trace = debug_backtrace();
3749
3750         $caller = array();
3751         $check_class = ! is_null( $ignore_class );
3752         $skip_frames++; // skip this function
3753
3754         foreach ( $trace as $call ) {
3755                 if ( $skip_frames > 0 ) {
3756                         $skip_frames--;
3757                 } elseif ( isset( $call['class'] ) ) {
3758                         if ( $check_class && $ignore_class == $call['class'] )
3759                                 continue; // Filter out calls
3760
3761                         $caller[] = "{$call['class']}{$call['type']}{$call['function']}";
3762                 } else {
3763                         if ( in_array( $call['function'], array( 'do_action', 'apply_filters' ) ) ) {
3764                                 $caller[] = "{$call['function']}('{$call['args'][0]}')";
3765                         } elseif ( in_array( $call['function'], array( 'include', 'include_once', 'require', 'require_once' ) ) ) {
3766                                 $caller[] = $call['function'] . "('" . str_replace( array( WP_CONTENT_DIR, ABSPATH ) , '', $call['args'][0] ) . "')";
3767                         } else {
3768                                 $caller[] = $call['function'];
3769                         }
3770                 }
3771         }
3772         if ( $pretty )
3773                 return join( ', ', array_reverse( $caller ) );
3774         else
3775                 return $caller;
3776 }
3777
3778 /**
3779  * Retrieve ids that are not already present in the cache
3780  *
3781  * @since 3.4.0
3782  *
3783  * @param array $object_ids ID list
3784  * @param string $cache_key The cache bucket to check against
3785  *
3786  * @return array
3787  */
3788 function _get_non_cached_ids( $object_ids, $cache_key ) {
3789         $clean = array();
3790         foreach ( $object_ids as $id ) {
3791                 $id = (int) $id;
3792                 if ( !wp_cache_get( $id, $cache_key ) ) {
3793                         $clean[] = $id;
3794                 }
3795         }
3796
3797         return $clean;
3798 }
3799
3800 /**
3801  * Test if the current device has the capability to upload files.
3802  *
3803  * @since 3.4.0
3804  * @access private
3805  *
3806  * @return bool true|false
3807  */
3808 function _device_can_upload() {