Wordpress 2.7.1
[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 based on ID
11  *
12  * @since 2.1.0
13  * @uses $wpdb Database Object
14  *
15  * @param int $bookmark_id
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', '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  * Retrieve bookmark data based on ID.
84  *
85  * @since 2.0.0
86  * @deprecated Use get_bookmark()
87  * @see get_bookmark()
88  *
89  * @param int $bookmark_id ID of link
90  * @param string $output Either OBJECT, ARRAY_N, or ARRAY_A
91  * @return object|array
92  */
93 function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
94         return get_bookmark($bookmark_id, $output, $filter);
95 }
96
97 /**
98  * Retrieves the list of bookmarks
99  *
100  * Attempts to retrieve from the cache first based on MD5 hash of arguments. If
101  * that fails, then the query will be built from the arguments and executed. The
102  * results will be stored to the cache.
103  *
104  * List of default arguments are as follows:
105  * 'orderby' - Default is 'name' (string). How to order the links by. String is
106  *              based off of the bookmark scheme.
107  * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
108  *              ascending or descending order.
109  * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
110  *              display.
111  * 'category' - Default is empty string (string). Include the links in what
112  *              category ID(s).
113  * 'category_name' - Default is empty string (string). Get links by category
114  *              name.
115  * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
116  *              links marked as 'invisible'.
117  * 'show_updated' - Default is 0 (integer). Will show the time of when the
118  *              bookmark was last updated.
119  * 'include' - Default is empty string (string). Include other categories
120  *              separated by commas.
121  * 'exclude' - Default is empty string (string). Exclude other categories
122  *              separated by commas.
123  *
124  * @since 2.1.0
125  * @uses $wpdb Database Object
126  * @link http://codex.wordpress.org/Template_Tags/get_bookmarks
127  *
128  * @param string|array $args List of arguments to overwrite the defaults
129  * @return array List of bookmark row objects
130  */
131 function get_bookmarks($args = '') {
132         global $wpdb;
133
134         $defaults = array(
135                 'orderby' => 'name', 'order' => 'ASC',
136                 'limit' => -1, 'category' => '',
137                 'category_name' => '', 'hide_invisible' => 1,
138                 'show_updated' => 0, 'include' => '',
139                 'exclude' => '', 'search' => ''
140         );
141
142         $r = wp_parse_args( $args, $defaults );
143         extract( $r, EXTR_SKIP );
144
145         $key = md5( serialize( $r ) );
146         if ( $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) )
147                 if ( isset( $cache[ $key ] ) )
148                         return apply_filters('get_bookmarks', $cache[ $key ], $r );
149
150         $inclusions = '';
151         if ( !empty($include) ) {
152                 $exclude = '';  //ignore exclude, category, and category_name params if using include
153                 $category = '';
154                 $category_name = '';
155                 $inclinks = preg_split('/[\s,]+/',$include);
156                 if ( count($inclinks) ) {
157                         foreach ( $inclinks as $inclink ) {
158                                 if (empty($inclusions))
159                                         $inclusions = ' AND ( link_id = ' . intval($inclink) . ' ';
160                                 else
161                                         $inclusions .= ' OR link_id = ' . intval($inclink) . ' ';
162                         }
163                 }
164         }
165         if (!empty($inclusions))
166                 $inclusions .= ')';
167
168         $exclusions = '';
169         if ( !empty($exclude) ) {
170                 $exlinks = preg_split('/[\s,]+/',$exclude);
171                 if ( count($exlinks) ) {
172                         foreach ( $exlinks as $exlink ) {
173                                 if (empty($exclusions))
174                                         $exclusions = ' AND ( link_id <> ' . intval($exlink) . ' ';
175                                 else
176                                         $exclusions .= ' AND link_id <> ' . intval($exlink) . ' ';
177                         }
178                 }
179         }
180         if (!empty($exclusions))
181                 $exclusions .= ')';
182
183         if ( ! empty($category_name) ) {
184                 if ( $category = get_term_by('name', $category_name, 'link_category') )
185                         $category = $category->term_id;
186         }
187
188         if ( ! empty($search) ) {
189                 $search = 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 (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                 default:
229                         $orderby = "link_" . $orderby;
230         }
231
232         if ( 'link_id' == $orderby )
233                 $orderby = "$wpdb->links.link_id";
234
235         $visible = '';
236         if ( $hide_invisible )
237                 $visible = "AND link_visible = 'Y'";
238
239         $query = "SELECT * $length $recently_updated_test $get_updated FROM $wpdb->links $join WHERE 1=1 $visible $category_query";
240         $query .= " $exclusions $inclusions $search";
241         $query .= " ORDER BY $orderby $order";
242         if ($limit != -1)
243                 $query .= " LIMIT $limit";
244
245         $results = $wpdb->get_results($query);
246
247         $cache[ $key ] = $results;
248         wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
249
250         return apply_filters('get_bookmarks', $results, $r);
251 }
252
253 /**
254  * Sanitizes all bookmark fields
255  *
256  * @since 2.3.0
257  *
258  * @param object|array $bookmark Bookmark row
259  * @param string $context Optional, default is 'display'. How to filter the
260  *              fields
261  * @return object|array Same type as $bookmark but with fields sanitized.
262  */
263 function sanitize_bookmark($bookmark, $context = 'display') {
264         $fields = array('link_id', 'link_url', 'link_name', 'link_image', 'link_target', 'link_category',
265                 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated',
266                 'link_rel', 'link_notes', 'link_rss', );
267
268         if ( is_object($bookmark) ) {
269                 $do_object = true;
270                 $link_id = $bookmark->link_id;
271         } else {
272                 $do_object = false;
273                 $link_id = $bookmark['link_id'];
274         }
275
276         foreach ( $fields as $field ) {
277                 if ( $do_object ) {
278                         if ( isset($bookmark->$field) )
279                                 $bookmark->$field = sanitize_bookmark_field($field, $bookmark->$field, $link_id, $context);
280                 } else {
281                         if ( isset($bookmark[$field]) )
282                                 $bookmark[$field] = sanitize_bookmark_field($field, $bookmark[$field], $link_id, $context);
283                 }
284         }
285
286         return $bookmark;
287 }
288
289 /**
290  * Sanitizes a bookmark field
291  *
292  * Sanitizes the bookmark fields based on what the field name is. If the field
293  * has a strict value set, then it will be tested for that, else a more generic
294  * filtering is applied. After the more strict filter is applied, if the
295  * $context is 'raw' then the value is immediately return.
296  *
297  * Hooks exist for the more generic cases. With the 'edit' context, the
298  * 'edit_$field' filter will be called and passed the $value and $bookmark_id
299  * respectively. With the 'db' context, the 'pre_$field' filter is called and
300  * passed the value. The 'display' context is the final context and has the
301  * $field has the filter name and is passed the $value, $bookmark_id, and
302  * $context respectively.
303  *
304  * @since 2.3.0
305  *
306  * @param string $field The bookmark field
307  * @param mixed $value The bookmark field value
308  * @param int $bookmark_id Bookmark ID
309  * @param string $context How to filter the field value. Either 'raw', 'edit',
310  *              'attribute', 'js', 'db', or 'display'
311  * @return mixed The filtered value
312  */
313 function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
314         $int_fields = array('link_id', 'link_rating');
315         if ( in_array($field, $int_fields) )
316                 $value = (int) $value;
317
318         $yesno = array('link_visible');
319         if ( in_array($field, $yesno) )
320                 $value = preg_replace('/[^YNyn]/', '', $value);
321
322         if ( 'link_target' == $field ) {
323                 $targets = array('_top', '_blank');
324                 if ( ! in_array($value, $targets) )
325                         $value = '';
326         }
327
328         if ( 'raw' == $context )
329                 return $value;
330
331         if ( 'edit' == $context ) {
332                 $format_to_edit = array('link_notes');
333                 $value = apply_filters("edit_$field", $value, $bookmark_id);
334
335                 if ( in_array($field, $format_to_edit) ) {
336                         $value = format_to_edit($value);
337                 } else {
338                         $value = attribute_escape($value);
339                 }
340         } else if ( 'db' == $context ) {
341                 $value = apply_filters("pre_$field", $value);
342         } else {
343                 // Use display filters by default.
344                 $value = apply_filters($field, $value, $bookmark_id, $context);
345         }
346
347         if ( 'attribute' == $context )
348                 $value = attribute_escape($value);
349         else if ( 'js' == $context )
350                 $value = js_escape($value);
351
352         return $value;
353 }
354
355 /**
356  * Deletes bookmark cache
357  *
358  * @since 2.7.0
359  * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
360  */
361 function clean_bookmark_cache($bookmark_id) {
362         wp_cache_delete( $bookmark_id, 'bookmark' );
363         wp_cache_delete( 'get_bookmarks', 'bookmark' );
364 }
365
366 ?>