]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/misc.php
WordPress 3.4.2-scripts
[autoinstalls/wordpress.git] / wp-admin / includes / misc.php
index fcc3fe5550df639b8b6c9099339f62a75d773d5e..14f94fbed7c863d98df9c59e0ceec408607b917e 100644 (file)
@@ -1,12 +1,32 @@
 <?php
+/**
+ * Misc WordPress Administration API.
+ *
+ * @package WordPress
+ * @subpackage Administration
+ */
 
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.0.0
+ *
+ * @return unknown
+ */
 function got_mod_rewrite() {
        $got_rewrite = apache_mod_loaded('mod_rewrite', true);
        return apply_filters('got_rewrite', $got_rewrite);
 }
 
-// Returns an array of strings from a file (.htaccess ) from between BEGIN
-// and END markers.
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 1.5.0
+ *
+ * @param unknown_type $filename
+ * @param unknown_type $marker
+ * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
+ */
 function extract_from_markers( $filename, $marker ) {
        $result = array ();
 
@@ -30,10 +50,20 @@ function extract_from_markers( $filename, $marker ) {
        return $result;
 }
 
-// Inserts an array of strings into a file (.htaccess ), placing it between
-// BEGIN and END markers.  Replaces existing marked info.  Retains surrounding
-// data.  Creates file if none exists.
-// Returns true on write success, false on failure.
+/**
+ * {@internal Missing Short Description}}
+ *
+ * Inserts an array of strings into a file (.htaccess ), placing it between
+ * BEGIN and END markers. Replaces existing marked info. Retains surrounding
+ * data. Creates file if none exists.
+ *
+ * @since 1.5.0
+ *
+ * @param unknown_type $filename
+ * @param unknown_type $marker
+ * @param unknown_type $insertion
+ * @return bool True on write success, false on failure.
+ */
 function insert_with_markers( $filename, $marker, $insertion ) {
        if (!file_exists( $filename ) || is_writeable( $filename ) ) {
                if (!file_exists( $filename ) ) {
@@ -42,7 +72,9 @@ function insert_with_markers( $filename, $marker, $insertion ) {
                        $markerdata = explode( "\n", implode( '', file( $filename ) ) );
                }
 
-               $f = fopen( $filename, 'w' );
+               if ( !$f = @fopen( $filename, 'w' ) )
+                       return false;
+
                $foundit = false;
                if ( $markerdata ) {
                        $state = true;
@@ -67,7 +99,7 @@ function insert_with_markers( $filename, $marker, $insertion ) {
                        }
                }
                if (!$foundit) {
-                       fwrite( $f, "# BEGIN {$marker}\n" );
+                       fwrite( $f, "\n# BEGIN {$marker}\n" );
                        foreach ( $insertion as $insertline )
                                fwrite( $f, "{$insertline}\n" );
                        fwrite( $f, "# END {$marker}\n" );
@@ -82,16 +114,21 @@ function insert_with_markers( $filename, $marker, $insertion ) {
 /**
  * Updates the htaccess file with the current rules if it is writable.
  *
- * Always writes to the file if it exists and is writable to ensure that we blank out old rules.
+ * Always writes to the file if it exists and is writable to ensure that we
+ * blank out old rules.
+ *
+ * @since 1.5.0
  */
-
 function save_mod_rewrite_rules() {
+       if ( is_multisite() )
+               return;
+
        global $wp_rewrite;
 
        $home_path = get_home_path();
        $htaccess_file = $home_path.'.htaccess';
 
-       // If the file doesn't already exists check for write access to the directory and whether of not we have some rules.
+       // If the file doesn't already exist check for write access to the directory and whether we have some rules.
        // else check for write access to the file.
        if ((!file_exists($htaccess_file) && is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks()) || is_writable($htaccess_file)) {
                if ( got_mod_rewrite() ) {
@@ -103,6 +140,42 @@ function save_mod_rewrite_rules() {
        return false;
 }
 
+/**
+ * Updates the IIS web.config file with the current rules if it is writable.
+ * If the permalinks do not require rewrite rules then the rules are deleted from the web.config file.
+ *
+ * @since 2.8.0
+ *
+ * @return bool True if web.config was updated successfully
+ */
+function iis7_save_url_rewrite_rules(){
+       if ( is_multisite() )
+               return;
+
+       global $wp_rewrite;
+
+       $home_path = get_home_path();
+       $web_config_file = $home_path . 'web.config';
+
+       // Using win_is_writable() instead of is_writable() because of a bug in Windows PHP
+       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) ) ) {
+               $rule = $wp_rewrite->iis7_url_rewrite_rules(false, '', '');
+               if ( ! empty($rule) ) {
+                       return iis7_add_rewrite_rule($web_config_file, $rule);
+               } else {
+                       return iis7_delete_rewrite_rule($web_config_file);
+               }
+       }
+       return false;
+}
+
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 1.5.0
+ *
+ * @param unknown_type $file
+ */
 function update_recently_edited( $file ) {
        $oldfiles = (array ) get_option( 'recently_edited' );
        if ( $oldfiles ) {
@@ -118,46 +191,402 @@ function update_recently_edited( $file ) {
        update_option( 'recently_edited', $oldfiles );
 }
 
-// If siteurl or home changed, flush rewrite rules.
+/**
+ * If siteurl or home changed, flush rewrite rules.
+ *
+ * @since 2.1.0
+ *
+ * @param string $old_value
+ * @param string $value
+ */
 function update_home_siteurl( $old_value, $value ) {
-       global $wp_rewrite;
-
        if ( defined( "WP_INSTALLING" ) )
                return;
 
        // If home changed, write rewrite rules to new location.
-       $wp_rewrite->flush_rules();
+       flush_rewrite_rules();
 }
 
 add_action( 'update_option_home', 'update_home_siteurl', 10, 2 );
 add_action( 'update_option_siteurl', 'update_home_siteurl', 10, 2 );
 
+/**
+ * Shorten an URL, to be used as link text
+ *
+ * @since 1.2.1
+ *
+ * @param string $url
+ * @return string
+ */
 function url_shorten( $url ) {
        $short_url = str_replace( 'http://', '', stripslashes( $url ));
        $short_url = str_replace( 'www.', '', $short_url );
-       if ('/' == substr( $short_url, -1 ))
-               $short_url = substr( $short_url, 0, -1 );
+       $short_url = untrailingslashit( $short_url );
        if ( strlen( $short_url ) > 35 )
-               $short_url = substr( $short_url, 0, 32 ).'...';
+               $short_url = substr( $short_url, 0, 32 ) . '...';
        return $short_url;
 }
 
+/**
+ * Resets global variables based on $_GET and $_POST
+ *
+ * This function resets global variables based on the names passed
+ * in the $vars array to the value of $_POST[$var] or $_GET[$var] or ''
+ * if neither is defined.
+ *
+ * @since 2.0.0
+ *
+ * @param array $vars An array of globals to reset.
+ */
 function wp_reset_vars( $vars ) {
        for ( $i=0; $i<count( $vars ); $i += 1 ) {
                $var = $vars[$i];
                global $$var;
 
-               if (!isset( $$var ) ) {
-                       if ( empty( $_POST["$var"] ) ) {
-                               if ( empty( $_GET["$var"] ) )
-                                       $$var = '';
-                               else
-                                       $$var = $_GET["$var"];
+               if ( empty( $_POST[$var] ) ) {
+                       if ( empty( $_GET[$var] ) )
+                               $$var = '';
+                       else
+                               $$var = $_GET[$var];
+               } else {
+                       $$var = $_POST[$var];
+               }
+       }
+}
+
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.1.0
+ *
+ * @param unknown_type $message
+ */
+function show_message($message) {
+       if ( is_wp_error($message) ){
+               if ( $message->get_error_data() )
+                       $message = $message->get_error_message() . ': ' . $message->get_error_data();
+               else
+                       $message = $message->get_error_message();
+       }
+       echo "<p>$message</p>\n";
+       wp_ob_end_flush_all();
+       flush();
+}
+
+function wp_doc_link_parse( $content ) {
+       if ( !is_string( $content ) || empty( $content ) )
+               return array();
+
+       if ( !function_exists('token_get_all') )
+               return array();
+
+       $tokens = token_get_all( $content );
+       $functions = array();
+       $ignore_functions = array();
+       for ( $t = 0, $count = count( $tokens ); $t < $count; $t++ ) {
+               if ( !is_array( $tokens[$t] ) ) continue;
+               if ( T_STRING == $tokens[$t][0] && ( '(' == $tokens[ $t + 1 ] || '(' == $tokens[ $t + 2 ] ) ) {
+                       // If it's a function or class defined locally, there's not going to be any docs available
+                       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] ) ) {
+                               $ignore_functions[] = $tokens[$t][1];
+                       }
+                       // Add this to our stack of unique references
+                       $functions[] = $tokens[$t][1];
+               }
+       }
+
+       $functions = array_unique( $functions );
+       sort( $functions );
+       $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
+       $ignore_functions = array_unique( $ignore_functions );
+
+       $out = array();
+       foreach ( $functions as $function ) {
+               if ( in_array( $function, $ignore_functions ) )
+                       continue;
+               $out[] = $function;
+       }
+
+       return $out;
+}
+
+/**
+ * Saves option for number of rows when listing posts, pages, comments, etc.
+ *
+ * @since 2.8
+**/
+function set_screen_options() {
+
+       if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
+               check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );
+
+               if ( !$user = wp_get_current_user() )
+                       return;
+               $option = $_POST['wp_screen_options']['option'];
+               $value = $_POST['wp_screen_options']['value'];
+
+               if ( !preg_match( '/^[a-z_-]+$/', $option ) )
+                       return;
+
+               $option = str_replace('-', '_', $option);
+
+               $map_option = $option;
+               $type = str_replace('edit_', '', $map_option);
+               $type = str_replace('_per_page', '', $type);
+               if ( in_array($type, get_post_types()) )
+                       $map_option = 'edit_per_page';
+               if ( in_array( $type, get_taxonomies()) )
+                       $map_option = 'edit_tags_per_page';
+
+               switch ( $map_option ) {
+                       case 'edit_per_page':
+                       case 'users_per_page':
+                       case 'edit_comments_per_page':
+                       case 'upload_per_page':
+                       case 'edit_tags_per_page':
+                       case 'plugins_per_page':
+                       // Network admin
+                       case 'sites_network_per_page':
+                       case 'users_network_per_page':
+                       case 'site_users_network_per_page':
+                       case 'plugins_network_per_page':
+                       case 'themes_network_per_page':
+                       case 'site_themes_network_per_page':
+                               $value = (int) $value;
+                               if ( $value < 1 || $value > 999 )
+                                       return;
+                               break;
+                       default:
+                               $value = apply_filters('set-screen-option', false, $option, $value);
+                               if ( false === $value )
+                                       return;
+                               break;
+               }
+
+               update_user_meta($user->ID, $option, $value);
+               wp_safe_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
+               exit;
+       }
+}
+
+/**
+ * Check if rewrite rule for WordPress already exists in the IIS 7 configuration file
+ *
+ * @since 2.8.0
+ *
+ * @return bool
+ * @param string $filename The file path to the configuration file
+ */
+function iis7_rewrite_rule_exists($filename) {
+       if ( ! file_exists($filename) )
+               return false;
+       if ( ! class_exists('DOMDocument') )
+               return false;
+
+       $doc = new DOMDocument();
+       if ( $doc->load($filename) === false )
+               return false;
+       $xpath = new DOMXPath($doc);
+       $rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
+       if ( $rules->length == 0 )
+               return false;
+       else
+               return true;
+}
+
+/**
+ * Delete WordPress rewrite rule from web.config file if it exists there
+ *
+ * @since 2.8.0
+ *
+ * @param string $filename Name of the configuration file
+ * @return bool
+ */
+function iis7_delete_rewrite_rule($filename) {
+       // If configuration file does not exist then rules also do not exist so there is nothing to delete
+       if ( ! file_exists($filename) )
+               return true;
+
+       if ( ! class_exists('DOMDocument') )
+               return false;
+
+       $doc = new DOMDocument();
+       $doc->preserveWhiteSpace = false;
+
+       if ( $doc -> load($filename) === false )
+               return false;
+       $xpath = new DOMXPath($doc);
+       $rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
+       if ( $rules->length > 0 ) {
+               $child = $rules->item(0);
+               $parent = $child->parentNode;
+               $parent->removeChild($child);
+               $doc->formatOutput = true;
+               saveDomDocument($doc, $filename);
+       }
+       return true;
+}
+
+/**
+ * Add WordPress rewrite rule to the IIS 7 configuration file.
+ *
+ * @since 2.8.0
+ *
+ * @param string $filename The file path to the configuration file
+ * @param string $rewrite_rule The XML fragment with URL Rewrite rule
+ * @return bool
+ */
+function iis7_add_rewrite_rule($filename, $rewrite_rule) {
+       if ( ! class_exists('DOMDocument') )
+               return false;
+
+       // If configuration file does not exist then we create one.
+       if ( ! file_exists($filename) ) {
+               $fp = fopen( $filename, 'w');
+               fwrite($fp, '<configuration/>');
+               fclose($fp);
+       }
+
+       $doc = new DOMDocument();
+       $doc->preserveWhiteSpace = false;
+
+       if ( $doc->load($filename) === false )
+               return false;
+
+       $xpath = new DOMXPath($doc);
+
+       // First check if the rule already exists as in that case there is no need to re-add it
+       $wordpress_rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
+       if ( $wordpress_rules->length > 0 )
+               return true;
+
+       // Check the XPath to the rewrite rule and create XML nodes if they do not exist
+       $xmlnodes = $xpath->query('/configuration/system.webServer/rewrite/rules');
+       if ( $xmlnodes->length > 0 ) {
+               $rules_node = $xmlnodes->item(0);
+       } else {
+               $rules_node = $doc->createElement('rules');
+
+               $xmlnodes = $xpath->query('/configuration/system.webServer/rewrite');
+               if ( $xmlnodes->length > 0 ) {
+                       $rewrite_node = $xmlnodes->item(0);
+                       $rewrite_node->appendChild($rules_node);
+               } else {
+                       $rewrite_node = $doc->createElement('rewrite');
+                       $rewrite_node->appendChild($rules_node);
+
+                       $xmlnodes = $xpath->query('/configuration/system.webServer');
+                       if ( $xmlnodes->length > 0 ) {
+                               $system_webServer_node = $xmlnodes->item(0);
+                               $system_webServer_node->appendChild($rewrite_node);
                        } else {
-                               $$var = $_POST["$var"];
+                               $system_webServer_node = $doc->createElement('system.webServer');
+                               $system_webServer_node->appendChild($rewrite_node);
+
+                               $xmlnodes = $xpath->query('/configuration');
+                               if ( $xmlnodes->length > 0 ) {
+                                       $config_node = $xmlnodes->item(0);
+                                       $config_node->appendChild($system_webServer_node);
+                               } else {
+                                       $config_node = $doc->createElement('configuration');
+                                       $doc->appendChild($config_node);
+                                       $config_node->appendChild($system_webServer_node);
+                               }
                        }
                }
        }
+
+       $rule_fragment = $doc->createDocumentFragment();
+       $rule_fragment->appendXML($rewrite_rule);
+       $rules_node->appendChild($rule_fragment);
+
+       $doc->encoding = "UTF-8";
+       $doc->formatOutput = true;
+       saveDomDocument($doc, $filename);
+
+       return true;
 }
 
-?>
+/**
+ * Saves the XML document into a file
+ *
+ * @since 2.8.0
+ *
+ * @param DOMDocument $doc
+ * @param string $filename
+ */
+function saveDomDocument($doc, $filename) {
+       $config = $doc->saveXML();
+       $config = preg_replace("/([^\r])\n/", "$1\r\n", $config);
+       $fp = fopen($filename, 'w');
+       fwrite($fp, $config);
+       fclose($fp);
+}
+
+/**
+ * Workaround for Windows bug in is_writable() function
+ *
+ * @since 2.8.0
+ *
+ * @param string $path
+ * @return bool
+ */
+function win_is_writable( $path ) {
+       /* will work in despite of Windows ACLs bug
+        * NOTE: use a trailing slash for folders!!!
+        * see http://bugs.php.net/bug.php?id=27609
+        * see http://bugs.php.net/bug.php?id=30931
+        */
+
+       if ( $path[strlen( $path ) - 1] == '/' ) // recursively return a temporary file path
+               return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp');
+       else if ( is_dir( $path ) )
+               return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
+       // check tmp file for read/write capabilities
+       $should_delete_tmp_file = !file_exists( $path );
+       $f = @fopen( $path, 'a' );
+       if ( $f === false )
+               return false;
+       fclose( $f );
+       if ( $should_delete_tmp_file )
+               unlink( $path );
+       return true;
+}
+
+/**
+ * Display the default admin color scheme picker (Used in user-edit.php)
+ *
+ * @since 3.0.0
+ */
+function admin_color_scheme_picker() {
+       global $_wp_admin_css_colors, $user_id; ?>
+<fieldset><legend class="screen-reader-text"><span><?php _e('Admin Color Scheme')?></span></legend>
+<?php
+$current_color = get_user_option('admin_color', $user_id);
+if ( empty($current_color) )
+       $current_color = 'fresh';
+foreach ( $_wp_admin_css_colors as $color => $color_info ): ?>
+<div class="color-option"><input name="admin_color" id="admin_color_<?php echo $color; ?>" type="radio" value="<?php echo esc_attr($color) ?>" class="tog" <?php checked($color, $current_color); ?> />
+       <table class="color-palette">
+       <tr>
+       <?php foreach ( $color_info->colors as $html_color ): ?>
+       <td style="background-color: <?php echo $html_color ?>" title="<?php echo $color ?>">&nbsp;</td>
+       <?php endforeach; ?>
+       </tr>
+       </table>
+
+       <label for="admin_color_<?php echo $color; ?>"><?php echo $color_info->name ?></label>
+</div>
+       <?php endforeach; ?>
+</fieldset>
+<?php
+}
+
+function _ipad_meta() {
+       if ( wp_is_mobile() ) {
+               ?>
+               <meta name="viewport" id="viewport-meta" content="width=device-width, initial-scale=1">
+               <?php
+       }
+}
+add_action('admin_head', '_ipad_meta');