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