wp-admin/includes/bookmark.php

   1 <?php
   2 /**
   3  * WordPress Bookmark Administration API
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /**
  10  * Add a link to using values provided in $_POST.
  11  *
  12  * @since 2.0.0
  13  *
  14  * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
  15  */
  16 function add_link() {
  17         return edit_link();
  18 }
  19
  20 /**
  21  * Update or insert a link using values provided in $_POST.
  22  *
  23  * @since 2.0.0
  24  *
  25  * @param int $link_id Optional. ID of the link to edit.
  26  * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
  27  */
  28 function edit_link( $link_id = 0 ) {
  29         if ( !current_user_can( 'manage_links' ) )
  30                 wp_die( __( 'Cheatin&#8217; uh?' ), 403 );
  31
  32         $_POST['link_url'] = esc_html( $_POST['link_url'] );
  33         $_POST['link_url'] = esc_url($_POST['link_url']);
  34         $_POST['link_name'] = esc_html( $_POST['link_name'] );
  35         $_POST['link_image'] = esc_html( $_POST['link_image'] );
  36         $_POST['link_rss'] = esc_url($_POST['link_rss']);
  37         if ( !isset($_POST['link_visible']) || 'N' != $_POST['link_visible'] )
  38                 $_POST['link_visible'] = 'Y';
  39
  40         if ( !empty( $link_id ) ) {
  41                 $_POST['link_id'] = $link_id;
  42                 return wp_update_link( $_POST );
  43         } else {
  44                 return wp_insert_link( $_POST );
  45         }
  46 }
  47
  48 /**
  49  * Retrieve the default link for editing.
  50  *
  51  * @since 2.0.0
  52  *
  53  * @return stdClass Default link
  54  */
  55 function get_default_link_to_edit() {
  56         $link = new stdClass;
  57         if ( isset( $_GET['linkurl'] ) )
  58                 $link->link_url = esc_url( wp_unslash( $_GET['linkurl'] ) );
  59         else
  60                 $link->link_url = '';
  61
  62         if ( isset( $_GET['name'] ) )
  63                 $link->link_name = esc_attr( wp_unslash( $_GET['name'] ) );
  64         else
  65                 $link->link_name = '';
  66
  67         $link->link_visible = 'Y';
  68
  69         return $link;
  70 }
  71
  72 /**
  73  * Delete link specified from database.
  74  *
  75  * @since 2.0.0
  76  *
  77  * @global wpdb $wpdb
  78  *
  79  * @param int $link_id ID of the link to delete
  80  * @return true
  81  */
  82 function wp_delete_link( $link_id ) {
  83         global $wpdb;
  84         /**
  85          * Fires before a link is deleted.
  86          *
  87          * @since 2.0.0
  88          *
  89          * @param int $link_id ID of the link to delete.
  90          */
  91         do_action( 'delete_link', $link_id );
  92
  93         wp_delete_object_term_relationships( $link_id, 'link_category' );
  94
  95         $wpdb->delete( $wpdb->links, array( 'link_id' => $link_id ) );
  96         /**
  97          * Fires after a link has been deleted.
  98          *
  99          * @since 2.2.0
 100          *
 101          * @param int $link_id ID of the deleted link.
 102          */
 103         do_action( 'deleted_link', $link_id );
 104
 105         clean_bookmark_cache( $link_id );
 106
 107         return true;
 108 }
 109
 110 /**
 111  * Retrieves the link categories associated with the link specified.
 112  *
 113  * @since 2.1.0
 114  *
 115  * @param int $link_id Link ID to look up
 116  * @return array The requested link's categories
 117  */
 118 function wp_get_link_cats( $link_id = 0 ) {
 119         $cats = wp_get_object_terms( $link_id, 'link_category', array('fields' => 'ids') );
 120         return array_unique( $cats );
 121 }
 122
 123 /**
 124  * Retrieve link data based on ID.
 125  *
 126  * @since 2.0.0
 127  *
 128  * @param int $link_id ID of link to retrieve
 129  * @return object Link for editing
 130  */
 131 function get_link_to_edit( $link_id ) {
 132         return get_bookmark( $link_id, OBJECT, 'edit' );
 133 }
 134
 135 /**
 136  * This function inserts/updates links into/in the database.
 137  *
 138  * @since 2.0.0
 139  *
 140  * @global wpdb $wpdb
 141  *
 142  * @param array $linkdata Elements that make up the link to insert.
 143  * @param bool  $wp_error Optional. If true return WP_Error object on failure.
 144  * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
 145  */
 146 function wp_insert_link( $linkdata, $wp_error = false ) {
 147         global $wpdb;
 148
 149         $defaults = array( 'link_id' => 0, 'link_name' => '', 'link_url' => '', 'link_rating' => 0 );
 150
 151         $args = wp_parse_args( $linkdata, $defaults );
 152         $r = wp_unslash( sanitize_bookmark( $args, 'db' ) );
 153
 154         $link_id   = $r['link_id'];
 155         $link_name = $r['link_name'];
 156         $link_url  = $r['link_url'];
 157
 158         $update = false;
 159         if ( ! empty( $link_id ) ) {
 160                 $update = true;
 161         }
 162
 163         if ( trim( $link_name ) == '' ) {
 164                 if ( trim( $link_url ) != '' ) {
 165                         $link_name = $link_url;
 166                 } else {
 167                         return 0;
 168                 }
 169         }
 170
 171         if ( trim( $link_url ) == '' ) {
 172                 return 0;
 173         }
 174
 175         $link_rating      = ( ! empty( $r['link_rating'] ) ) ? $r['link_rating'] : 0;
 176         $link_image       = ( ! empty( $r['link_image'] ) ) ? $r['link_image'] : '';
 177         $link_target      = ( ! empty( $r['link_target'] ) ) ? $r['link_target'] : '';
 178         $link_visible     = ( ! empty( $r['link_visible'] ) ) ? $r['link_visible'] : 'Y';
 179         $link_owner       = ( ! empty( $r['link_owner'] ) ) ? $r['link_owner'] : get_current_user_id();
 180         $link_notes       = ( ! empty( $r['link_notes'] ) ) ? $r['link_notes'] : '';
 181         $link_description = ( ! empty( $r['link_description'] ) ) ? $r['link_description'] : '';
 182         $link_rss         = ( ! empty( $r['link_rss'] ) ) ? $r['link_rss'] : '';
 183         $link_rel         = ( ! empty( $r['link_rel'] ) ) ? $r['link_rel'] : '';
 184         $link_category    = ( ! empty( $r['link_category'] ) ) ? $r['link_category'] : array();
 185
 186         // Make sure we set a valid category
 187         if ( ! is_array( $link_category ) || 0 == count( $link_category ) ) {
 188                 $link_category = array( get_option( 'default_link_category' ) );
 189         }
 190
 191         if ( $update ) {
 192                 if ( false === $wpdb->update( $wpdb->links, compact( 'link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_rating', 'link_rel', 'link_notes', 'link_rss' ), compact( 'link_id' ) ) ) {
 193                         if ( $wp_error ) {
 194                                 return new WP_Error( 'db_update_error', __( 'Could not update link in the database' ), $wpdb->last_error );
 195                         } else {
 196                                 return 0;
 197                         }
 198                 }
 199         } else {
 200                 if ( false === $wpdb->insert( $wpdb->links, compact( 'link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_rel', 'link_notes', 'link_rss' ) ) ) {
 201                         if ( $wp_error ) {
 202                                 return new WP_Error( 'db_insert_error', __( 'Could not insert link into the database' ), $wpdb->last_error );
 203                         } else {
 204                                 return 0;
 205                         }
 206                 }
 207                 $link_id = (int) $wpdb->insert_id;
 208         }
 209
 210         wp_set_link_cats( $link_id, $link_category );
 211
 212         if ( $update ) {
 213                 /**
 214                  * Fires after a link was updated in the database.
 215                  *
 216                  * @since 2.0.0
 217                  *
 218                  * @param int $link_id ID of the link that was updated.
 219                  */
 220                 do_action( 'edit_link', $link_id );
 221         } else {
 222                 /**
 223                  * Fires after a link was added to the database.
 224                  *
 225                  * @since 2.0.0
 226                  *
 227                  * @param int $link_id ID of the link that was added.
 228                  */
 229                 do_action( 'add_link', $link_id );
 230         }
 231         clean_bookmark_cache( $link_id );
 232
 233         return $link_id;
 234 }
 235
 236 /**
 237  * Update link with the specified link categories.
 238  *
 239  * @since 2.1.0
 240  *
 241  * @param int $link_id ID of link to update
 242  * @param array $link_categories Array of categories to
 243  */
 244 function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
 245         // If $link_categories isn't already an array, make it one:
 246         if ( !is_array( $link_categories ) || 0 == count( $link_categories ) )
 247                 $link_categories = array( get_option( 'default_link_category' ) );
 248
 249         $link_categories = array_map( 'intval', $link_categories );
 250         $link_categories = array_unique( $link_categories );
 251
 252         wp_set_object_terms( $link_id, $link_categories, 'link_category' );
 253
 254         clean_bookmark_cache( $link_id );
 255 }
 256
 257 /**
 258  * Update a link in the database.
 259  *
 260  * @since 2.0.0
 261  *
 262  * @param array $linkdata Link data to update.
 263  * @return int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
 264  */
 265 function wp_update_link( $linkdata ) {
 266         $link_id = (int) $linkdata['link_id'];
 267
 268         $link = get_bookmark( $link_id, ARRAY_A );
 269
 270         // Escape data pulled from DB.
 271         $link = wp_slash( $link );
 272
 273         // Passed link category list overwrites existing category list if not empty.
 274         if ( isset( $linkdata['link_category'] ) && is_array( $linkdata['link_category'] )
 275                          && 0 != count( $linkdata['link_category'] ) )
 276                 $link_cats = $linkdata['link_category'];
 277         else
 278                 $link_cats = $link['link_category'];
 279
 280         // Merge old and new fields with new fields overwriting old ones.
 281         $linkdata = array_merge( $link, $linkdata );
 282         $linkdata['link_category'] = $link_cats;
 283
 284         return wp_insert_link( $linkdata );
 285 }
 286
 287 /**
 288  * @since 3.5.0
 289  * @access private
 290  *
 291  * @global string $pagenow
 292  */
 293 function wp_link_manager_disabled_message() {
 294         global $pagenow;
 295         if ( 'link-manager.php' != $pagenow && 'link-add.php' != $pagenow && 'link.php' != $pagenow )
 296                 return;
 297
 298         add_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
 299         $really_can_manage_links = current_user_can( 'manage_links' );
 300         remove_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
 301
 302         if ( $really_can_manage_links && current_user_can( 'install_plugins' ) ) {
 303                 $link = network_admin_url( 'plugin-install.php?tab=search&amp;s=Link+Manager' );
 304                 wp_die( sprintf( __( 'If you are looking to use the link manager, please install the <a href="%s">Link Manager</a> plugin.' ), $link ) );
 305         }
 306
 307         wp_die( __( 'You do not have sufficient permissions to edit the links for this site.' ) );
 308 }