WordPress.org

Make WordPress Core

Changeset 40790


Ignore:
Timestamp:
05/19/17 05:48:01 (2 months ago)
Author:
azaozz
Message:

Dashboard: Improve the handling of locations determined by geolocating the IP address and by entering a city name. Fix couple of edge cases, and some names.

Props iandunn coreymckrill.
Fixes #40702.

Location:
trunk/src
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/ajax-actions.php

    r40651 r40790  
    313313    $events_client  = new WP_Community_Events( $user_id, $saved_location ); 
    314314    $events         = $events_client->get_events( $search, $timezone ); 
     315    $ip_changed     = false; 
    315316 
    316317    if ( is_wp_error( $events ) ) { 
     
    319320        ) ); 
    320321    } else { 
    321         if ( isset( $events['location'] ) ) { 
    322             // Store the location network-wide, so the user doesn't have to set it on each site. 
     322        if ( empty( $saved_location['ip'] ) && ! empty( $events['location']['ip'] ) ) { 
     323            $ip_changed = true; 
     324        } elseif ( isset( $saved_location['ip'] ) && ! empty( $events['location']['ip'] ) && $saved_location['ip'] !== $events['location']['ip'] ) { 
     325            $ip_changed = true; 
     326        } 
     327 
     328        /* 
     329         * The location should only be updated when it changes. The API doesn't always return 
     330         * a full location; sometimes it's missing the description or country. The location 
     331         * that was saved during the initial request is known to be good and complete, though. 
     332         * It should be left in tact until the user explicitly changes it (either by manually 
     333         * searching for a new location, or by changing their IP address). 
     334         * 
     335         * If the location were updated with an incomplete response from the API, then it could 
     336         * break assumptions that the UI makes (e.g., that there will always be a description 
     337         * that corresponds to a latitude/longitude location). 
     338         * 
     339         * The location is stored network-wide, so that the user doesn't have to set it on each site. 
     340         */ 
     341        if ( $ip_changed || $search ) { 
    323342            update_user_option( $user_id, 'community-events-location', $events['location'], true ); 
    324343        } 
  • trunk/src/wp-admin/includes/class-wp-community-events.php

    r40781 r40790  
    9595        } 
    9696 
    97         $request_url    = $this->get_request_url( $location_search, $timezone ); 
    98         $response       = wp_remote_get( $request_url ); 
     97        $api_url        = 'https://api.wordpress.org/events/1.0/'; 
     98        $request_args   = $this->get_request_args( $location_search, $timezone ); 
     99        $response       = wp_remote_get( $api_url, $request_args ); 
    99100        $response_code  = wp_remote_retrieve_response_code( $response ); 
    100101        $response_body  = json_decode( wp_remote_retrieve_body( $response ), true ); 
    101102        $response_error = null; 
    102         $debugging_info = compact( 'request_url', 'response_code', 'response_body' ); 
     103        $debugging_info = compact( 'api_url', 'request_args', 'response_code', 'response_body' ); 
    103104 
    104105        if ( is_wp_error( $response ) ) { 
     
    129130            } 
    130131 
     132            /* 
     133             * The IP in the response is usually the same as the one that was sent 
     134             * in the request, but in some cases it is different. In those cases, 
     135             * it's important to reset it back to the IP from the request. 
     136             * 
     137             * For example, if the IP sent in the request is private (e.g., 192.168.1.100), 
     138             * then the API will ignore that and use the corresponding public IP instead, 
     139             * and the public IP will get returned. If the public IP were saved, though, 
     140             * then get_cached_events() would always return `false`, because the transient 
     141             * would be generated based on the public IP when saving the cache, but generated 
     142             * based on the private IP when retrieving the cache. 
     143             */ 
     144            if ( ! empty( $response_body['location']['ip'] ) ) { 
     145                $response_body['location']['ip'] = $request_args['body']['ip']; 
     146            } 
     147 
     148            /* 
     149             * The API doesn't return a description for latitude/longitude requests, 
     150             * but the description is already saved in the user location, so that 
     151             * one can be used instead. 
     152             */ 
     153            if ( $this->coordinates_match( $request_args['body'], $response_body['location'] ) && empty( $response_body['location']['description'] ) ) { 
     154                $response_body['location']['description'] = $this->user_location['description']; 
     155            } 
     156 
    131157            $this->cache_events( $response_body, $expiration ); 
    132158 
     
    144170 
    145171    /** 
    146      * Builds a URL for requests to the w.org Events API. 
     172     * Builds an array of args to use in an HTTP request to the w.org Events API. 
    147173     * 
    148174     * @access protected 
     
    151177     * @param  string $search   Optional. City search string. Default empty string. 
    152178     * @param  string $timezone Optional. Timezone string. Default empty string. 
    153      * @return string The request URL. 
    154      */ 
    155     protected function get_request_url( $search = '', $timezone = '' ) { 
    156         $api_url = 'https://api.wordpress.org/events/1.0/'; 
    157         $args    = array( 
     179     * @return @return array The request args. 
     180     */ 
     181    protected function get_request_args( $search = '', $timezone = '' ) { 
     182        $args = array( 
    158183            'number' => 5, // Get more than three in case some get trimmed out. 
    159             'ip'     => $this->get_client_ip(), 
     184            'ip'     => self::get_unsafe_client_ip(), 
    160185        ); 
    161186 
    162187        /* 
    163          * Send the minimal set of necessary arguments, in order to increase the 
     188         * Include the minimal set of necessary arguments, in order to increase the 
    164189         * chances of a cache-hit on the API side. 
    165190         */ 
     
    179204        } 
    180205 
    181         return add_query_arg( $args, $api_url ); 
     206        // Wrap the args in an array compatible with the second parameter of `wp_remote_get()`. 
     207        return array( 
     208            'body' => $args 
     209        ); 
    182210    } 
    183211 
     
    208236     *                      or false on failure. 
    209237     */ 
    210     protected function get_client_ip() { 
     238    public static function get_unsafe_client_ip() { 
    211239        $client_ip = false; 
    212240 
     
    251279 
    252280    /** 
     281     * Test if two pairs of latitude/longitude coordinates match each other. 
     282     * 
     283     * @since 4.8.0 
     284     * @access protected 
     285     * 
     286     * @param array $a The first pair, with indexes 'latitude' and 'longitude'. 
     287     * @param array $b The second pair, with indexes 'latitude' and 'longitude'. 
     288     * @return bool True if they match, false if they don't. 
     289     */ 
     290    protected function coordinates_match( $a, $b ) { 
     291        if ( ! isset( $a['latitude'], $a['longitude'], $b['latitude'], $b['longitude'] ) ) { 
     292            return false; 
     293        } 
     294 
     295        return $a['latitude'] === $b['latitude'] && $a['longitude'] === $b['longitude']; 
     296    } 
     297 
     298    /** 
    253299     * Generates a transient key based on user location. 
    254300     * 
     
    267313        $key = false; 
    268314 
    269         if ( isset( $location['latitude'], $location['longitude'] ) ) { 
     315        if ( isset( $location['ip'] ) ) { 
     316            $key = 'community-events-' . md5( $location['ip'] ); 
     317        } else if ( isset( $location['latitude'], $location['longitude'] ) ) { 
    270318            $key = 'community-events-' . md5( $location['latitude'] . $location['longitude'] ); 
    271319        } 
  • trunk/src/wp-admin/includes/dashboard.php

    r40789 r40790  
    12351235    <script id="tmpl-community-events-no-upcoming-events" type="text/template"> 
    12361236        <li class="event-none"> 
    1237             <?php printf( 
    1238                 /* translators: 1: the city the user searched for, 2: meetup organization documentation URL */ 
    1239                 __( 'There aren&#8217;t any events scheduled near %1$s at the moment. Would you like to <a href="%2$s">organize one</a>?' ), 
    1240                 '{{ data.location.description }}', 
    1241                 __( 'https://make.wordpress.org/community/handbook/meetup-organizer/welcome/' ) 
    1242             ); ?> 
     1237            <# if ( data.location.description ) { #> 
     1238                <?php printf( 
     1239                    /* translators: 1: the city the user searched for, 2: meetup organization documentation URL */ 
     1240                    __( 'There aren&#8217;t any events scheduled near %1$s at the moment. Would you like to <a href="%2$s">organize one</a>?' ), 
     1241                    '{{ data.location.description }}', 
     1242                    __( 'https://make.wordpress.org/community/handbook/meetup-organizer/welcome/' ) 
     1243                ); ?> 
     1244 
     1245            <# } else { #> 
     1246                <?php printf( 
     1247                    /* translators: meetup organization documentation URL. */ 
     1248                    __( 'There aren&#8217;t any events scheduled near you at the moment. Would you like to <a href="%s">organize one</a>?' ), 
     1249                    __( 'https://make.wordpress.org/community/handbook/meetup-organizer/welcome/' ) 
     1250                ); ?> 
     1251            <# } #> 
    12431252        </li> 
    12441253    </script> 
    1245  
    12461254    <?php 
    12471255} 
  • trunk/src/wp-admin/js/dashboard.js

    r40789 r40790  
    386386             * should be displayed. 
    387387             */ 
    388             if ( templateParams.location ) { 
     388            if ( templateParams.location.ip ) { 
     389                /* 
     390                 * If the API determined the location by geolocating an IP, it will 
     391                 * provide events, but not a specific location. 
     392                 */ 
     393                $locationMessage.text( communityEventsData.l10n.attend_event_near_generic ); 
     394 
     395                if ( templateParams.events.length ) { 
     396                    template = wp.template( 'community-events-event-list' ); 
     397                    $results.html( template( templateParams ) ); 
     398                } else { 
     399                    template = wp.template( 'community-events-no-upcoming-events' ); 
     400                    $results.html( template( templateParams ) ); 
     401                } 
     402 
     403                elementVisibility['#community-events-location-message'] = true; 
     404                elementVisibility['.community-events-toggle-location']  = true; 
     405                elementVisibility['.community-events-results']          = true; 
     406 
     407            } else if ( templateParams.location.description ) { 
    389408                template = wp.template( 'community-events-attend-event-near' ); 
    390409                $locationMessage.html( template( templateParams ) ); 
     
    436455            $toggleButton.attr( 'aria-expanded', elementVisibility['.community-events-toggle-location'] ); 
    437456 
    438             if ( templateParams.location ) { 
     457            if ( templateParams.location && ( templateParams.location.ip || templateParams.location.latitude ) ) { 
    439458                // Hide the form when there's a valid location. 
    440459                app.toggleLocationForm( 'hide' ); 
  • trunk/src/wp-includes/script-loader.php

    r40776 r40790  
    10131013    require_once( ABSPATH . 'wp-admin/includes/class-wp-community-events.php' ); 
    10141014 
    1015     $user_id       = get_current_user_id(); 
    1016     $user_location = get_user_option( 'community-events-location', $user_id ); 
    1017     $events_client = new WP_Community_Events( $user_id, $user_location ); 
     1015    $user_id            = get_current_user_id(); 
     1016    $saved_location     = get_user_option( 'community-events-location', $user_id ); 
     1017    $saved_ip_address   = isset( $saved_location['ip'] ) ? $saved_location['ip'] : false; 
     1018    $current_ip_address = WP_Community_Events::get_unsafe_client_ip(); 
     1019 
     1020    /* 
     1021     * If the user's location is based on their IP address, then update their 
     1022     * location when their IP address changes. This allows them to see events 
     1023     * in their current city when travelling. Otherwise, they would always be 
     1024     * shown events in the city where they were when they first loaded the 
     1025     * Dashboard, which could have been months or years ago. 
     1026     */ 
     1027    if ( $saved_ip_address && $current_ip_address && $current_ip_address !== $saved_ip_address ) { 
     1028        $saved_location['ip'] = $current_ip_address; 
     1029        update_user_option( $user_id, 'community-events-location', $saved_location, true ); 
     1030    } 
     1031 
     1032    $events_client = new WP_Community_Events( $user_id, $saved_location ); 
    10181033 
    10191034    wp_localize_script( 'dashboard', 'communityEventsData', array( 
     
    10241039            'enter_closest_city' => __( 'Enter your closest city to find nearby events.' ), 
    10251040            'error_occurred_please_try_again' => __( 'An error occurred. Please try again.' ), 
     1041            'attend_event_near_generic' => __( 'Attend an upcoming event near you.' ), 
    10261042 
    10271043            /* 
Note: See TracChangeset for help on using the changeset viewer.