WordPress.org
Get WordPress

Make WordPress Core

Ticket #46894: 46894.4.alt.diff

File 46894.4.alt.diff, 8.3 KB (added by garrett-eclipse, 5 years ago)

Alternate patch to ensure uniqueness by using group_id

  • src/wp-admin/includes/privacy-tools.php

     
    215215 * Generate a single group for the personal data export report.
    216216 *
    217217 * @since 4.9.6
     218 * @since 5.4.0 Added $group_id to support the TOC implementation from #6894
    218219 *
    219220 * @param array $group_data {
    220221 *     The group data to render.
    … …  
    231232 *         }
    232233 *     }
    233234 * }
     235 * @param string $group_id The unique ID for the export grouping.
    234236 * @return string The HTML for this group and its items.
    235237 */
    236 function wp_privacy_generate_personal_data_export_group_html( $group_data ) {
    237         $group_html  = '<h2>';
     238function wp_privacy_generate_personal_data_export_group_html( $group_data, $group_id = '' ) {
     239        $group_id_attr = sanitize_title_with_dashes( $group_data['group_label'] . '-' . $group_id );
     240        $group_html  = '<h2 id="' . esc_attr( $group_id_attr ) . '">';
    238241        $group_html .= esc_html( $group_data['group_label'] );
    239242
    240243        $items_count = count( (array) $group_data['items'] );
    … …  
    271274                $group_html .= '</table>';
    272275        }
    273276
     277        $group_html .= '<div class="return_to_top">';
     278        $group_html .= '<a href="#top">' . esc_html__( '&uarr; Return to top' ) . '</a>';
    274279        $group_html .= '</div>';
    275280
     281        $group_html .= '</div>';
     282
    276283        return $group_html;
    277284}
    278285
    … …  
    350357        fwrite( $file, 'th { padding: 5px; text-align: left; width: 20%; }' );
    351358        fwrite( $file, 'td { padding: 5px; }' );
    352359        fwrite( $file, 'tr:nth-child(odd) { background-color: #fafafa; }' );
     360        fwrite( $file, '.return_to_top { text-align:right; }' );
    353361        fwrite( $file, '</style>' );
    354362        fwrite( $file, '<title>' );
    355363        fwrite( $file, esc_html( $title ) );
    … …  
    360368        fwrite( $file, "<body>\n" );
    361369
    362370        // Heading.
    363         fwrite( $file, '<h1>' . esc_html__( 'Personal Data Export' ) . '</h1>' );
     371        fwrite( $file, '<h1 id="top">' . esc_html__( 'Personal Data Export' ) . '</h1>' );
    364372
    365373        // And now, all the Groups.
    366374        $groups = get_post_meta( $request_id, '_export_data_grouped', true );
    … …  
    396404        // Merge in the special about group.
    397405        $groups = array_merge( array( 'about' => $about_group ), $groups );
    398406
     407        // Create TOC.
     408        if ( count( $groups ) > 1 ) {
     409                fwrite( $file, '<div id="table_of_contents">' );
     410                fwrite( $file, '<h2>' . esc_html__( 'Table of Contents' ) . '</h2>' );
     411                fwrite( $file, '<ul>' );
     412
     413                foreach ( (array) $groups as $group_id => $group_data ) {
     414                        $group_id_attr = sanitize_title_with_dashes( $group_data['group_label'] . '-' . $group_id );
     415                        fwrite( $file, '<li>' );
     416                        fwrite( $file, '<a href="#' . esc_attr( $group_id_attr ) . '">' . esc_html( $group_data['group_label'] ) . '</a>' );
     417                        fwrite( $file, '</li>' );
     418                }
     419
     420                fwrite( $file, '</ul>' );
     421                fwrite( $file, '</div>' );
     422        }
     423
    399424        // Now, iterate over every group in $groups and have the formatter render it in HTML.
    400425        foreach ( (array) $groups as $group_id => $group_data ) {
    401                 fwrite( $file, wp_privacy_generate_personal_data_export_group_html( $group_data ) );
     426                fwrite( $file, wp_privacy_generate_personal_data_export_group_html( $group_data, $group_id ) );
    402427        }
    403428
    404429        fwrite( $file, "</body>\n" );

  • tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php

     
    260260                $report_contents = file_get_contents( $report_dir . 'index.html' );
    261261                $request         = wp_get_user_request_data( self::$export_request_id );
    262262
    263                 $this->assertContains( '<h1>Personal Data Export</h1>', $report_contents );
    264                 $this->assertContains( '<h2>About</h2>', $report_contents );
     263                $this->assertContains( '<h1 id="top">Personal Data Export</h1>', $report_contents );
     264                $this->assertContains( '<h2 id="about-about">About</h2>', $report_contents );
    265265                $this->assertContains( $request->email, $report_contents );
    266266        }
    267267}

  • tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportGroupHtml.php

     
    3939                        ),
    4040                );
    4141
    42                 $actual                = wp_privacy_generate_personal_data_export_group_html( $data );
     42                $actual                = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    4343                $expected_table_markup = '<table><tbody><tr><th>Field 1 Name</th><td>Field 1 Value</td></tr><tr><th>Field 2 Name</th><td>Field 2 Value</td></tr></tbody></table>';
    4444
    45                 $this->assertContains( '<h2>Test Data Group</h2>', $actual );
     45                $this->assertContains( '<h2 id="test-data-group-test-data-group">Test Data Group</h2>', $actual );
    4646                $this->assertContains( $expected_table_markup, $actual );
    4747        }
    4848
    … …  
    7979                        ),
    8080                );
    8181
    82                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     82                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    8383
    84                 $this->assertContains( '<h2>Test Data Group', $actual );
     84                $this->assertContains( '<h2 id="test-data-group-test-data-group">Test Data Group', $actual );
    8585                $this->assertContains( '<td>Field 1 Value', $actual );
    8686                $this->assertContains( '<td>Another Field 1 Value', $actual );
    8787                $this->assertContains( '<td>Field 2 Value', $actual );
    … …  
    117117                        ),
    118118                );
    119119
    120                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     120                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    121121
    122122                $this->assertContains( '<a href="http://wordpress.org">http://wordpress.org</a>', $actual );
    123123                $this->assertContains( '<a href="https://wordpress.org">https://wordpress.org</a>', $actual );
    … …  
    131131         */
    132132        public function test_group_labels_escaped() {
    133133                $data = array(
    134                         'group_label' => '<div>Escape HTML in group lavels</div>',
     134                        'group_label' => '<div>Escape HTML in group labels</div>',
    135135                        'items'       => array(),
    136136                );
    137137
    138                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     138                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'escape-html-in-group-labels' );
    139139
    140                 $this->assertContains( '<h2>&lt;div&gt;Escape HTML in group lavels&lt;/div&gt;</h2>', $actual );
     140                $this->assertContains( '<h2 id="escape-html-in-group-labels-escape-html-in-group-labels">&lt;div&gt;Escape HTML in group labels&lt;/div&gt;</h2>', $actual );
    141141        }
    142142
    143143        /**
    … …  
    162162                        ),
    163163                );
    164164
    165                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     165                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    166166
    167167                $this->assertContains( $data['items'][0]['links']['value'], $actual );
    168168                $this->assertContains( $data['items'][0]['formatting']['value'], $actual );
    … …  
    190190                        ),
    191191                );
    192192
    193                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     193                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    194194
    195195                $this->assertNotContains( $data['items'][0]['scripts']['value'], $actual );
    196196                $this->assertContains( '<td>Testing that script tags are stripped.</td>', $actual );
    … …  
    223223                        ),
    224224                );
    225225
    226                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     226                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    227227
    228                 $this->assertContains( '<h2>Test Data Group', $actual );
     228                $this->assertContains( '<h2 id="test-data-group-test-data-group">Test Data Group', $actual );
    229229                $this->assertContains( '<span class="count">(2)</span></h2>', $actual );
    230230                $this->assertSame( 2, substr_count( $actual, '<table>' ) );
    231231        }
    … …  
    248248                        ),
    249249                );
    250250
    251                 $actual = wp_privacy_generate_personal_data_export_group_html( $data );
     251                $actual = wp_privacy_generate_personal_data_export_group_html( $data, 'test-data-group' );
    252252
    253                 $this->assertContains( '<h2>Test Data Group</h2>', $actual );
     253                $this->assertContains( '<h2 id="test-data-group-test-data-group">Test Data Group</h2>', $actual );
    254254                $this->assertNotContains( '<span class="count">', $actual );
    255255                $this->assertSame( 1, substr_count( $actual, '<table>' ) );
    256256        }