<?php

require_once 'Swift/Tests/SwiftUnitTestCase.php';
require_once 'Swift/Mime/HeaderEncoder/QpHeaderEncoder.php';
require_once 'Swift/CharacterStream.php';

class Swift_Mime_HeaderEncoder_QpHeaderEncoderTest
  extends Swift_Tests_SwiftUnitTestCase
{
  
  //Most tests are already covered in QpEncoderTest since this subclass only
  // adds a getName() method
  
  public function testNameIsQ()
  {
    $encoder = $this->_createEncoder(
      $this->_createCharacterStream(true)
      );
    $this->assertEqual('Q', $encoder->getName());
  }
  
  public function testSpaceAndTabNeverAppear()
  {
    /* -- RFC 2047, 4.
     Only a subset of the printable ASCII characters may be used in
     'encoded-text'.  Space and tab characters are not allowed, so that
     the beginning and end of an 'encoded-word' are obvious.
     */
    
    $charStream = $this->_createCharacterStream();
    $this->_checking(Expectations::create()
      -> one($charStream)->readBytes(any()) -> returns(array(ord('a')))
      -> one($charStream)->readBytes(any()) -> returns(array(0x20))
      -> one($charStream)->readBytes(any()) -> returns(array(0x09))
      -> one($charStream)->readBytes(any()) -> returns(array(0x20))
      -> one($charStream)->readBytes(any()) -> returns(array(ord('b')))
      -> allowing($charStream)->readBytes(any()) -> returns(false)
      -> ignoring($charStream)
      );
    
    $encoder = $this->_createEncoder($charStream);
    $this->assertNoPattern('~[ \t]~', $encoder->encodeString("a \t b"),
      '%s: encoded-words in headers cannot contain LWSP as per RFC 2047.'
      );
  }
  
  public function testSpaceIsRepresentedByUnderscore()
  {
    /* -- RFC 2047, 4.2.
    (2) The 8-bit hexadecimal value 20 (e.g., ISO-8859-1 SPACE) may be
       represented as "_" (underscore, ASCII 95.).  (This character may
       not pass through some internetwork mail gateways, but its use
       will greatly enhance readability of "Q" encoded data with mail
       readers that do not support this encoding.)  Note that the "_"
       always represents hexadecimal 20, even if the SPACE character
       occupies a different code position in the character set in use.
       */
    $charStream = $this->_createCharacterStream();
    $this->_checking(Expectations::create()
      -> one($charStream)->readBytes(any()) -> returns(array(ord('a')))
      -> one($charStream)->readBytes(any()) -> returns(array(0x20))
      -> one($charStream)->readBytes(any()) -> returns(array(ord('b')))
      -> allowing($charStream)->readBytes(any()) -> returns(false)
      -> ignoring($charStream)
      );
    
    $encoder = $this->_createEncoder($charStream);
    $this->assertEqual('a_b', $encoder->encodeString('a b'),
      '%s: Spaces can be represented by more readable underscores as per RFC 2047.'
      );
  }
  
  public function testEqualsAndQuestionAndUnderscoreAreEncoded()
  {
    /* -- RFC 2047, 4.2.
    (3) 8-bit values which correspond to printable ASCII characters other
       than "=", "?", and "_" (underscore), MAY be represented as those
       characters.  (But see section 5 for restrictions.)  In
       particular, SPACE and TAB MUST NOT be represented as themselves
       within encoded words.
       */
    $charStream = $this->_createCharacterStream();
    $this->_checking(Expectations::create()
      -> one($charStream)->readBytes(any()) -> returns(array(ord('=')))
      -> one($charStream)->readBytes(any()) -> returns(array(ord('?')))
      -> one($charStream)->readBytes(any()) -> returns(array(ord('_')))
      -> allowing($charStream)->readBytes(any()) -> returns(false)
      -> ignoring($charStream)
      );
    
    $encoder = $this->_createEncoder($charStream);
    $this->assertEqual('=3D=3F=5F', $encoder->encodeString('=?_'),
      '%s: Chars =, ? and _ (underscore) may not appear as per RFC 2047.'
      );
  }
  
  public function testParensAndQuotesAreEncoded()
  {
    /* -- RFC 2047, 5 (2).
     A "Q"-encoded 'encoded-word' which appears in a 'comment' MUST NOT
     contain the characters "(", ")" or "
     */
    
    $charStream = $this->_createCharacterStream();
    $this->_checking(Expectations::create()
      -> one($charStream)->readBytes(any()) -> returns(array(ord('(')))
      -> one($charStream)->readBytes(any()) -> returns(array(ord('"')))
      -> one($charStream)->readBytes(any()) -> returns(array(ord(')')))
      -> allowing($charStream)->readBytes(any()) -> returns(false)
      -> ignoring($charStream)
      );
      
    $encoder = $this->_createEncoder($charStream);
    $this->assertEqual('=28=22=29', $encoder->encodeString('(")'),
      '%s: Chars (, " (DQUOTE) and ) may not appear as per RFC 2047.'
      );
  }
  
  public function testOnlyCharactersAllowedInPhrasesAreUsed()
  {
    /* -- RFC 2047, 5.
    (3) As a replacement for a 'word' entity within a 'phrase', for example,
    one that precedes an address in a From, To, or Cc header.  The ABNF
    definition for 'phrase' from RFC 822 thus becomes:

    phrase = 1*( encoded-word / word )

    In this case the set of characters that may be used in a "Q"-encoded
    'encoded-word' is restricted to: <upper and lower case ASCII
    letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
    (underscore, ASCII 95.)>.  An 'encoded-word' that appears within a
    'phrase' MUST be separated from any adjacent 'word', 'text' or
    'special' by 'linear-white-space'.
    */
    
    $allowedBytes = array_merge(
      range(ord('a'), ord('z')), range(ord('A'), ord('Z')),
      range(ord('0'), ord('9')),
      array(ord('!'), ord('*'), ord('+'), ord('-'), ord('/'))
      );
    
    foreach (range(0x00, 0xFF) as $byte)
    {
      $char = pack('C', $byte);
      
      $charStream = $this->_createCharacterStream();
      $this->_checking(Expectations::create()
        -> one($charStream)->readBytes(any()) -> returns(array($byte))
        -> allowing($charStream)->readBytes(any()) -> returns(false)
        -> ignoring($charStream)
        );
      
      $encoder = $this->_createEncoder($charStream);
      $encodedChar = $encoder->encodeString($char);
      
      if (in_array($byte, $allowedBytes))
      {
        $this->assertEqual($char, $encodedChar,
          '%s: Character ' . $char . ' should not be encoded.'
          );
      }
      elseif (0x20 == $byte) //Special case
      {
        $this->assertEqual('_', $encodedChar,
          '%s: Space character should be replaced.'
          );
      }
      else
      {
        $this->assertEqual(sprintf('=%02X', $byte), $encodedChar,
          '%s: Byte ' . $byte . ' should be encoded.'
          );
      }
    }
  }
  
  public function testEqualsNeverAppearsAtEndOfLine()
  {
    /* -- RFC 2047, 5 (3).
    The 'encoded-text' in an 'encoded-word' must be self-contained;
    'encoded-text' MUST NOT be continued from one 'encoded-word' to
    another.  This implies that the 'encoded-text' portion of a "B"
    'encoded-word' will be a multiple of 4 characters long; for a "Q"
    'encoded-word', any "=" character that appears in the 'encoded-text'
    portion will be followed by two hexadecimal characters.
    */
    
    $input = str_repeat('a', 140);
    
    $charStream = $this->_createCharacterStream();
    
    $output = '';
    $seq = 0;
    for (; $seq < 140; ++$seq)
    {
      $this->_checking(Expectations::create()
        -> one($charStream)->readBytes(any()) -> returns(array(ord('a')))
        );
      
      if (75 == $seq)
      {
        $output .= "\r\n"; // =\r\n
      }
      $output .= 'a';
    }
    
    $this->_checking(Expectations::create()
      -> allowing($charStream)->readBytes(any()) -> returns(false)
      -> ignoring($charStream)
      );
    
    $encoder = $this->_createEncoder($charStream);
    $this->assertEqual($output, $encoder->encodeString($input));
  }
  
  // -- Creation Methods
  
  private function _createEncoder($charStream)
  {
    return new Swift_Mime_HeaderEncoder_QpHeaderEncoder($charStream);
  }
  
  private function _createCharacterStream($stub = false)
  {
    return $stub
      ? $this->_stub('Swift_CharacterStream')
      : $this->_mock('Swift_CharacterStream')
      ;
  }
  
}