wp-includes/bookmark.php

   1 <?php
   2 /**
   3  * Link/Bookmark API
   4  *
   5  * @package WordPress
   6  * @subpackage Bookmark
   7  */
   8
   9 /**
  10  * Retrieve Bookmark data
  11  *
  12  * @since 2.1.0
  13  * @uses $wpdb Database Object
  14  *
  15  * @param mixed $bookmark
  16  * @param string $output Optional. Either OBJECT, ARRAY_N, or ARRAY_A constant
  17  * @param string $filter Optional, default is 'raw'.
  18  * @return array|object Type returned depends on $output value.
  19  */
  20 function get_bookmark($bookmark, $output = OBJECT, $filter = 'raw') {
  21         global $wpdb;
  22
  23         if ( empty($bookmark) ) {
  24                 if ( isset($GLOBALS['link']) )
  25                         $_bookmark = & $GLOBALS['link'];
  26                 else
  27                         $_bookmark = null;
  28         } elseif ( is_object($bookmark) ) {
  29                 wp_cache_add($bookmark->link_id, $bookmark, 'bookmark');
  30                 $_bookmark = $bookmark;
  31         } else {
  32                 if ( isset($GLOBALS['link']) && ($GLOBALS['link']->link_id == $bookmark) ) {
  33                         $_bookmark = & $GLOBALS['link'];
  34                 } elseif ( ! $_bookmark = wp_cache_get($bookmark, 'bookmark') ) {
  35                         $_bookmark = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark));
  36                         $_bookmark->link_category = array_unique( wp_get_object_terms($_bookmark->link_id, 'link_category', array('fields' => 'ids')) );
  37                         wp_cache_add($_bookmark->link_id, $_bookmark, 'bookmark');
  38                 }
  39         }
  40
  41         $_bookmark = sanitize_bookmark($_bookmark, $filter);
  42
  43         if ( $output == OBJECT ) {
  44                 return $_bookmark;
  45         } elseif ( $output == ARRAY_A ) {
  46                 return get_object_vars($_bookmark);
  47         } elseif ( $output == ARRAY_N ) {
  48                 return array_values(get_object_vars($_bookmark));
  49         } else {
  50                 return $_bookmark;
  51         }
  52 }
  53
  54 /**
  55  * Retrieve single bookmark data item or field.
  56  *
  57  * @since 2.3.0
  58  * @uses get_bookmark() Gets bookmark object using $bookmark as ID
  59  * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.
  60  *
  61  * @param string $field The name of the data field to return
  62  * @param int $bookmark The bookmark ID to get field
  63  * @param string $context Optional. The context of how the field will be used.
  64  * @return string
  65  */
  66 function get_bookmark_field( $field, $bookmark, $context = 'display' ) {
  67         $bookmark = (int) $bookmark;
  68         $bookmark = get_bookmark( $bookmark );
  69
  70         if ( is_wp_error($bookmark) )
  71                 return $bookmark;
  72
  73         if ( !is_object($bookmark) )
  74                 return '';
  75
  76         if ( !isset($bookmark->$field) )
  77                 return '';
  78
  79         return sanitize_bookmark_field($field, $bookmark->$field, $bookmark->link_id, $context);
  80 }
  81
  82 /**
  83  * Retrieves the list of bookmarks
  84  *
  85  * Attempts to retrieve from the cache first based on MD5 hash of arguments. If
  86  * that fails, then the query will be built from the arguments and executed. The
  87  * results will be stored to the cache.
  88  *
  89  * List of default arguments are as follows:
  90  * 'orderby' - Default is 'name' (string). How to order the links by. String is
  91  *              based off of the bookmark scheme.
  92  * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
  93  *              ascending or descending order.
  94  * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
  95  *              display.
  96  * 'category' - Default is empty string (string). Include the links in what
  97  *              category ID(s).
  98  * 'category_name' - Default is empty string (string). Get links by category
  99  *              name.
 100  * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
 101  *              links marked as 'invisible'.
 102  * 'show_updated' - Default is 0 (integer). Will show the time of when the
 103  *              bookmark was last updated.
 104  * 'include' - Default is empty string (string). Include other categories
 105  *              separated by commas.
 106  * 'exclude' - Default is empty string (string). Exclude other categories
 107  *              separated by commas.
 108  *
 109  * @since 2.1.0
 110  * @uses $wpdb Database Object
 111  * @link http://codex.wordpress.org/Template_Tags/get_bookmarks
 112  *
 113  * @param string|array $args List of arguments to overwrite the defaults
 114  * @return array List of bookmark row objects
 115  */
 116 function get_bookmarks($args = '') {
 117         global $wpdb;
 118
 119         $defaults = array(
 120                 'orderby' => 'name', 'order' => 'ASC',
 121                 'limit' => -1, 'category' => '',
 122                 'category_name' => '', 'hide_invisible' => 1,
 123                 'show_updated' => 0, 'include' => '',
 124                 'exclude' => '', 'search' => ''
 125         );
 126
 127         $r = wp_parse_args( $args, $defaults );
 128         extract( $r, EXTR_SKIP );
 129
 130         $cache = array();
 131         $key = md5( serialize( $r ) );
 132         if ( $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) {
 133                 if ( is_array($cache) && isset( $cache[ $key ] ) )
 134                         return apply_filters('get_bookmarks', $cache[ $key ], $r );
 135         }
 136
 137         if ( !is_array($cache) )
 138                 $cache = array();
 139
 140         $inclusions = '';
 141         if ( !empty($include) ) {
 142                 $exclude = '';  //ignore exclude, category, and category_name params if using include
 143                 $category = '';
 144                 $category_name = '';
 145                 $inclinks = preg_split('/[\s,]+/',$include);
 146                 if ( count($inclinks) ) {
 147                         foreach ( $inclinks as $inclink ) {
 148                                 if (empty($inclusions))
 149                                         $inclusions = ' AND ( link_id = ' . intval($inclink) . ' ';
 150                                 else
 151                                         $inclusions .= ' OR link_id = ' . intval($inclink) . ' ';
 152                         }
 153                 }
 154         }
 155         if (!empty($inclusions))
 156                 $inclusions .= ')';
 157
 158         $exclusions = '';
 159         if ( !empty($exclude) ) {
 160                 $exlinks = preg_split('/[\s,]+/',$exclude);
 161                 if ( count($exlinks) ) {
 162                         foreach ( $exlinks as $exlink ) {
 163                                 if (empty($exclusions))
 164                                         $exclusions = ' AND ( link_id <> ' . intval($exlink) . ' ';
 165                                 else
 166                                         $exclusions .= ' AND link_id <> ' . intval($exlink) . ' ';
 167                         }
 168                 }
 169         }
 170         if (!empty($exclusions))
 171                 $exclusions .= ')';
 172
 173         if ( !empty($category_name) ) {
 174                 if ( $category = get_term_by('name', $category_name, 'link_category') ) {
 175                         $category = $category->term_id;
 176                 } else {
 177                         $cache[ $key ] = array();
 178                         wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
 179                         return apply_filters( 'get_bookmarks', array(), $r );
 180                 }
 181         }
 182
 183         if ( ! empty($search) ) {
 184                 $search = like_escape($search);
 185                 $search = " AND ( (link_url LIKE '%$search%') OR (link_name LIKE '%$search%') OR (link_description LIKE '%$search%') ) ";
 186         }
 187
 188         $category_query = '';
 189         $join = '';
 190         if ( !empty($category) ) {
 191                 $incategories = preg_split('/[\s,]+/',$category);
 192                 if ( count($incategories) ) {
 193                         foreach ( $incategories as $incat ) {
 194                                 if (empty($category_query))
 195                                         $category_query = ' AND ( tt.term_id = ' . intval($incat) . ' ';
 196                                 else
 197                                         $category_query .= ' OR tt.term_id = ' . intval($incat) . ' ';
 198                         }
 199                 }
 200         }
 201         if (!empty($category_query)) {
 202                 $category_query .= ") AND taxonomy = 'link_category'";
 203                 $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";
 204         }
 205
 206         if ( $show_updated && get_option('links_recently_updated_time') ) {
 207                 $recently_updated_test = ", IF (DATE_ADD(link_updated, INTERVAL " . get_option('links_recently_updated_time') . " MINUTE) >= NOW(), 1,0) as recently_updated ";
 208         } else {
 209                 $recently_updated_test = '';
 210         }
 211
 212         $get_updated = ( $show_updated ) ? ', UNIX_TIMESTAMP(link_updated) AS link_updated_f ' : '';
 213
 214         $orderby = strtolower($orderby);
 215         $length = '';
 216         switch ($orderby) {
 217                 case 'length':
 218                         $length = ", CHAR_LENGTH(link_name) AS length";
 219                         break;
 220                 case 'rand':
 221                         $orderby = 'rand()';
 222                         break;
 223                 default:
 224                         $orderparams = array();
 225                         foreach ( explode(',', $orderby) as $ordparam )
 226                                 $orderparams[] = 'link_' . trim($ordparam);
 227                         $orderby = implode(',', $orderparams);
 228         }
 229
 230         if ( 'link_id' == $orderby )
 231                 $orderby = "$wpdb->links.link_id";
 232
 233         $visible = '';
 234         if ( $hide_invisible )
 235                 $visible = "AND link_visible = 'Y'";
 236
 237         $query = "SELECT * $length $recently_updated_test $get_updated FROM $wpdb->links $join WHERE 1=1 $visible $category_query";
 238         $query .= " $exclusions $inclusions $search";
 239         $query .= " ORDER BY $orderby $order";
 240         if ($limit != -1)
 241                 $query .= " LIMIT $limit";
 242
 243         $results = $wpdb->get_results($query);
 244
 245         $cache[ $key ] = $results;
 246         wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
 247
 248         return apply_filters('get_bookmarks', $results, $r);
 249 }
 250
 251 /**
 252  * Sanitizes all bookmark fields
 253  *
 254  * @since 2.3.0
 255  *
 256  * @param object|array $bookmark Bookmark row
 257  * @param string $context Optional, default is 'display'. How to filter the
 258  *              fields
 259  * @return object|array Same type as $bookmark but with fields sanitized.
 260  */
 261 function sanitize_bookmark($bookmark, $context = 'display') {
 262         $fields = array('link_id', 'link_url', 'link_name', 'link_image', 'link_target', 'link_category',
 263                 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated',
 264                 'link_rel', 'link_notes', 'link_rss', );
 265
 266         if ( is_object($bookmark) ) {
 267                 $do_object = true;
 268                 $link_id = $bookmark->link_id;
 269         } else {
 270                 $do_object = false;
 271                 $link_id = $bookmark['link_id'];
 272         }
 273
 274         foreach ( $fields as $field ) {
 275                 if ( $do_object ) {
 276                         if ( isset($bookmark->$field) )
 277                                 $bookmark->$field = sanitize_bookmark_field($field, $bookmark->$field, $link_id, $context);
 278                 } else {
 279                         if ( isset($bookmark[$field]) )
 280                                 $bookmark[$field] = sanitize_bookmark_field($field, $bookmark[$field], $link_id, $context);
 281                 }
 282         }
 283
 284         return $bookmark;
 285 }
 286
 287 /**
 288  * Sanitizes a bookmark field
 289  *
 290  * Sanitizes the bookmark fields based on what the field name is. If the field
 291  * has a strict value set, then it will be tested for that, else a more generic
 292  * filtering is applied. After the more strict filter is applied, if the
 293  * $context is 'raw' then the value is immediately return.
 294  *
 295  * Hooks exist for the more generic cases. With the 'edit' context, the
 296  * 'edit_$field' filter will be called and passed the $value and $bookmark_id
 297  * respectively. With the 'db' context, the 'pre_$field' filter is called and
 298  * passed the value. The 'display' context is the final context and has the
 299  * $field has the filter name and is passed the $value, $bookmark_id, and
 300  * $context respectively.
 301  *
 302  * @since 2.3.0
 303  *
 304  * @param string $field The bookmark field
 305  * @param mixed $value The bookmark field value
 306  * @param int $bookmark_id Bookmark ID
 307  * @param string $context How to filter the field value. Either 'raw', 'edit',
 308  *              'attribute', 'js', 'db', or 'display'
 309  * @return mixed The filtered value
 310  */
 311 function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
 312         switch ( $field ) {
 313         case 'link_id' : // ints
 314         case 'link_rating' :
 315                 $value = (int) $value;
 316                 break;
 317         case 'link_category' : // array( ints )
 318                 $value = array_map('absint', (array) $value);
 319                 // We return here so that the categories aren't filtered.
 320                 // The 'link_category' filter is for the name of a link category, not an array of a link's link categories
 321                 return $value;
 322                 break;
 323         case 'link_visible' : // bool stored as Y|N
 324                 $value = preg_replace('/[^YNyn]/', '', $value);
 325                 break;
 326         case 'link_target' : // "enum"
 327                 $targets = array('_top', '_blank');
 328                 if ( ! in_array($value, $targets) )
 329                         $value = '';
 330                 break;
 331         }
 332
 333         if ( 'raw' == $context )
 334                 return $value;
 335
 336         if ( 'edit' == $context ) {
 337                 $value = apply_filters("edit_$field", $value, $bookmark_id);
 338
 339                 if ( 'link_notes' == $field ) {
 340                         $value = esc_html( $value ); // textarea_escaped
 341                 } else {
 342                         $value = esc_attr($value);
 343                 }
 344         } else if ( 'db' == $context ) {
 345                 $value = apply_filters("pre_$field", $value);
 346         } else {
 347                 // Use display filters by default.
 348                 $value = apply_filters($field, $value, $bookmark_id, $context);
 349
 350                 if ( 'attribute' == $context )
 351                         $value = esc_attr($value);
 352                 else if ( 'js' == $context )
 353                         $value = esc_js($value);
 354         }
 355
 356         return $value;
 357 }
 358
 359 /**
 360  * Deletes bookmark cache
 361  *
 362  * @since 2.7.0
 363  * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
 364  */
 365 function clean_bookmark_cache($bookmark_id) {
 366         wp_cache_delete( $bookmark_id, 'bookmark' );
 367         wp_cache_delete( 'get_bookmarks', 'bookmark' );
 368 }
 369
 370 ?>