X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..f8ce8fee333796f41d394479265f31b87bd6e436:/wp-includes/bookmark.php diff --git a/wp-includes/bookmark.php b/wp-includes/bookmark.php index 776d5193..641ae3b4 100644 --- a/wp-includes/bookmark.php +++ b/wp-includes/bookmark.php @@ -7,9 +7,9 @@ */ /** - * get_bookmark() - Get Bookmark data based on ID + * Retrieve Bookmark data based on ID * - * @since 2.1 + * @since 2.1.0 * @uses $wpdb Database Object * * @param int $bookmark_id @@ -17,29 +17,44 @@ * @param string $filter Optional, default is 'raw'. * @return array|object Type returned depends on $output value. */ -function get_bookmark($bookmark_id, $output = OBJECT, $filter = 'raw') { +function get_bookmark($bookmark, $output = OBJECT, $filter = 'raw') { global $wpdb; - $link = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark_id)); - $link->link_category = array_unique( wp_get_object_terms($link->link_id, 'link_category', 'fields=ids') ); + if ( empty($bookmark) ) { + if ( isset($GLOBALS['link']) ) + $_bookmark = & $GLOBALS['link']; + else + $_bookmark = null; + } elseif ( is_object($bookmark) ) { + wp_cache_add($bookmark->link_id, $bookmark, 'bookmark'); + $_bookmark = $bookmark; + } else { + if ( isset($GLOBALS['link']) && ($GLOBALS['link']->link_id == $bookmark) ) { + $_bookmark = & $GLOBALS['link']; + } elseif ( ! $_bookmark = wp_cache_get($bookmark, 'bookmark') ) { + $_bookmark = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark)); + $_bookmark->link_category = array_unique( wp_get_object_terms($_bookmark->link_id, 'link_category', array('fields' => 'ids')) ); + wp_cache_add($_bookmark->link_id, $_bookmark, 'bookmark'); + } + } - $link = sanitize_bookmark($link, $filter); + $_bookmark = sanitize_bookmark($_bookmark, $filter); if ( $output == OBJECT ) { - return $link; + return $_bookmark; } elseif ( $output == ARRAY_A ) { - return get_object_vars($link); + return get_object_vars($_bookmark); } elseif ( $output == ARRAY_N ) { - return array_values(get_object_vars($link)); + return array_values(get_object_vars($_bookmark)); } else { - return $link; + return $_bookmark; } } /** - * get_bookmark_field() - Gets single bookmark data item or field. + * Retrieve single bookmark data item or field. * - * @since 2.3 + * @since 2.3.0 * @uses get_bookmark() Gets bookmark object using $bookmark as ID * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context. * @@ -65,40 +80,35 @@ function get_bookmark_field( $field, $bookmark, $context = 'display' ) { } /** - * get_link() - Returns bookmark data based on ID. - * - * @since 2.0 - * @deprecated Use get_bookmark() - * @see get_bookmark() - * - * @param int $bookmark_id ID of link - * @param string $output Either OBJECT, ARRAY_N, or ARRAY_A - * @return object|array - */ -function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') { - return get_bookmark($bookmark_id, $output, $filter); -} - -/** - * get_bookmarks() - Retrieves the list of bookmarks + * Retrieves the list of bookmarks * * Attempts to retrieve from the cache first based on MD5 hash of arguments. If * that fails, then the query will be built from the arguments and executed. The * results will be stored to the cache. * * List of default arguments are as follows: - * 'orderby' - Default is 'name' (string). How to order the links by. String is based off of the bookmark scheme. - * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either ascending or descending order. - * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to display. - * 'category' - Default is empty string (string). Include the links in what category ID(s). - * 'category_name' - Default is empty string (string). Get links by category name. - * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide links marked as 'invisible'. - * 'show_updated' - Default is 0 (integer). Will show the time of when the bookmark was last updated. - * 'include' - Default is empty string (string). Include other categories separated by commas. - * 'exclude' - Default is empty string (string). Exclude other categories separated by commas. + * 'orderby' - Default is 'name' (string). How to order the links by. String is + * based off of the bookmark scheme. + * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either + * ascending or descending order. + * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to + * display. + * 'category' - Default is empty string (string). Include the links in what + * category ID(s). + * 'category_name' - Default is empty string (string). Get links by category + * name. + * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide + * links marked as 'invisible'. + * 'show_updated' - Default is 0 (integer). Will show the time of when the + * bookmark was last updated. + * 'include' - Default is empty string (string). Include other categories + * separated by commas. + * 'exclude' - Default is empty string (string). Exclude other categories + * separated by commas. * - * @since 2.1 + * @since 2.1.0 * @uses $wpdb Database Object + * @link http://codex.wordpress.org/Template_Tags/get_bookmarks * * @param string|array $args List of arguments to overwrite the defaults * @return array List of bookmark row objects @@ -117,10 +127,15 @@ function get_bookmarks($args = '') { $r = wp_parse_args( $args, $defaults ); extract( $r, EXTR_SKIP ); + $cache = array(); $key = md5( serialize( $r ) ); - if ( $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) - if ( isset( $cache[ $key ] ) ) + if ( $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) { + if ( is_array($cache) && isset( $cache[ $key ] ) ) return apply_filters('get_bookmarks', $cache[ $key ], $r ); + } + + if ( !is_array($cache) ) + $cache = array(); $inclusions = ''; if ( !empty($include) ) { @@ -155,9 +170,14 @@ function get_bookmarks($args = '') { if (!empty($exclusions)) $exclusions .= ')'; - if ( ! empty($category_name) ) { - if ( $category = get_term_by('name', $category_name, 'link_category') ) + if ( !empty($category_name) ) { + if ( $category = get_term_by('name', $category_name, 'link_category') ) { $category = $category->term_id; + } else { + $cache[ $key ] = array(); + wp_cache_set( 'get_bookmarks', $cache, 'bookmark' ); + return apply_filters( 'get_bookmarks', array(), $r ); + } } if ( ! empty($search) ) { @@ -183,7 +203,7 @@ function get_bookmarks($args = '') { $join = " INNER JOIN $wpdb->term_relationships AS tr ON ($wpdb->links.link_id = tr.object_id) INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_taxonomy_id = tr.term_taxonomy_id"; } - if (get_option('links_recently_updated_time')) { + if ( $show_updated && get_option('links_recently_updated_time') ) { $recently_updated_test = ", IF (DATE_ADD(link_updated, INTERVAL " . get_option('links_recently_updated_time') . " MINUTE) >= NOW(), 1,0) as recently_updated "; } else { $recently_updated_test = ''; @@ -201,7 +221,10 @@ function get_bookmarks($args = '') { $orderby = 'rand()'; break; default: - $orderby = "link_" . $orderby; + $orderparams = array(); + foreach ( explode(',', $orderby) as $ordparam ) + $orderparams[] = 'link_' . trim($ordparam); + $orderby = implode(',', $orderparams); } if ( 'link_id' == $orderby ) @@ -226,12 +249,13 @@ function get_bookmarks($args = '') { } /** - * sanitize_bookmark() - Sanitizes all bookmark fields + * Sanitizes all bookmark fields * - * @since 2.3 + * @since 2.3.0 * * @param object|array $bookmark Bookmark row - * @param string $context Optional, default is 'display'. How to filter the fields + * @param string $context Optional, default is 'display'. How to filter the + * fields * @return object|array Same type as $bookmark but with fields sanitized. */ function sanitize_bookmark($bookmark, $context = 'display') { @@ -239,55 +263,71 @@ function sanitize_bookmark($bookmark, $context = 'display') { 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated', 'link_rel', 'link_notes', 'link_rss', ); - $do_object = false; - if ( is_object($bookmark) ) + if ( is_object($bookmark) ) { $do_object = true; + $link_id = $bookmark->link_id; + } else { + $do_object = false; + $link_id = $bookmark['link_id']; + } foreach ( $fields as $field ) { - if ( $do_object ) - $bookmark->$field = sanitize_bookmark_field($field, $bookmark->$field, $bookmark->link_id, $context); - else - $bookmark[$field] = sanitize_bookmark_field($field, $bookmark[$field], $bookmark['link_id'], $context); + if ( $do_object ) { + if ( isset($bookmark->$field) ) + $bookmark->$field = sanitize_bookmark_field($field, $bookmark->$field, $link_id, $context); + } else { + if ( isset($bookmark[$field]) ) + $bookmark[$field] = sanitize_bookmark_field($field, $bookmark[$field], $link_id, $context); + } } return $bookmark; } /** - * sanitize_bookmark_field() - Sanitizes a bookmark field + * Sanitizes a bookmark field * - * Sanitizes the bookmark fields based on what the field name is. If the field has a - * strict value set, then it will be tested for that, else a more generic filtering is - * applied. After the more strict filter is applied, if the $context is 'raw' then the - * value is immediately return. + * Sanitizes the bookmark fields based on what the field name is. If the field + * has a strict value set, then it will be tested for that, else a more generic + * filtering is applied. After the more strict filter is applied, if the + * $context is 'raw' then the value is immediately return. * - * Hooks exist for the more generic cases. With the 'edit' context, the 'edit_$field' - * filter will be called and passed the $value and $bookmark_id respectively. With the - * 'db' context, the 'pre_$field' filter is called and passed the value. The 'display' - * context is the final context and has the $field has the filter name and is passed the - * $value, $bookmark_id, and $context respectively. + * Hooks exist for the more generic cases. With the 'edit' context, the + * 'edit_$field' filter will be called and passed the $value and $bookmark_id + * respectively. With the 'db' context, the 'pre_$field' filter is called and + * passed the value. The 'display' context is the final context and has the + * $field has the filter name and is passed the $value, $bookmark_id, and + * $context respectively. * - * @since 2.3 + * @since 2.3.0 * * @param string $field The bookmark field * @param mixed $value The bookmark field value * @param int $bookmark_id Bookmark ID - * @param string $context How to filter the field value. Either 'raw', 'edit', 'attribute', 'js', 'db', or 'display' + * @param string $context How to filter the field value. Either 'raw', 'edit', + * 'attribute', 'js', 'db', or 'display' * @return mixed The filtered value */ function sanitize_bookmark_field($field, $value, $bookmark_id, $context) { - $int_fields = array('link_id', 'link_rating'); - if ( in_array($field, $int_fields) ) + switch ( $field ) { + case 'link_id' : // ints + case 'link_rating' : $value = (int) $value; - - $yesno = array('link_visible'); - if ( in_array($field, $yesno) ) + break; + case 'link_category' : // array( ints ) + $value = array_map('absint', (array) $value); + // We return here so that the categories aren't filtered. + // The 'link_category' filter is for the name of a link category, not an array of a link's link categories + return $value; + break; + case 'link_visible' : // bool stored as Y|N $value = preg_replace('/[^YNyn]/', '', $value); - - if ( 'link_target' == $field ) { + break; + case 'link_target' : // "enum" $targets = array('_top', '_blank'); if ( ! in_array($value, $targets) ) $value = ''; + break; } if ( 'raw' == $context ) @@ -300,34 +340,32 @@ function sanitize_bookmark_field($field, $value, $bookmark_id, $context) { if ( in_array($field, $format_to_edit) ) { $value = format_to_edit($value); } else { - $value = attribute_escape($value); + $value = esc_attr($value); } } else if ( 'db' == $context ) { $value = apply_filters("pre_$field", $value); } else { // Use display filters by default. $value = apply_filters($field, $value, $bookmark_id, $context); - } - if ( 'attribute' == $context ) - $value = attribute_escape($value); - else if ( 'js' == $context ) - $value = js_escape($value); + if ( 'attribute' == $context ) + $value = esc_attr($value); + else if ( 'js' == $context ) + $value = esc_js($value); + } return $value; } /** - * delete_get_bookmark_cache() - Deletes entire bookmark cache + * Deletes bookmark cache * - * @since 2.1 + * @since 2.7.0 * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks' */ -function delete_get_bookmark_cache() { +function clean_bookmark_cache($bookmark_id) { + wp_cache_delete( $bookmark_id, 'bookmark' ); wp_cache_delete( 'get_bookmarks', 'bookmark' ); } -add_action( 'add_link', 'delete_get_bookmark_cache' ); -add_action( 'edit_link', 'delete_get_bookmark_cache' ); -add_action( 'delete_link', 'delete_get_bookmark_cache' ); ?>