From d09963547e8a335d1a15db393080908171667070 Mon Sep 17 00:00:00 2001 From: Bob Vincent Date: Sun, 24 Apr 2011 01:31:59 -0400 Subject: [PATCH] Issue #299138 by catch, Kevin Hankens, drewish, arjenk, jrglasgow, stella, sun, kscheirer, lilou, pillarsdotnet: Fix the broken formatting in drupal_html_to_text() and also add tests. (test-only patch) --- modules/simpletest/tests/mail.test | 169 +++++++++++++++++++++++++++++++++++- 1 files changed, 168 insertions(+), 1 deletions(-) diff --git a/modules/simpletest/tests/mail.test b/modules/simpletest/tests/mail.test index 8a7b152d9d32eee7ae47c9ef8b5fb9c77f4e0cf1..9f8367597d0b7a6ec142cc7ff0c6f2377f0fa9c6 100644 --- a/modules/simpletest/tests/mail.test +++ b/modules/simpletest/tests/mail.test @@ -1,6 +1,7 @@ 'HTML to text conversion', + 'description' => 'Tests drupal_html_to_text().', + 'group' => 'Mail', + ); + } + + /** + * Test all supported tags of drupal_html_to_text(). + */ + function testTags() { + $tests = array( + 'Drupal.org' => "Drupal.org [1]\n[1] http://drupal.org", + '
Drupal
' => "Drupal", + 'Drupal' => "*Drupal*", + '
Drupal
' => "> Drupal", + '
Drupal
Drupal

Drupal' => "Drupal\nDrupal\n\nDrupal", + 'Drupal' => "Drupal", + '
Drupal
' => "Drupal", + '
Drupal
' => "Drupal", + '
Drupal
Drupal
' => "Drupal\n Drupal", + '
Drupal
Drupal
' => "Drupal\n Drupal", + '
Drupal
' => "Drupal", + '
Drupal
' => "Drupal", + 'Drupal' => "/Drupal/", + '

Drupal

' => "======== DRUPAL " . str_repeat('=', 62) . "", + '

Drupal

' => "-------- DRUPAL " . str_repeat('-', 62) . "", + '

Drupal

' => ".... Drupal", + '

Drupal

' => ".. Drupal", + '
Drupal
' => "Drupal", + '
Drupal
' => "Drupal", + '
Drupal
' => str_repeat('-', 78) . "\nDrupal\n" . str_repeat('-', 78), + 'Drupal' => "Drupal", + 'Drupal' => "/Drupal/", + '
  1. Drupal
' => " 1) Drupal", + '
  1. Drupal
    • Drupal
    • Drupal
' => " 1) Drupal\n 2) * Drupal\n * Drupal", + '
  1. Drupal
  2. Drupal
' => " 1) Drupal\n 2) Drupal", + '
    Drupal
' => "Drupal", + '

Drupal

' => "Drupal", + '
Drupal
' => "Drupal", + 'Drupal' => "*Drupal*", + '
DrupalDrupal
DrupalDrupal
' => "Drupal Drupal\nDrupal Drupal", + '' => " * Drupal", + '' => " * Drupal /Drupal/ Drupal", + '' => " * Drupal\n * 1) Drupal\n 2) Drupal", + '' => " * Drupal\n * Drupal", + // Tests malformed HTML tags. + '
Drupal
Drupal' => "Drupal\nDrupal", + '
Drupal
Drupal' => str_repeat('-', 78) . "\nDrupal\n" . str_repeat('-', 78) . "\nDrupal", + '
  1. Drupal
  2. Drupal
' => " 1) Drupal\n 2) Drupal", + '' => " * Drupal /Drupal/ Drupal", + '
  • Drupal' => "Drupal\n * Drupal", + // Tests some unsupported HTML tags. + 'Drupal' => "Drupal", + '' => "Drupal", + ); + + foreach ($tests as $html => $text) { + $result = drupal_html_to_text($html); + $this->assertEqual($result, $text, + var_export($html, TRUE) + . '
    ' + . str_replace("\n", '\n', check_plain(var_export($result, TRUE))) + . '
    is equal to
    ' + . str_replace("\n", '\n', check_plain(var_export($text, TRUE))) + ); + } + } + + /** + * Test $allowed_tags argument of drupal_html_to_text(). + */ + function testDrupalHtmlToTextArgs() { + // The second parameter of drupal_html_to_text() overrules the allowed tags. + $result = drupal_html_to_text('Drupal Drupal Drupal', array('b')); + $this->assertEqual($result, 'Drupal *Drupal* Drupal', 'Allowed <b> tag found.'); + + $result = drupal_html_to_text('Drupal

    Drupal

    Drupal', array('b')); + $this->assertEqual($result, 'Drupal Drupal Drupal', 'Disallowed <h1> tag not found.'); + + $result = drupal_html_to_text('Drupal

    Drupal

    Drupal', array('a', 'br', 'h1')); + $this->assertEqual($result, 'Drupal Drupal Drupal', 'Disallowed <p>, <em>, and <b> tags not found.'); + + $result = drupal_html_to_text('Drupal', array('html', 'body')); + $this->assertEqual($result, 'Drupal', 'Unsupported <html> and <body> tags not found.'); + } + + /** + * Test that whitespace is collapsed, except within 

     tags.
+   */
+  function testDrupalHtmltoTextCollapsesWhitespace() {
+    $input = "\n\n \n  \n
    Drupal\n\n Drupal\n\n  Drupal
    \n \n  \n\n";
+    $collapsed = "Drupal Drupal Drupal";
+    $preserved = "Drupal\n\n Drupal\n\n  Drupal";
+    $result = drupal_html_to_text($input, array('p'));
+    $this->assertEqual($result, $collapsed,
+      'Whitespace inside <pre> tags is collapsed if <pre> is disallowed:
    '
+      . "
    $input

    becomes
    $result
    "
+    );
+    $result = drupal_html_to_text($input);
+    $this->assertEqual($result, $preserved,
+      'Whitespace inside <pre> tags is preserved if <pre> is allowed:
    '
+      . "
    $input

    becomes
    $result
    "
+    );
+  }
+
+  /**
+   * Test that text separated by block-level tags in HTML get separated by
+   * (at least) a newline in the plaintext version.
+   */
+  function testDrupalHtmlToTextBlockTagToNewline() {
+    $input = '[text]'
+      . '
    [address]
    '
+      . '
    [blockquote]
    '
+      . '
    [br]'
+      . '[del]'
+      . '
    [div]
    '
+      . '
    [dl-dt]
    '
+      . '
    [dt]
    '
+      . '
    [dd]
    '
+      . '
    [dd]
    '
+      . '
    [h1]
    '
+      . '
    [h2]
    '
+      . '
    [h3]
    '
+      . '
    [h4]
    '
+      . '
    [h5]
    '
+      . '
    [h6]
    '
+      . '
    [hr]'
+      . '[ins]'
+      . '
    1. [ol-li]
      2. '
+      . '
    2. [li]
    '
+      . '
    [p]
    '
+      . '
    [pre]
    '
+      . ''
+      . ''
+      . '
    [table-thead--tr-td]
    [tbody-tr-td]
    [tr-td]
    '
+      . '
    • [ul-li]
      • '
+      . '
    • [li]
    '
+      . '[text]';
+    $output = drupal_html_to_text($input);
+    $this->assertFalse(
+      preg_match('/\][^\n]*\[/s', $output),
+      'Block-level HTML tags should force newlines: '
+      . nl2br(check_plain($output))
+    );
+    $output_upper = drupal_strtoupper($output);
+    $upper_input = drupal_strtoupper($input);
+    $upper_output = drupal_html_to_text($upper_input);
+    $this->assertEqual(
+      $upper_output,
+      $output_upper,
+      'Tag recognition should be case-insensitive:
    '
+      . $upper_output
+      . '
    should  be equal to 
    '
+      . $output_upper
+    );
+  }
+}
-- 
1.7.1