mirror of
https://we.phorge.it/source/phorge.git
synced 2024-12-14 01:26:13 +01:00
277 lines
6.7 KiB
PHP
277 lines
6.7 KiB
PHP
|
<?php
|
||
|
|
||
|
namespace PhpMimeMailParser;
|
||
|
|
||
|
use function var_dump;
|
||
|
|
||
|
/**
|
||
|
* Attachment of php-mime-mail-parser
|
||
|
*
|
||
|
* Fully Tested Mailparse Extension Wrapper for PHP 5.4+
|
||
|
*
|
||
|
*/
|
||
|
class Attachment
|
||
|
{
|
||
|
/**
|
||
|
* @var string $filename Filename
|
||
|
*/
|
||
|
protected $filename;
|
||
|
|
||
|
/**
|
||
|
* @var string $contentType Mime Type
|
||
|
*/
|
||
|
protected $contentType;
|
||
|
|
||
|
/**
|
||
|
* @var string $content File Content
|
||
|
*/
|
||
|
protected $content;
|
||
|
|
||
|
/**
|
||
|
* @var string $contentDisposition Content-Disposition (attachment or inline)
|
||
|
*/
|
||
|
protected $contentDisposition;
|
||
|
|
||
|
/**
|
||
|
* @var string $contentId Content-ID
|
||
|
*/
|
||
|
protected $contentId;
|
||
|
|
||
|
/**
|
||
|
* @var array $headers An Array of the attachment headers
|
||
|
*/
|
||
|
protected $headers;
|
||
|
|
||
|
/**
|
||
|
* @var resource $stream
|
||
|
*/
|
||
|
protected $stream;
|
||
|
|
||
|
/**
|
||
|
* @var string $mimePartStr
|
||
|
*/
|
||
|
protected $mimePartStr;
|
||
|
|
||
|
/**
|
||
|
* @var integer $maxDuplicateNumber
|
||
|
*/
|
||
|
public $maxDuplicateNumber = 100;
|
||
|
|
||
|
/**
|
||
|
* Attachment constructor.
|
||
|
*
|
||
|
* @param string $filename
|
||
|
* @param string $contentType
|
||
|
* @param resource $stream
|
||
|
* @param string $contentDisposition
|
||
|
* @param string $contentId
|
||
|
* @param array $headers
|
||
|
* @param string $mimePartStr
|
||
|
*/
|
||
|
public function __construct(
|
||
|
$filename,
|
||
|
$contentType,
|
||
|
$stream,
|
||
|
$contentDisposition = 'attachment',
|
||
|
$contentId = '',
|
||
|
$headers = [],
|
||
|
$mimePartStr = ''
|
||
|
) {
|
||
|
$this->filename = $filename;
|
||
|
$this->contentType = $contentType;
|
||
|
$this->stream = $stream;
|
||
|
$this->content = null;
|
||
|
$this->contentDisposition = $contentDisposition;
|
||
|
$this->contentId = $contentId;
|
||
|
$this->headers = $headers;
|
||
|
$this->mimePartStr = $mimePartStr;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* retrieve the attachment filename
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getFilename()
|
||
|
{
|
||
|
return $this->filename;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieve the Attachment Content-Type
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getContentType()
|
||
|
{
|
||
|
return $this->contentType;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieve the Attachment Content-Disposition
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getContentDisposition()
|
||
|
{
|
||
|
return $this->contentDisposition;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieve the Attachment Content-ID
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getContentID()
|
||
|
{
|
||
|
return $this->contentId;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieve the Attachment Headers
|
||
|
*
|
||
|
* @return array
|
||
|
*/
|
||
|
public function getHeaders()
|
||
|
{
|
||
|
return $this->headers;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Get a handle to the stream
|
||
|
*
|
||
|
* @return resource
|
||
|
*/
|
||
|
public function getStream()
|
||
|
{
|
||
|
return $this->stream;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Rename a file if it already exists at its destination.
|
||
|
* Renaming is done by adding a duplicate number to the file name. E.g. existingFileName_1.ext.
|
||
|
* After a max duplicate number, renaming the file will switch over to generating a random suffix.
|
||
|
*
|
||
|
* @param string $fileName Complete path to the file.
|
||
|
* @return string The suffixed file name.
|
||
|
*/
|
||
|
protected function suffixFileName(string $fileName): string
|
||
|
{
|
||
|
$pathInfo = pathinfo($fileName);
|
||
|
$dirname = $pathInfo['dirname'].DIRECTORY_SEPARATOR;
|
||
|
$filename = $pathInfo['filename'];
|
||
|
$extension = empty($pathInfo['extension']) ? '' : '.'.$pathInfo['extension'];
|
||
|
|
||
|
$i = 0;
|
||
|
do {
|
||
|
$i++;
|
||
|
|
||
|
if ($i > $this->maxDuplicateNumber) {
|
||
|
$duplicateExtension = uniqid();
|
||
|
} else {
|
||
|
$duplicateExtension = $i;
|
||
|
}
|
||
|
|
||
|
$resultName = $dirname.$filename."_$duplicateExtension".$extension;
|
||
|
} while (file_exists($resultName));
|
||
|
|
||
|
return $resultName;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Read the contents a few bytes at a time until completed
|
||
|
* Once read to completion, it always returns false
|
||
|
*
|
||
|
* @param int $bytes (default: 2082)
|
||
|
*
|
||
|
* @return string|bool
|
||
|
*/
|
||
|
public function read($bytes = 2082)
|
||
|
{
|
||
|
return feof($this->stream) ? false : fread($this->stream, $bytes);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieve the file content in one go
|
||
|
* Once you retrieve the content you cannot use MimeMailParser_attachment::read()
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getContent()
|
||
|
{
|
||
|
if ($this->content === null) {
|
||
|
fseek($this->stream, 0);
|
||
|
while (($buf = $this->read()) !== false) {
|
||
|
$this->content .= $buf;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return $this->content;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Get mime part string for this attachment
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getMimePartStr()
|
||
|
{
|
||
|
return $this->mimePartStr;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Save the attachment individually
|
||
|
*
|
||
|
* @param string $attach_dir
|
||
|
* @param string $filenameStrategy
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function save(
|
||
|
$attach_dir,
|
||
|
$filenameStrategy = Parser::ATTACHMENT_DUPLICATE_SUFFIX
|
||
|
) {
|
||
|
$attach_dir = rtrim($attach_dir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
|
||
|
if (!is_dir($attach_dir)) {
|
||
|
mkdir($attach_dir);
|
||
|
}
|
||
|
|
||
|
// Determine filename
|
||
|
switch ($filenameStrategy) {
|
||
|
case Parser::ATTACHMENT_RANDOM_FILENAME:
|
||
|
$fileInfo = pathinfo($this->getFilename());
|
||
|
$extension = empty($fileInfo['extension']) ? '' : '.'.$fileInfo['extension'];
|
||
|
$attachment_path = $attach_dir.uniqid().$extension;
|
||
|
break;
|
||
|
case Parser::ATTACHMENT_DUPLICATE_THROW:
|
||
|
case Parser::ATTACHMENT_DUPLICATE_SUFFIX:
|
||
|
$attachment_path = $attach_dir.$this->getFilename();
|
||
|
break;
|
||
|
default:
|
||
|
throw new Exception('Invalid filename strategy argument provided.');
|
||
|
}
|
||
|
|
||
|
// Handle duplicate filename
|
||
|
if (file_exists($attachment_path)) {
|
||
|
switch ($filenameStrategy) {
|
||
|
case Parser::ATTACHMENT_DUPLICATE_THROW:
|
||
|
throw new Exception('Could not create file for attachment: duplicate filename.');
|
||
|
case Parser::ATTACHMENT_DUPLICATE_SUFFIX:
|
||
|
$attachment_path = $this->suffixFileName($attachment_path);
|
||
|
break;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/** @var resource $fp */
|
||
|
if ($fp = fopen($attachment_path, 'w')) {
|
||
|
while ($bytes = $this->read()) {
|
||
|
fwrite($fp, $bytes);
|
||
|
}
|
||
|
fclose($fp);
|
||
|
return realpath($attachment_path);
|
||
|
} else {
|
||
|
throw new Exception('Could not write attachments. Your directory may be unwritable by PHP.');
|
||
|
}
|
||
|
}
|
||
|
}
|