aboutsummaryrefslogtreecommitdiff
path: root/External/swiftmailer/lib/classes/Swift/Mime/SimpleHeaderSet.php
blob: eeb0221bb4090ac36453802170bd547c3e3de811 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

//@require 'Swift/Mime/HeaderSet.php';
//@require 'Swift/Mime/HeaderFactory.php';

/**
 * A collection of MIME headers.
 * 
 * @package Swift
 * @subpackage Mime
 * 
 * @author Chris Corbyn
 */
class Swift_Mime_SimpleHeaderSet implements Swift_Mime_HeaderSet
{
  
  /** HeaderFactory */
  private $_factory;
  
  /** Collection of set Headers */
  private $_headers = array();
  
  /** Field ordering details */
  private $_order = array();
  
  /** List of fields which are required to be displayed */
  private $_required = array();
  
  /** The charset used by Headers */
  private $_charset;
  
  /**
   * Create a new SimpleHeaderSet with the given $factory.
   * 
   * @param Swift_Mime_HeaderFactory $factory
   * @param string $charset
   */
  public function __construct(Swift_Mime_HeaderFactory $factory,
    $charset = null)
  {
    $this->_factory = $factory;
    if (isset($charset))
    {
      $this->setCharset($charset);
    }
  }
  
  /**
   * Set the charset used by these headers.
   * 
   * @param string $charset
   */
  public function setCharset($charset)
  {
    $this->_charset = $charset;
    $this->_factory->charsetChanged($charset);
    $this->_notifyHeadersOfCharset($charset);
  }
  
  /**
   * Add a new Mailbox Header with a list of $addresses.
   * 
   * @param string $name
   * @param array|string $addresses
   */
  public function addMailboxHeader($name, $addresses = null)
  {
    $this->_storeHeader($name,
      $this->_factory->createMailboxHeader($name, $addresses));
  }
  
  /**
   * Add a new Date header using $timestamp (UNIX time).
   * 
   * @param string $name
   * @param int $timestamp
   */
  public function addDateHeader($name, $timestamp = null)
  {
    $this->_storeHeader($name,
      $this->_factory->createDateHeader($name, $timestamp));
  }
  
  /**
   * Add a new basic text header with $name and $value.
   * 
   * @param string $name
   * @param string $value
   */
  public function addTextHeader($name, $value = null)
  {
    $this->_storeHeader($name,
      $this->_factory->createTextHeader($name, $value));
  }
  
  /**
   * Add a new ParameterizedHeader with $name, $value and $params.
   * 
   * @param string $name
   * @param string $value
   * @param array $params
   */
  public function addParameterizedHeader($name, $value = null,
    $params = array())
  {
    $this->_storeHeader($name,
      $this->_factory->createParameterizedHeader($name, $value,
      $params));
  }
  
  /**
   * Add a new ID header for Message-ID or Content-ID.
   * 
   * @param string $name
   * @param string|array $ids
   */
  public function addIdHeader($name, $ids = null)
  {
    $this->_storeHeader($name, $this->_factory->createIdHeader($name, $ids));
  }
  
  /**
   * Add a new Path header with an address (path) in it.
   * 
   * @param string $name
   * @param string $path
   */
  public function addPathHeader($name, $path = null)
  {
    $this->_storeHeader($name, $this->_factory->createPathHeader($name, $path));
  }
  
  /**
   * Returns true if at least one header with the given $name exists.
   * 
   * If multiple headers match, the actual one may be specified by $index.
   * 
   * @param string $name
   * @param int $index
   * 
   * @return boolean
   */
  public function has($name, $index = 0)
  {
    $lowerName = strtolower($name);
    return array_key_exists($lowerName, $this->_headers)
      && array_key_exists($index, $this->_headers[$lowerName]);
  }
  
  /**
   * Set a header in the HeaderSet.
   * 
   * The header may be a previously fetched header via {@link get()} or it may
   * be one that has been created separately.
   * 
   * If $index is specified, the header will be inserted into the set at this
   * offset.
   * 
   * @param Swift_Mime_Header $header
   * @param int $index
   */
  public function set(Swift_Mime_Header $header, $index = 0)
  {
    $this->_storeHeader($header->getFieldName(), $header, $index);
  }
  
  /**
   * Get the header with the given $name.
   * 
   * If multiple headers match, the actual one may be specified by $index.
   * Returns NULL if none present.
   * 
   * @param string $name
   * @param int $index
   * 
   * @return Swift_Mime_Header
   */
  public function get($name, $index = 0)
  {
    if ($this->has($name, $index))
    {
      $lowerName = strtolower($name);
      return $this->_headers[$lowerName][$index];
    }
  }
  
  /**
   * Get all headers with the given $name.
   * 
   * @param string $name
   * 
   * @return array
   */
  public function getAll($name = null)
  {
    if (!isset($name))
    {
      $headers = array();
      foreach ($this->_headers as $collection)
      {
        $headers = array_merge($headers, $collection);
      }
      return $headers;
    }
    
    $lowerName = strtolower($name);
    if (!array_key_exists($lowerName, $this->_headers))
    {
      return array();
    }
    return $this->_headers[$lowerName];
  }
  
  /**
   * Remove the header with the given $name if it's set.
   * 
   * If multiple headers match, the actual one may be specified by $index.
   * 
   * @param string $name
   * @param int $index
   */
  public function remove($name, $index = 0)
  {
    $lowerName = strtolower($name);
    unset($this->_headers[$lowerName][$index]);
  }
  
  /**
   * Remove all headers with the given $name.
   * 
   * @param string $name
   */
  public function removeAll($name)
  {
    $lowerName = strtolower($name);
    unset($this->_headers[$lowerName]);
  }
  
  /**
   * Create a new instance of this HeaderSet.
   * 
   * @return Swift_Mime_HeaderSet
   */
  public function newInstance()
  {
    return new self($this->_factory);
  }
  
  /**
   * Define a list of Header names as an array in the correct order.
   * 
   * These Headers will be output in the given order where present.
   * 
   * @param array $sequence
   */
  public function defineOrdering(array $sequence)
  {
    $this->_order = array_flip(array_map('strtolower', $sequence));
  }
  
  /**
   * Set a list of header names which must always be displayed when set.
   * 
   * Usually headers without a field value won't be output unless set here.
   * 
   * @param array $names
   */
  public function setAlwaysDisplayed(array $names)
  {
    $this->_required = array_flip(array_map('strtolower', $names));
  }

  /**
   * Notify this observer that the entity's charset has changed.
   * 
   * @param string $charset
   */
  public function charsetChanged($charset)
  {
    $this->setCharset($charset);
  }
  
  /**
   * Returns a string with a representation of all headers.
   * 
   * @return string
   */
  public function toString()
  {
    $string = '';
    $headers = $this->_headers;
    if ($this->_canSort())
    {
      uksort($headers, array($this, '_sortHeaders'));
    }
    foreach ($headers as $collection)
    {
      foreach ($collection as $header)
      {
        if ($this->_isDisplayed($header) || $header->getFieldBody() != '')
        {
          $string .= $header->toString();
        }
      }
    }
    return $string;
  }
  
  /**
   * Returns a string representation of this object.
   *
   * @return string
   *
   * @see toString()
   */
  public function __toString()
  {
    return $this->toString();
  }
  
  // -- Private methods
  
  /** Save a Header to the internal collection */
  private function _storeHeader($name, Swift_Mime_Header $header, $offset = null)
  {
    if (!isset($this->_headers[strtolower($name)]))
    {
      $this->_headers[strtolower($name)] = array();
    }
    if (!isset($offset))
    {
      $this->_headers[strtolower($name)][] = $header;
    }
    else
    {
      $this->_headers[strtolower($name)][$offset] = $header;
    }
  }
  
  /** Test if the headers can be sorted */
  private function _canSort()
  {
    return count($this->_order) > 0;
  }
  
  /** uksort() algorithm for Header ordering */
  private function _sortHeaders($a, $b)
  {
    $lowerA = strtolower($a);
    $lowerB = strtolower($b);
    $aPos = array_key_exists($lowerA, $this->_order)
      ? $this->_order[$lowerA]
      : -1;
    $bPos = array_key_exists($lowerB, $this->_order)
      ? $this->_order[$lowerB]
      : -1;
      
    if ($aPos == -1)
    {
      return 1;
    }
    elseif ($bPos == -1)
    {
      return -1;
    }
    
    return ($aPos < $bPos) ? -1 : 1;
  }
  
  /** Test if the given Header is always displayed */
  private function _isDisplayed(Swift_Mime_Header $header)
  {
    return array_key_exists(strtolower($header->getFieldName()), $this->_required);
  }
  
  /** Notify all Headers of the new charset */
  private function _notifyHeadersOfCharset($charset)
  {
    foreach ($this->_headers as $headerGroup)
    {
      foreach ($headerGroup as $header)
      {
        $header->setCharset($charset);
      }
    }
  }
  
}