PageRenderTime 51ms CodeModel.GetById 15ms app.highlight 28ms RepoModel.GetById 1ms app.codeStats 1ms

/wp-admin/includes/misc.php

https://github.com/dipakdotyadav/WordPress
PHP | 660 lines | 432 code | 70 blank | 158 comment | 107 complexity | 0c76b47946c53f02ef2ae635f99f21b2 MD5 | raw file
  1<?php
  2/**
  3 * Misc WordPress Administration API.
  4 *
  5 * @package WordPress
  6 * @subpackage Administration
  7 */
  8
  9/**
 10 * {@internal Missing Short Description}}
 11 *
 12 * @since 2.0.0
 13 *
 14 * @return unknown
 15 */
 16function got_mod_rewrite() {
 17	$got_rewrite = apache_mod_loaded('mod_rewrite', true);
 18	return apply_filters('got_rewrite', $got_rewrite);
 19}
 20
 21/**
 22 * {@internal Missing Short Description}}
 23 *
 24 * @since 1.5.0
 25 *
 26 * @param unknown_type $filename
 27 * @param unknown_type $marker
 28 * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
 29 */
 30function extract_from_markers( $filename, $marker ) {
 31	$result = array ();
 32
 33	if (!file_exists( $filename ) ) {
 34		return $result;
 35	}
 36
 37	if ( $markerdata = explode( "\n", implode( '', file( $filename ) ) ));
 38	{
 39		$state = false;
 40		foreach ( $markerdata as $markerline ) {
 41			if (strpos($markerline, '# END ' . $marker) !== false)
 42				$state = false;
 43			if ( $state )
 44				$result[] = $markerline;
 45			if (strpos($markerline, '# BEGIN ' . $marker) !== false)
 46				$state = true;
 47		}
 48	}
 49
 50	return $result;
 51}
 52
 53/**
 54 * {@internal Missing Short Description}}
 55 *
 56 * Inserts an array of strings into a file (.htaccess ), placing it between
 57 * BEGIN and END markers. Replaces existing marked info. Retains surrounding
 58 * data. Creates file if none exists.
 59 *
 60 * @since 1.5.0
 61 *
 62 * @param unknown_type $filename
 63 * @param unknown_type $marker
 64 * @param unknown_type $insertion
 65 * @return bool True on write success, false on failure.
 66 */
 67function insert_with_markers( $filename, $marker, $insertion ) {
 68	if (!file_exists( $filename ) || is_writeable( $filename ) ) {
 69		if (!file_exists( $filename ) ) {
 70			$markerdata = '';
 71		} else {
 72			$markerdata = explode( "\n", implode( '', file( $filename ) ) );
 73		}
 74
 75		if ( !$f = @fopen( $filename, 'w' ) )
 76			return false;
 77
 78		$foundit = false;
 79		if ( $markerdata ) {
 80			$state = true;
 81			foreach ( $markerdata as $n => $markerline ) {
 82				if (strpos($markerline, '# BEGIN ' . $marker) !== false)
 83					$state = false;
 84				if ( $state ) {
 85					if ( $n + 1 < count( $markerdata ) )
 86						fwrite( $f, "{$markerline}\n" );
 87					else
 88						fwrite( $f, "{$markerline}" );
 89				}
 90				if (strpos($markerline, '# END ' . $marker) !== false) {
 91					fwrite( $f, "# BEGIN {$marker}\n" );
 92					if ( is_array( $insertion ))
 93						foreach ( $insertion as $insertline )
 94							fwrite( $f, "{$insertline}\n" );
 95					fwrite( $f, "# END {$marker}\n" );
 96					$state = true;
 97					$foundit = true;
 98				}
 99			}
100		}
101		if (!$foundit) {
102			fwrite( $f, "\n# BEGIN {$marker}\n" );
103			foreach ( $insertion as $insertline )
104				fwrite( $f, "{$insertline}\n" );
105			fwrite( $f, "# END {$marker}\n" );
106		}
107		fclose( $f );
108		return true;
109	} else {
110		return false;
111	}
112}
113
114/**
115 * Updates the htaccess file with the current rules if it is writable.
116 *
117 * Always writes to the file if it exists and is writable to ensure that we
118 * blank out old rules.
119 *
120 * @since 1.5.0
121 */
122function save_mod_rewrite_rules() {
123	if ( is_multisite() )
124		return;
125
126	global $wp_rewrite;
127
128	$home_path = get_home_path();
129	$htaccess_file = $home_path.'.htaccess';
130
131	// If the file doesn't already exist check for write access to the directory and whether we have some rules.
132	// else check for write access to the file.
133	if ((!file_exists($htaccess_file) && is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks()) || is_writable($htaccess_file)) {
134		if ( got_mod_rewrite() ) {
135			$rules = explode( "\n", $wp_rewrite->mod_rewrite_rules() );
136			return insert_with_markers( $htaccess_file, 'WordPress', $rules );
137		}
138	}
139
140	return false;
141}
142
143/**
144 * Updates the IIS web.config file with the current rules if it is writable.
145 * If the permalinks do not require rewrite rules then the rules are deleted from the web.config file.
146 *
147 * @since 2.8.0
148 *
149 * @return bool True if web.config was updated successfully
150 */
151function iis7_save_url_rewrite_rules(){
152	if ( is_multisite() )
153		return;
154
155	global $wp_rewrite;
156
157	$home_path = get_home_path();
158	$web_config_file = $home_path . 'web.config';
159
160	// Using win_is_writable() instead of is_writable() because of a bug in Windows PHP
161	if ( iis7_supports_permalinks() && ( ( ! file_exists($web_config_file) && win_is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks() ) || win_is_writable($web_config_file) ) ) {
162		$rule = $wp_rewrite->iis7_url_rewrite_rules(false, '', '');
163		if ( ! empty($rule) ) {
164			return iis7_add_rewrite_rule($web_config_file, $rule);
165		} else {
166			return iis7_delete_rewrite_rule($web_config_file);
167		}
168	}
169	return false;
170}
171
172/**
173 * {@internal Missing Short Description}}
174 *
175 * @since 1.5.0
176 *
177 * @param unknown_type $file
178 */
179function update_recently_edited( $file ) {
180	$oldfiles = (array ) get_option( 'recently_edited' );
181	if ( $oldfiles ) {
182		$oldfiles = array_reverse( $oldfiles );
183		$oldfiles[] = $file;
184		$oldfiles = array_reverse( $oldfiles );
185		$oldfiles = array_unique( $oldfiles );
186		if ( 5 < count( $oldfiles ))
187			array_pop( $oldfiles );
188	} else {
189		$oldfiles[] = $file;
190	}
191	update_option( 'recently_edited', $oldfiles );
192}
193
194/**
195 * If siteurl, home or page_on_front changed, flush rewrite rules.
196 *
197 * @since 2.1.0
198 *
199 * @param string $old_value
200 * @param string $value
201 */
202function update_home_siteurl( $old_value, $value ) {
203	if ( defined( "WP_INSTALLING" ) )
204		return;
205
206	// If home changed, write rewrite rules to new location.
207	flush_rewrite_rules();
208}
209
210add_action( 'update_option_home', 'update_home_siteurl', 10, 2 );
211add_action( 'update_option_siteurl', 'update_home_siteurl', 10, 2 );
212add_action( 'update_option_page_on_front', 'update_home_siteurl', 10, 2 );
213
214/**
215 * Shorten an URL, to be used as link text
216 *
217 * @since 1.2.1
218 *
219 * @param string $url
220 * @return string
221 */
222function url_shorten( $url ) {
223	$short_url = str_replace( array( 'http://', 'www.' ), '', $url );
224	$short_url = untrailingslashit( $short_url );
225	if ( strlen( $short_url ) > 35 )
226		$short_url = substr( $short_url, 0, 32 ) . '...';
227	return $short_url;
228}
229
230/**
231 * Resets global variables based on $_GET and $_POST
232 *
233 * This function resets global variables based on the names passed
234 * in the $vars array to the value of $_POST[$var] or $_GET[$var] or ''
235 * if neither is defined.
236 *
237 * @since 2.0.0
238 *
239 * @param array $vars An array of globals to reset.
240 */
241function wp_reset_vars( $vars ) {
242	for ( $i=0; $i<count( $vars ); $i += 1 ) {
243		$var = $vars[$i];
244		global $$var;
245
246		if ( empty( $_POST[$var] ) ) {
247			if ( empty( $_GET[$var] ) )
248				$$var = '';
249			else
250				$$var = $_GET[$var];
251		} else {
252			$$var = $_POST[$var];
253		}
254	}
255}
256
257/**
258 * {@internal Missing Short Description}}
259 *
260 * @since 2.1.0
261 *
262 * @param unknown_type $message
263 */
264function show_message($message) {
265	if ( is_wp_error($message) ){
266		if ( $message->get_error_data() )
267			$message = $message->get_error_message() . ': ' . $message->get_error_data();
268		else
269			$message = $message->get_error_message();
270	}
271	echo "<p>$message</p>\n";
272	wp_ob_end_flush_all();
273	flush();
274}
275
276function wp_doc_link_parse( $content ) {
277	if ( !is_string( $content ) || empty( $content ) )
278		return array();
279
280	if ( !function_exists('token_get_all') )
281		return array();
282
283	$tokens = token_get_all( $content );
284	$functions = array();
285	$ignore_functions = array();
286	for ( $t = 0, $count = count( $tokens ); $t < $count; $t++ ) {
287		if ( !is_array( $tokens[$t] ) ) continue;
288		if ( T_STRING == $tokens[$t][0] && ( '(' == $tokens[ $t + 1 ] || '(' == $tokens[ $t + 2 ] ) ) {
289			// If it's a function or class defined locally, there's not going to be any docs available
290			if ( ( isset( $tokens[ $t - 2 ][1] ) && in_array( $tokens[ $t - 2 ][1], array( 'function', 'class' ) ) ) || ( isset( $tokens[ $t - 2 ][0] ) && T_OBJECT_OPERATOR == $tokens[ $t - 1 ][0] ) ) {
291				$ignore_functions[] = $tokens[$t][1];
292			}
293			// Add this to our stack of unique references
294			$functions[] = $tokens[$t][1];
295		}
296	}
297
298	$functions = array_unique( $functions );
299	sort( $functions );
300	$ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
301	$ignore_functions = array_unique( $ignore_functions );
302
303	$out = array();
304	foreach ( $functions as $function ) {
305		if ( in_array( $function, $ignore_functions ) )
306			continue;
307		$out[] = $function;
308	}
309
310	return $out;
311}
312
313/**
314 * Saves option for number of rows when listing posts, pages, comments, etc.
315 *
316 * @since 2.8
317**/
318function set_screen_options() {
319
320	if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
321		check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );
322
323		if ( !$user = wp_get_current_user() )
324			return;
325		$option = $_POST['wp_screen_options']['option'];
326		$value = $_POST['wp_screen_options']['value'];
327
328		if ( $option != sanitize_key( $option ) )
329			return;
330
331		$map_option = $option;
332		$type = str_replace('edit_', '', $map_option);
333		$type = str_replace('_per_page', '', $type);
334		if ( in_array( $type, get_taxonomies() ) )
335			$map_option = 'edit_tags_per_page';
336		elseif ( in_array( $type, get_post_types() ) )
337			$map_option = 'edit_per_page';
338		else
339			$option = str_replace('-', '_', $option);
340
341		switch ( $map_option ) {
342			case 'edit_per_page':
343			case 'users_per_page':
344			case 'edit_comments_per_page':
345			case 'upload_per_page':
346			case 'edit_tags_per_page':
347			case 'plugins_per_page':
348			// Network admin
349			case 'sites_network_per_page':
350			case 'users_network_per_page':
351			case 'site_users_network_per_page':
352			case 'plugins_network_per_page':
353			case 'themes_network_per_page':
354			case 'site_themes_network_per_page':
355				$value = (int) $value;
356				if ( $value < 1 || $value > 999 )
357					return;
358				break;
359			default:
360				$value = apply_filters('set-screen-option', false, $option, $value);
361				if ( false === $value )
362					return;
363				break;
364		}
365
366		update_user_meta($user->ID, $option, $value);
367		wp_safe_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
368		exit;
369	}
370}
371
372/**
373 * Check if rewrite rule for WordPress already exists in the IIS 7 configuration file
374 *
375 * @since 2.8.0
376 *
377 * @return bool
378 * @param string $filename The file path to the configuration file
379 */
380function iis7_rewrite_rule_exists($filename) {
381	if ( ! file_exists($filename) )
382		return false;
383	if ( ! class_exists('DOMDocument') )
384		return false;
385
386	$doc = new DOMDocument();
387	if ( $doc->load($filename) === false )
388		return false;
389	$xpath = new DOMXPath($doc);
390	$rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
391	if ( $rules->length == 0 )
392		return false;
393	else
394		return true;
395}
396
397/**
398 * Delete WordPress rewrite rule from web.config file if it exists there
399 *
400 * @since 2.8.0
401 *
402 * @param string $filename Name of the configuration file
403 * @return bool
404 */
405function iis7_delete_rewrite_rule($filename) {
406	// If configuration file does not exist then rules also do not exist so there is nothing to delete
407	if ( ! file_exists($filename) )
408		return true;
409
410	if ( ! class_exists('DOMDocument') )
411		return false;
412
413	$doc = new DOMDocument();
414	$doc->preserveWhiteSpace = false;
415
416	if ( $doc -> load($filename) === false )
417		return false;
418	$xpath = new DOMXPath($doc);
419	$rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
420	if ( $rules->length > 0 ) {
421		$child = $rules->item(0);
422		$parent = $child->parentNode;
423		$parent->removeChild($child);
424		$doc->formatOutput = true;
425		saveDomDocument($doc, $filename);
426	}
427	return true;
428}
429
430/**
431 * Add WordPress rewrite rule to the IIS 7 configuration file.
432 *
433 * @since 2.8.0
434 *
435 * @param string $filename The file path to the configuration file
436 * @param string $rewrite_rule The XML fragment with URL Rewrite rule
437 * @return bool
438 */
439function iis7_add_rewrite_rule($filename, $rewrite_rule) {
440	if ( ! class_exists('DOMDocument') )
441		return false;
442
443	// If configuration file does not exist then we create one.
444	if ( ! file_exists($filename) ) {
445		$fp = fopen( $filename, 'w');
446		fwrite($fp, '<configuration/>');
447		fclose($fp);
448	}
449
450	$doc = new DOMDocument();
451	$doc->preserveWhiteSpace = false;
452
453	if ( $doc->load($filename) === false )
454		return false;
455
456	$xpath = new DOMXPath($doc);
457
458	// First check if the rule already exists as in that case there is no need to re-add it
459	$wordpress_rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
460	if ( $wordpress_rules->length > 0 )
461		return true;
462
463	// Check the XPath to the rewrite rule and create XML nodes if they do not exist
464	$xmlnodes = $xpath->query('/configuration/system.webServer/rewrite/rules');
465	if ( $xmlnodes->length > 0 ) {
466		$rules_node = $xmlnodes->item(0);
467	} else {
468		$rules_node = $doc->createElement('rules');
469
470		$xmlnodes = $xpath->query('/configuration/system.webServer/rewrite');
471		if ( $xmlnodes->length > 0 ) {
472			$rewrite_node = $xmlnodes->item(0);
473			$rewrite_node->appendChild($rules_node);
474		} else {
475			$rewrite_node = $doc->createElement('rewrite');
476			$rewrite_node->appendChild($rules_node);
477
478			$xmlnodes = $xpath->query('/configuration/system.webServer');
479			if ( $xmlnodes->length > 0 ) {
480				$system_webServer_node = $xmlnodes->item(0);
481				$system_webServer_node->appendChild($rewrite_node);
482			} else {
483				$system_webServer_node = $doc->createElement('system.webServer');
484				$system_webServer_node->appendChild($rewrite_node);
485
486				$xmlnodes = $xpath->query('/configuration');
487				if ( $xmlnodes->length > 0 ) {
488					$config_node = $xmlnodes->item(0);
489					$config_node->appendChild($system_webServer_node);
490				} else {
491					$config_node = $doc->createElement('configuration');
492					$doc->appendChild($config_node);
493					$config_node->appendChild($system_webServer_node);
494				}
495			}
496		}
497	}
498
499	$rule_fragment = $doc->createDocumentFragment();
500	$rule_fragment->appendXML($rewrite_rule);
501	$rules_node->appendChild($rule_fragment);
502
503	$doc->encoding = "UTF-8";
504	$doc->formatOutput = true;
505	saveDomDocument($doc, $filename);
506
507	return true;
508}
509
510/**
511 * Saves the XML document into a file
512 *
513 * @since 2.8.0
514 *
515 * @param DOMDocument $doc
516 * @param string $filename
517 */
518function saveDomDocument($doc, $filename) {
519	$config = $doc->saveXML();
520	$config = preg_replace("/([^\r])\n/", "$1\r\n", $config);
521	$fp = fopen($filename, 'w');
522	fwrite($fp, $config);
523	fclose($fp);
524}
525
526/**
527 * Display the default admin color scheme picker (Used in user-edit.php)
528 *
529 * @since 3.0.0
530 */
531function admin_color_scheme_picker() {
532	global $_wp_admin_css_colors, $user_id; ?>
533<fieldset><legend class="screen-reader-text"><span><?php _e('Admin Color Scheme')?></span></legend>
534<?php
535$current_color = get_user_option('admin_color', $user_id);
536if ( empty($current_color) )
537	$current_color = 'fresh';
538foreach ( $_wp_admin_css_colors as $color => $color_info ): ?>
539<div class="color-option"><input name="admin_color" id="admin_color_<?php echo esc_attr( $color ); ?>" type="radio" value="<?php echo esc_attr( $color ); ?>" class="tog" <?php checked($color, $current_color); ?> />
540	<table class="color-palette">
541	<tr>
542	<?php foreach ( $color_info->colors as $html_color ): ?>
543	<td style="background-color: <?php echo esc_attr( $html_color ); ?>" title="<?php echo esc_attr( $color ); ?>">&nbsp;</td>
544	<?php endforeach; ?>
545	</tr>
546	</table>
547
548	<label for="admin_color_<?php echo esc_attr( $color ); ?>"><?php echo esc_html( $color_info->name ); ?></label>
549</div>
550	<?php endforeach; ?>
551</fieldset>
552<?php
553}
554
555function _ipad_meta() {
556	if ( wp_is_mobile() ) {
557		?>
558		<meta name="viewport" id="viewport-meta" content="width=device-width, initial-scale=1">
559		<?php
560	}
561}
562add_action('admin_head', '_ipad_meta');
563
564/**
565 * Check lock status for posts displayed on the Posts screen
566 *
567 * @since 3.6
568 */
569function wp_check_locked_posts( $response, $data, $screen_id ) {
570	$checked = array();
571
572	if ( 'edit-post' == $screen_id && array_key_exists( 'wp-check-locked', $data ) && is_array( $data['wp-check-locked'] ) ) {
573		foreach ( $data['wp-check-locked'] as $key ) {
574			$post_id = (int) substr( $key, 5 );
575
576			if ( current_user_can( 'edit_post', $post_id ) && ( $user_id = wp_check_post_lock( $post_id ) ) && ( $user = get_userdata( $user_id ) ) ) {
577				$send = array();
578
579				if ( ( $avatar = get_avatar( $user->ID, 18 ) ) && preg_match( "|src='([^']+)'|", $avatar, $matches ) )
580					$send['avatar_src'] = $matches[1];
581
582				$send['text'] = sprintf( __( '%s is currently editing' ), $user->display_name );
583				$checked[$key] = $send;
584			}
585		}
586	}
587
588	if ( ! empty( $checked ) )
589		$response['wp-check-locked'] = $checked;
590
591	return $response;
592}
593add_filter( 'heartbeat_received', 'wp_check_locked_posts', 10, 3 );
594
595/**
596 * Check lock status on the New/Edit Post screen and refresh the lock
597 *
598 * @since 3.6
599 */
600function wp_refresh_post_lock( $response, $data, $screen_id ) {
601	if ( 'post' == $screen_id && array_key_exists( 'wp-refresh-post-lock', $data ) ) {
602		$received = $data['wp-refresh-post-lock'];
603		$send = array();
604
605		if ( !$post_id = absint( $received['post_id'] ) )
606			return $response;
607
608		if ( !current_user_can('edit_post', $post_id) )
609			return $response;
610
611		if ( $user_id = wp_check_post_lock( $post_id ) ) {
612			$user = get_userdata( $user_id );
613
614			$error = array(
615				'text' => sprintf( __( '%s has taken over and is currently editing.' ), $user->display_name )
616			);
617			
618			if ( $avatar = get_avatar( $user->ID, 64 ) ) {
619				if ( preg_match( "|src='([^']+)'|", $avatar, $matches ) )
620					$error['avatar_src'] = $matches[1];
621			}
622
623			$send['lock_error'] = $error;
624		} else {
625			if ( $new_lock = wp_set_post_lock( $post_id ) )
626				$send['new_lock'] = implode( ':', $new_lock );
627		}
628
629		$response['wp-refresh-post-lock'] = $send;
630	}
631
632	return $response;
633}
634add_filter( 'heartbeat_received', 'wp_refresh_post_lock', 10, 3 );
635
636/**
637 * Output the HTML for restoring the post data from DOM storage
638 *
639 * @since 3.6
640 * @access private
641 */
642function _local_storage_notice() {
643	$screen = get_current_screen();
644	if ( ! $screen || 'post' != $screen->id )
645		return;
646
647	?>
648	<div id="local-storage-notice" class="hidden">
649	<p class="local-restore">
650		<?php _e('The backup of this post in your browser is different from the version below.'); ?>
651		<a class="restore-backup" href="#"><?php _e('Restore the backup.'); ?></a>
652	</p>
653	<p class="undo-restore hidden">
654		<?php _e('Post restored successfully.'); ?>
655		<a class="undo-restore-backup" href="#"><?php _e('Undo.'); ?></a>
656	</p>
657	</div>
658	<?php
659}
660add_action( 'admin_footer', '_local_storage_notice' );