Plugin API: Add html2text hook (backport from master)

Aleksander Machniak

2016-04-15 ead084693499934c467ca6a9c396367ac661dd61

 program/steps/mail/compose.inc

@@ -47,19 +47,22 @@
if (!is_array($COMPOSE)) {
    // Infinite redirect prevention in case of broken session (#1487028)
    if ($COMPOSE_ID) {
        rcube::raise_error(array('code' => 500, 'type' => 'php',
            'file' => __FILE__, 'line' => __LINE__,
            'message' => "Invalid compose ID"), true, true);
        // if we know the message with specified ID was already sent
        // we can ignore the error and compose a new message (#1490009)
        if ($COMPOSE_ID != $_SESSION['last_compose_session']) {
            rcube::raise_error(array('code' => 450), false, true);
        }
    }

    $COMPOSE_ID = uniqid(mt_rand());
    $params     = rcube_utils::request2param(rcube_utils::INPUT_GET, 'task|action', true);

    $_SESSION['compose_data_'.$COMPOSE_ID] = array(
        'id'      => $COMPOSE_ID,
        'param'   => rcube_utils::request2param(rcube_utils::INPUT_GET, 'task|action', true),
        'mailbox' => $RCMAIL->storage->get_folder(),
        'param'   => $params,
        'mailbox' => $params['mbox'] ?: $RCMAIL->storage->get_folder(),
    );
    $COMPOSE =& $_SESSION['compose_data_'.$COMPOSE_ID];

    rcmail_process_compose_params($COMPOSE);

    // check if folder for saving sent messages exists and is subscribed (#1486802)
@@ -82,7 +85,7 @@
    'messagesaved', 'converting', 'editorwarning', 'searching', 'uploading', 'uploadingmany',
    'fileuploaderror', 'sendmessage', 'newresponse', 'responsename', 'responsetext', 'save',
    'savingresponse', 'restoresavedcomposedata', 'restoremessage', 'delete', 'restore', 'ignore',
    'selectimportfile');
    'selectimportfile', 'messageissent');

$OUTPUT->set_pagetitle($RCMAIL->gettext('compose'));

@@ -90,8 +93,10 @@
$OUTPUT->set_env('session_id', session_id());
$OUTPUT->set_env('mailbox', $RCMAIL->storage->get_folder());
$OUTPUT->set_env('top_posting', intval($RCMAIL->config->get('reply_mode')) > 0);
$OUTPUT->set_env('sig_below', $RCMAIL->config->get('sig_below'));
$OUTPUT->set_env('recipients_separator', trim($RCMAIL->config->get('recipients_separator', ',')));
$OUTPUT->set_env('save_localstorage', (bool)$RCMAIL->config->get('compose_save_localstorage'));
$OUTPUT->set_env('is_sent', false);

$drafts_mbox     = $RCMAIL->config->get('drafts_mbox');
$config_show_sig = $RCMAIL->config->get('show_sig', 1);
@@ -322,14 +327,24 @@
                $fvalue = $mailfollowup;
            else if ($mailreplyto)
                $fvalue = $mailreplyto;
            else if (!empty($MESSAGE->headers->replyto))
                $fvalue = $MESSAGE->headers->replyto;
            else if (!empty($MESSAGE->headers->replyto)) {
                $fvalue  = $MESSAGE->headers->replyto;
                $replyto = true;
            }
            else if (!empty($MESSAGE->headers->from))
                $fvalue = $MESSAGE->headers->from;

            // Reply to message sent by yourself (#1487074, #1489230)
            if (!empty($ident) && in_array($ident['ident'], array($fvalue, $MESSAGE->headers->from))) {
                $fvalue = $MESSAGE->headers->to;
            // Reply to message sent by yourself (#1487074, #1489230, #1490439)
            // Reply-To address need to be unset (#1490233)
            if (!empty($ident) && empty($replyto)) {
                foreach (array($fvalue, $MESSAGE->headers->from) as $sender) {
                    $senders = rcube_mime::decode_address_list($sender, null, false, $charset, true);

                    if (in_array($ident['email_ascii'], $senders)) {
                        $fvalue = $MESSAGE->headers->to;
                        break;
                    }
                }
            }
        }
        // add recipient of original message if reply to all
@@ -339,8 +354,12 @@
            if ($v = $MESSAGE->headers->cc)
                $fvalue .= (!empty($fvalue) ? $separator : '') . $v;
            // Use Sender header (#1489011)
            if (($v = $MESSAGE->headers->get('Sender', false)) && strpos($v, '-bounces@') === false)
                $fvalue .= (!empty($fvalue) ? $separator : '') . $v;
            if ($v = $MESSAGE->headers->get('Sender', false)) {
                // Skip common mailing lists addresses: *-bounces@ and *-request@ (#1490452)
                if (empty($MESSAGE->headers->others['list-post']) || !preg_match('/-(bounces|request)@/', $v)) {
                    $fvalue .= (!empty($fvalue) ? $separator : '') . $v;
                }
            }

            // When To: and Reply-To: are the same we add From: address to the list (#1489037)
            if ($v = $MESSAGE->headers->from) {
@@ -419,7 +438,8 @@
    'filedroparea'          => 'compose_file_drop_area',
    'priorityselector'      => 'rcmail_priority_selector',
    'editorselector'        => 'rcmail_editor_selector',
    'receiptcheckbox'       => 'rcmail_receipt_checkbox',
    'receiptcheckbox'       => 'rcmail_mdn_checkbox', // deprecated
    'mdncheckbox'           => 'rcmail_mdn_checkbox',
    'dsncheckbox'           => 'rcmail_dsn_checkbox',
    'storetarget'           => 'rcmail_store_target_selection',
    'addressbooks'          => 'rcmail_addressbook_list',
@@ -440,6 +460,9 @@

        // #1486037: remove "mailto:" prefix
        $COMPOSE['param']['to'] = preg_replace('/^mailto:/i', '', $mailto[0]);
        // #1490346: decode the recipient address
        // #1490510: use raw encoding for correct "+" character handling as specified in RFC6068
        $COMPOSE['param']['to'] = rawurldecode($COMPOSE['param']['to']);

        // Supported case-insensitive tokens in mailto URL
        $url_tokens = array('to', 'cc', 'bcc', 'reply-to', 'in-reply-to', 'references', 'subject', 'body');
@@ -602,8 +625,10 @@
    if (count($MESSAGE->identities)) {
        $a_signatures = array();
        $identities   = array();
        $separator    = intval($RCMAIL->config->get('reply_mode')) > 0
            && ($compose_mode == RCUBE_COMPOSE_REPLY || $compose_mode == RCUBE_COMPOSE_FORWARD) ? '---' : '-- ';
        $top_posting  = intval($RCMAIL->config->get('reply_mode')) > 0
            && !$RCMAIL->config->get('sig_below')
            && ($compose_mode == RCUBE_COMPOSE_REPLY || $compose_mode == RCUBE_COMPOSE_FORWARD);
        $separator = $top_posting ? '---' : '-- ';

        $field_attrib['onchange'] = rcmail_output::JS_OBJECT_NAME.".change_identity(this)";
        $select_from = new html_select($field_attrib);
@@ -618,21 +643,17 @@
                $text = $html = $sql_arr['signature'];

                if ($sql_arr['html_signature']) {
                    $h2t  = new rcube_html2text($sql_arr['signature'], false, true);
                    $text = trim($h2t->get_text());
                    $text = $RCMAIL->html2text($html, array('links' => false));
                    $text = trim($text);
                }
                else {
                    $html = htmlentities($html, ENT_NOQUOTES, RCUBE_CHARSET);
                    $t2h  = new rcube_text2html($text, false);
                    $html = $t2h->get_html();
                }

                if (!preg_match('/^--[ -]\r?\n/m', $text)) {
                    $text = $separator . "\n" . $text;
                    $html = $separator . "<br>" . $html;
                }

                if (!$sql_arr['html_signature']) {
                    $t2h  = new rcube_text2html($sql_arr['signature'], false);
                    $html = $t2h->get_html();
                }

                $a_signatures[$identity_id]['text'] = $text;
@@ -663,7 +684,6 @@

    return $out;
}


function rcmail_compose_editor_mode()
{
@@ -729,11 +749,9 @@

        if (!empty($MESSAGE->parts)) {
            // collect IDs of message/rfc822 parts
            if ($compose_mode == RCUBE_COMPOSE_EDIT || $compose_mode == RCUBE_COMPOSE_DRAFT) {
                foreach ($MESSAGE->attachments as $part) {
                    if ($part->mimetype == 'message/rfc822') {
                        $messages[] = $part->mime_id;
                    }
            foreach ($MESSAGE->mime_parts as $part) {
                if ($part->mimetype == 'message/rfc822') {
                    $messages[] = $part->mime_id;
                }
            }

@@ -743,7 +761,7 @@
                    continue;
                }

                // skip all content parts inside the message/rfc822 part in DRAFT/EDIT mode
                // skip all content parts inside the message/rfc822 part
                foreach ($messages as $mimeid) {
                    if (strpos($part->mime_id, $mimeid . '.') === 0) {
                        continue 2;
@@ -780,12 +798,13 @@
    unset($plugin);

    // add blocked.gif attachment (#1486516)
    if ($isHtml && preg_match('#<img src="\./program/resources/blocked\.gif"#', $body)) {
        if ($attachment = rcmail_save_image('program/resources/blocked.gif', 'image/gif')) {
    if ($isHtml && preg_match('#<img src="program/resources/blocked\.gif"#', $body)) {
        $content = $RCMAIL->get_resource_content('blocked.gif');
        if ($content && ($attachment = rcmail_save_image('blocked.gif', 'image/gif', $content))) {
            $COMPOSE['attachments'][$attachment['id']] = $attachment;
            $url = sprintf('%s&_id=%s&_action=display-attachment&_file=rcmfile%s',
                $RCMAIL->comm_path, $COMPOSE['id'], $attachment['id']);
            $body = preg_replace('#\./program/resources/blocked\.gif#', $url, $body);
            $body = preg_replace('#program/resources/blocked\.gif#', $url, $body);
        }
    }

@@ -839,9 +858,8 @@
        if ($part->ctype_secondary == 'html') {
            // use html part if it has been used for message (pre)viewing
            // decrease line length for quoting
            $len = $compose_mode == RCUBE_COMPOSE_REPLY ? $LINE_LENGTH-2 : $LINE_LENGTH;
            $txt = new rcube_html2text($body, false, true, $len);
            $body = $txt->get_text();
            $len  = $compose_mode == RCUBE_COMPOSE_REPLY ? $LINE_LENGTH-2 : $LINE_LENGTH;
            $body = $RCMAIL->html2text($body, array('width' => $len));
        }
        else {
            if ($part->ctype_secondary == 'plain' && $part->ctype_parameters['format'] == 'flowed') {
@@ -1024,7 +1042,7 @@
            $suffix = '</blockquote>';
        }
        else {
            $suffix = '</blockquote><p></p>';
            $suffix = '</blockquote><p><br/></p>';
        }
    }

@@ -1159,6 +1177,10 @@
    $messages = array();

    foreach ((array)$message->mime_parts as $pid => $part) {
        if ($part->mimetype == 'message/rfc822') {
            $messages[] = $part->mime_id;
        }

        if ($part->disposition == 'attachment' || ($part->disposition == 'inline' && $bodyIsHtml) || $part->filename) {
            // skip parts that aren't valid attachments
            if ($part->ctype_primary == 'multipart' || $part->mimetype == 'application/ms-tnef') {
@@ -1175,23 +1197,10 @@
                continue;
            }

            // skip message/rfc822 attachments on forwards (#1489214)
            // Thunderbird when forwarding in inline mode displays such attachments
            // and skips any attachments from inside of such part, this however
            // skipped e.g. images used in HTML body or other attachments. So,
            // better to skip .eml attachments but not their content (included files).
            if ($part->mimetype == 'message/rfc822') {
                if ($compose_mode == RCUBE_COMPOSE_FORWARD) {
                    continue;
                }
                $messages[] = $part->mime_id;
            }
            else if ($compose_mode != RCUBE_COMPOSE_FORWARD) {
                // skip attachments included in message/rfc822 attachment (#1486487)
                foreach ($messages as $mimeid) {
                    if (strpos($part->mime_id, $mimeid . '.') === 0) {
                        continue 2;
                    }
            // skip attachments included in message/rfc822 attachment (#1486487, #1490607)
            foreach ($messages as $mimeid) {
                if (strpos($part->mime_id, $mimeid . '.') === 0) {
                    continue 2;
                }
            }

@@ -1223,9 +1232,22 @@
{
    global $RCMAIL, $COMPOSE;

    $cid_map = array();
    $cid_map  = array();
    $messages = array();

    foreach ((array)$message->mime_parts as $pid => $part) {
        if ($part->mimetype == 'message/rfc822') {
            $messages[] = $part->mime_id;
        }

        if (($part->content_id || $part->content_location) && $part->filename) {
            // skip attachments included in message/rfc822 attachment (#1486487, #1490607)
            foreach ($messages as $mimeid) {
                if (strpos($part->mime_id, $mimeid . '.') === 0) {
                    continue 2;
                }
            }

            if ($attachment = rcmail_save_attachment($message, $pid)) {
                $COMPOSE['attachments'][$attachment['id']] = $attachment;
                $url = sprintf('%s&_id=%s&_action=display-attachment&_file=rcmfile%s',
@@ -1399,18 +1421,31 @@
    return false;
}

function rcmail_save_image($path, $mimetype='')
function rcmail_save_image($path, $mimetype = '', $data = null)
{
    global $COMPOSE;

    // handle attachments in memory
    $data = file_get_contents($path);
    if (empty($data)) {
        $data    = file_get_contents($path);
        $is_file = true;
    }

    $name = rcmail_basename($path);

    if (empty($mimetype)) {
        if ($is_file) {
            $mimetype = rcube_mime::file_content_type($path, $name);
        }
        else {
            $mimetype = rcube_mime::file_content_type($data, $name, 'application/octet-stream', true);
        }
    }

    $attachment = array(
        'group'    => $COMPOSE['id'],
        'name'     => $name,
        'mimetype' => $mimetype ? $mimetype : rcube_mime::file_content_type($path, $name),
        'mimetype' => $mimetype,
        'data'     => $data,
        'size'     => strlen($data),
    );
@@ -1494,15 +1529,14 @@
    if (!$attrib['id'])
        $attrib['id'] = 'rcmAttachmentList';

    $out       = "\n";
    $jslist    = array();
    $button    = '';
    $skin_path = $RCMAIL->config->get('skin_path');
    $out    = "\n";
    $jslist = array();
    $button = '';

    if (is_array($COMPOSE['attachments'])) {
        if ($attrib['deleteicon']) {
            $button = html::img(array(
                'src' => $skin_path . $attrib['deleteicon'],
                'src' => $RCMAIL->output->abs_url($attrib['deleteicon'], true),
                'alt' => $RCMAIL->gettext('delete')
            ));
        }
@@ -1541,13 +1575,13 @@
    }

    if ($attrib['deleteicon'])
        $COMPOSE['deleteicon'] = $skin_path . $attrib['deleteicon'];
        $COMPOSE['deleteicon'] = $RCMAIL->output->abs_url($attrib['deleteicon'], true);
    else if (rcube_utils::get_boolean($attrib['textbuttons']))
        $COMPOSE['textbuttons'] = true;
    if ($attrib['cancelicon'])
        $OUTPUT->set_env('cancelicon', $skin_path . $attrib['cancelicon']);
        $OUTPUT->set_env('cancelicon', $RCMAIL->output->abs_url($attrib['cancelicon'], true));
    if ($attrib['loadingicon'])
        $OUTPUT->set_env('loadingicon', $skin_path . $attrib['loadingicon']);
        $OUTPUT->set_env('loadingicon', $RCMAIL->output->abs_url($attrib['loadingicon'], true));

    $OUTPUT->set_env('attachments', $jslist);
    $OUTPUT->add_gui_object('attachmentlist', $attrib['id']);
@@ -1643,7 +1677,7 @@
}


function rcmail_receipt_checkbox($attrib)
function rcmail_mdn_checkbox($attrib)
{
    global $RCMAIL, $MESSAGE, $compose_mode;

@@ -1653,13 +1687,13 @@
    if (!isset($attrib['id']))
        $attrib['id'] = 'receipt';

    $attrib['name']  = '_receipt';
    $attrib['name']  = '_mdn';
    $attrib['value'] = '1';

    $checkbox = new html_checkbox($attrib);

    if (isset($_POST['_receipt']))
        $mdn_default = $_POST['_receipt'];
    if (isset($_POST['_mdn']))
        $mdn_default = $_POST['_mdn'];
    else if (in_array($compose_mode, array(RCUBE_COMPOSE_DRAFT, RCUBE_COMPOSE_EDIT)))
        $mdn_default = (bool) $MESSAGE->headers->mdn_to;
    else