Backported the canned responses feature to the 0.9 release series

Thomas

2013-10-07 8c985e87d6d6b494c57c2f98371985cc591c39ff

Backported the canned responses feature to the 0.9 release series

 config/main.inc.php.dist

@@ -536,6 +536,12 @@
// Setting it to 0, disables the feature.
$rcmail_config['undo_timeout'] = 0;

// A static list of canned responses which are immutable for the user
$rcmail_config['compose_responses_static'] = array(
//  array('name' => 'Canned Response 1', 'text' => 'Static Response One'),
//  array('name' => 'Canned Response 2', 'text' => 'Static Response Two'),
);

// ----------------------------------
// ADDRESSBOOK SETTINGS
// ----------------------------------

 program/include/rcmail.php

@@ -341,6 +341,44 @@
    return $list;
  }

  /**
   * Getter for compose responses.
   * These are stored in local config and user preferences.
   *
   * @param boolean True to sort the list alphabetically
   * @param boolean True if only this user's responses shall be listed
   * @return array List of the current user's stored responses
   */
  public function get_compose_responses($sorted = false, $user_only = false)
  {
    $responses = array();

    if (!$user_only) {
      foreach ($this->config->get('compose_responses_static', array()) as $response) {
        if (empty($response['key']))
          $response['key'] = substr(md5($response['name']), 0, 16);
        $response['static'] = true;
        $response['class'] = 'readonly';
        $k = $sorted ? '0000-' . strtolower($response['name']) : $response['key'];
        $responses[$k] = $response;
      }
    }

    foreach ($this->config->get('compose_responses', array()) as $response) {
      if (empty($response['key']))
        $response['key'] = substr(md5($response['name']), 0, 16);
      $k = $sorted ? strtolower($response['name']) : $response['key'];
      $responses[$k] = $response;
    }

    // sort list by name
    if ($sorted) {
      ksort($responses, SORT_LOCALE_STRING);
    }

    return array_values($responses);
  }


  /**
   * Init output object for GUI and add common scripts.

 program/include/rcmail_output_html.php

@@ -1176,7 +1176,7 @@

        // generate html code for button
        if ($btn_content) {
            $attrib_str = html::attrib_string($attrib, $link_attrib);
            $attrib_str = html::attrib_string($attrib, array_merge(html::$common_attrib, $link_attrib));
            $out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content);
        }


 program/js/app.js

@@ -251,12 +251,14 @@
          }
        }
        else if (this.env.action == 'compose') {
          this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor', 'list-adresses', 'search', 'reset-search', 'extwin'];
          this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel',
            'toggle-editor', 'list-adresses', 'search', 'reset-search', 'extwin',
            'insert-response', 'save-response'];

          if (this.env.drafts_mailbox)
            this.env.compose_commands.push('savedraft')

          this.enable_command(this.env.compose_commands, 'identities', true);
          this.enable_command(this.env.compose_commands, 'identities', 'responses', true);

          // add more commands (not enabled)
          $.merge(this.env.compose_commands, ['add-recipient', 'firstpage', 'previouspage', 'nextpage', 'lastpage']);
@@ -265,6 +267,23 @@
            this.env.spellcheck.spelling_state_observer = function(s) { ref.spellcheck_state(); };
            this.env.compose_commands.push('spellcheck')
            this.enable_command('spellcheck', true);
          }

          // init canned response functions
          if (this.gui_objects.responseslist) {
            $('a.insertresponse', this.gui_objects.responseslist)
              .attr('unselectable', 'on')
              .mousedown(function(e){ return rcube_event.cancel(e); })
              .mouseup(function(e){
                ref.command('insert-response', $(this).attr('rel'));
                $(document.body).trigger('mouseup');  // hides the menu
                return rcube_event.cancel(e);
              });

              // avoid textarea loosing focus when hitting the save-response button/link
              for (var i=0; this.buttons['save-response'] && i < this.buttons['save-response'].length; i++) {
                $('#'+this.buttons['save-response'][i].id).mousedown(function(e){ return rcube_event.cancel(e); })
              }
          }

          document.onmouseup = function(e){ return p.doc_mouse_up(e); };
@@ -371,7 +390,7 @@
        break;

      case 'settings':
        this.enable_command('preferences', 'identities', 'save', 'folders', true);
        this.enable_command('preferences', 'identities', 'responses', 'save', 'folders', true);

        if (this.env.action == 'identities') {
          this.enable_command('add', this.env.identities_level < 2);
@@ -392,6 +411,9 @@
          parent.rcmail.enable_command('purge', this.env.messagecount);
          $("input[type='text']").first().select();
        }
        else if (this.env.action == 'responses') {
          this.enable_command('add', true);
        }

        if (this.gui_objects.identitieslist) {
          this.identity_list = new rcube_list_widget(this.gui_objects.identitieslist, {multiselect:false, draggable:false, keyboard:false});
@@ -408,8 +430,22 @@
          this.sections_list.init();
          this.sections_list.focus();
        }
        else if (this.gui_objects.subscriptionlist)
        else if (this.gui_objects.subscriptionlist) {
          this.init_subscription_list();
        }
        else if (this.gui_objects.responseslist) {
          this.responses_list = new rcube_list_widget(this.gui_objects.responseslist, {multiselect:false, draggable:false, keyboard:false});
          this.responses_list.addEventListener('select', function(list){
            var win, id = list.get_single_selection();
            p.enable_command('delete', !!id && $.inArray(id, p.env.readonly_responses) < 0);
            if (id && (win = p.get_frame_window(p.env.contentframe))) {
              p.set_busy(true);
              p.location_href({ _action:'edit-response', _key:id, _framed:1 }, win);
            }
          });
          this.responses_list.init();
          this.responses_list.focus();
        }

        break;

@@ -683,6 +719,13 @@
      case 'add':
        if (this.task == 'addressbook')
          this.load_contact(0, 'add');
        else if (this.task == 'settings' && this.env.action == 'responses') {
          var frame;
          if ((frame = this.get_frame_window(this.env.contentframe))) {
            this.set_busy(true);
            this.location_href({ _action:'add-response', _framed:1 }, frame);
          }
        }
        else if (this.task == 'settings') {
          this.identity_list.clear_selection();
          this.load_identity(0, 'add-identity');
@@ -746,7 +789,10 @@
        // addressbook task
        else if (this.task == 'addressbook')
          this.delete_contacts();
        // user settings task
        // settings: canned response
        else if (this.task == 'settings' && this.env.action == 'responses')
          this.delete_response();
        // settings: user identities
        else if (this.task == 'settings')
          this.delete_identity();
        break;
@@ -1104,6 +1150,7 @@
      // user settings commands
      case 'preferences':
      case 'identities':
      case 'responses':
      case 'folders':
        this.goto_url('settings/' + command);
        break;
@@ -3283,6 +3330,154 @@
    return true;
  };

  this.insert_response = function(key)
  {
    var insert = this.env.textresponses[key] ? this.env.textresponses[key].text : null;
    if (!insert)
      return false;

    // insert into tinyMCE editor
    if ($("input[name='_is_html']").val() == '1') {
      var editor = tinyMCE.get(this.env.composebody);
      editor.getWin().focus(); // correct focus in IE & Chrome
      editor.selection.setContent(insert, { format:'text' });
    }
    // replace selection in compose textarea
    else {
      var textarea = rcube_find_object(this.env.composebody),
        selection = $(textarea).is(':focus') ? this.get_input_selection(textarea) : { start:0, end:0 },
        inp_value = textarea.value;
        pre = inp_value.substring(0, selection.start),
        end = inp_value.substring(selection.end, inp_value.length);

      // insert response text
      textarea.value = pre + insert + end;

      // set caret after inserted text
      this.set_caret_pos(textarea, selection.start + insert.length);
      textarea.focus();
    }
  };

  /**
   * Open the dialog to save a new canned response
   */
  this.save_response = function()
  {
    var sigstart, text = '', strip = false;

    // get selected text from tinyMCE editor
    if ($("input[name='_is_html']").val() == '1') {
      var editor = tinyMCE.get(this.env.composebody);
      editor.getWin().focus(); // correct focus in IE & Chrome
      text = editor.selection.getContent({ format:'text' });

      if (!text) {
        text = editor.getContent({ format:'text' });
        strip = true;
      }
    }
    // get selected text from compose textarea
    else {
      var textarea = rcube_find_object(this.env.composebody), sigstart;
      if (textarea && $(textarea).is(':focus')) {
        text = this.get_input_selection(textarea).text;
      }

      if (!text && textarea) {
        text = textarea.value;
        strip = true;
      }
    }

    // strip off signature
    if (strip) {
      sigstart = text.indexOf('-- \n');
      if (sigstart > 0) {
        text = text.substring(0, sigstart);
      }
    }

    // show dialog to enter a name and to modify the text to be saved
    var buttons = {},
      html = '<form class="propform">' +
      '<div class="prop block"><label>' + this.get_label('responsename') + '</label>' +
      '<input type="text" name="name" id="ffresponsename" size="40" /></div>' +
      '<div class="prop block"><label>' + this.get_label('responsetext') + '</label>' +
      '<textarea name="text" id="ffresponsetext" cols="40" rows="8"></textarea></div>' +
      '</form>';

    buttons[this.gettext('save')] = function(e) {
      var name = $('#ffresponsename').val(),
        text = $('#ffresponsetext').val();

      if (!text) {
        $('#ffresponsetext').select();
        return false;
      }
      if (!name)
        name = text.substring(0,40);

      var lock = ref.display_message(ref.get_label('savingresponse'), 'loading');
      ref.http_post('settings/responses', { _insert:1, _name:name, _text:text }, lock);
      $(this).dialog('close');
    };

    buttons[this.gettext('cancel')] = function() {
      $(this).dialog('close');
    };

    this.show_popup_dialog(html, this.gettext('savenewresponse'), buttons);

    $('#ffresponsetext').val(text);
    $('#ffresponsename').select();
  };

  this.add_response_item = function(response)
  {
    var key = response.key;
    this.env.textresponses[key] = response;

    // append to responses list
    if (this.gui_objects.responseslist) {
      var li = $('<li>').appendTo(this.gui_objects.responseslist);
      $('<a>').addClass('insertresponse active')
        .attr('href', '#')
        .attr('rel', key)
        .html(this.quote_html(response.name))
        .appendTo(li)
        .mousedown(function(e){
          return rcube_event.cancel(e);
        })
        .mouseup(function(e){
          ref.command('insert-response', key);
          $(document.body).trigger('mouseup');  // hides the menu
          return rcube_event.cancel(e);
        });
    }
  };

  this.edit_responses = function()
  {
    // TODO: implement inline editing of responses
  };

  this.delete_response = function(key)
  {
    if (!key && this.responses_list) {
      var selection = this.responses_list.get_selection();
      key = selection[0];
    }

    // submit delete request
    if (key && confirm(this.get_label('deleteresponseconfirm'))) {
      this.http_post('settings/delete-response', { _key: key }, false);
      return true;
    }

    return false;
  };

  this.stop_spellchecking = function()
  {
    var ed;
@@ -5117,6 +5312,42 @@
    }
  };

  this.update_response_row = function(response, oldkey)
  {
    var row, col, list = this.responses_list;

    if (list && oldkey && list.rows[oldkey] && (row = list.rows[oldkey].obj)) {
      $(row.cells[0]).html(response.name);
      // update references because the key likely changed
      row.id = 'rcmrow'+response.key;
      list.init_row(row);
      list.select(response.key);
      delete list.rows[oldkey];
    }
    else if (list) {
      row = $('<tr>').attr('id', 'rcmrow'+response.key).get(0);
      col = $('<td>').addClass('name').html(response.name).appendTo(row);
      list.insert_row(row);
      list.select(response.key);
    }
  };

  this.remove_response = function(key)
  {
    var frame;

    if (this.env.textresponses) {
      delete this.env.textresponses[key];
    }

    if (this.responses_list) {
      this.responses_list.remove_row(key);
      if (this.env.contentframe && (frame = this.get_frame_window(this.env.contentframe))) {
        frame.location.href = this.env.blankpage;
      }
    }
  };


  /*********************************************************/
  /*********        folder manager methods         *********/
@@ -5795,7 +6026,7 @@
  };

  // open a jquery UI dialog with the given content
  this.show_popup_dialog = function(html, title)
  this.show_popup_dialog = function(html, title, buttons)
  {
    // forward call to parent window
    if (this.is_framed()) {
@@ -5807,6 +6038,7 @@
      .html(html)
      .dialog({
        title: title,
        buttons: buttons,
        modal: true,
        resizable: true,
        width: 580,
@@ -5816,7 +6048,7 @@
      // resize and center popup
      var win = $(window), w = win.width(), h = win.height(),
        width = popup.width(), height = popup.height();
      popup.dialog('option', { height: Math.min(h-40, height+50), width: Math.min(w-20, width+50) })
      popup.dialog('option', { height: Math.min(h-40, height+75 + (buttons ? 50 : 0)), width: Math.min(w-20, width+50) })
        .dialog('option', 'position', ['center', 'center']);  // only works in a separate call (!?)
  };

@@ -6657,6 +6889,14 @@
  /*********            helper methods            *********/
  /********************************************************/

  /**
   * Quote html entities
   */
  this.quote_html = function(str)
  {
    return String(str).replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
  };

  // get window.opener.rcmail if available
  this.opener = function()
  {
@@ -6721,6 +6961,57 @@
    }
  };

  // get selected text from an input field
  // http://stackoverflow.com/questions/7186586/how-to-get-the-selected-text-in-textarea-using-jquery-in-internet-explorer-7
  this.get_input_selection = function(obj)
  {
    var start = 0, end = 0,
      normalizedValue, range,
      textInputRange, len, endRange;

    if (typeof obj.selectionStart == "number" && typeof obj.selectionEnd == "number") {
      normalizedValue = obj.value;
      start = obj.selectionStart;
      end = obj.selectionEnd;
    }
    else {
      range = document.selection.createRange();

      if (range && range.parentElement() == obj) {
        len = obj.value.length;
        normalizedValue = obj.value; //.replace(/\r\n/g, "\n");

        // create a working TextRange that lives only in the input
        textInputRange = obj.createTextRange();
        textInputRange.moveToBookmark(range.getBookmark());

        // Check if the start and end of the selection are at the very end
        // of the input, since moveStart/moveEnd doesn't return what we want
        // in those cases
        endRange = obj.createTextRange();
        endRange.collapse(false);

        if (textInputRange.compareEndPoints("StartToEnd", endRange) > -1) {
          start = end = len;
        }
        else {
          start = -textInputRange.moveStart("character", -len);
          start += normalizedValue.slice(0, start).split("\n").length - 1;

          if (textInputRange.compareEndPoints("EndToEnd", endRange) > -1) {
            end = len;
          }
          else {
            end = -textInputRange.moveEnd("character", -len);
            end += normalizedValue.slice(0, end).split("\n").length - 1;
          }
        }
      }
    }

    return { start:start, end:end, text:normalizedValue.substr(start, end-start) };
  };

  // disable/enable all fields of a form
  this.lock_form = function(form, lock)
  {

 program/lib/Roundcube/html.php

@@ -3,7 +3,7 @@
/*
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
 | Copyright (C) 2005-2013, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
@@ -32,8 +32,8 @@

    public static $doctype = 'xhtml';
    public static $lc_tags = true;
    public static $common_attrib = array('id','class','style','title','align');
    public static $containers = array('iframe','div','span','p','h1','h2','h3','form','textarea','table','thead','tbody','tr','th','td','style','script');
    public static $common_attrib = array('id','class','style','title','align','unselectable');
    public static $containers = array('iframe','div','span','p','h1','h2','h3','ul','form','textarea','table','thead','tbody','tr','th','td','style','script');


    /**

 program/lib/Roundcube/rcube_user.php

@@ -163,8 +163,16 @@
        if (!$this->ID)
            return false;

        $config    = $this->rc->config;
        $old_prefs = (array)$this->get_prefs();
        $plugin = $this->rc->plugins->exec_hook('preferences_update', array(
            'userid' => $this->ID, 'prefs' => $a_user_prefs, 'old' => (array)$this->get_prefs()));

        if (!empty($plugin['abort'])) {
            return;
        }

        $a_user_prefs = $plugin['prefs'];
        $old_prefs    = $plugin['old'];
        $config       = $this->rc->config;

        // merge (partial) prefs array with existing settings
        $save_prefs = $a_user_prefs + $old_prefs;

 program/localization/en_US/labels.inc

@@ -224,6 +224,15 @@
$labels['resumeediting'] = 'Resume editing';
$labels['revertto']      = 'Revert to';

$labels['responses'] = 'Responses';
$labels['insertresponse'] = 'Insert a response';
$labels['manageresponses'] = 'Manage responses';
$labels['savenewresponse'] = 'Save new response';
$labels['editresponses'] = 'Edit responses';
$labels['editresponse'] = 'Edit response';
$labels['responsename'] = 'Name';
$labels['responsetext'] = 'Response Text';

$labels['attach'] = 'Attach';
$labels['attachments'] = 'Attachments';
$labels['upload'] = 'Upload';

 program/localization/en_US/messages.inc

@@ -44,6 +44,8 @@
$messages['savingmessage'] = 'Saving message...';
$messages['messagesaved'] = 'Message saved to Drafts.';
$messages['successfullysaved'] = 'Successfully saved.';
$messages['savingresponse'] = 'Saving response text...';
$messages['deleteresponseconfirm'] = 'Do you really want to delete this response text?';
$messages['addedsuccessfully'] = 'Contact added successfully to address book.';
$messages['contactexists'] = 'A contact with the same e-mail address already exists.';
$messages['contactnameexists'] = 'A contact with the same name already exists.';

 program/steps/mail/compose.inc

@@ -127,7 +127,8 @@
$OUTPUT->add_label('nosubject', 'nosenderwarning', 'norecipientwarning', 'nosubjectwarning', 'cancel',
    'nobodywarning', 'notsentwarning', 'notuploadedwarning', 'savingmessage', 'sendingmessage', 
    'messagesaved', 'converting', 'editorwarning', 'searching', 'uploading', 'uploadingmany',
    'fileuploaderror', 'sendmessage');
    'fileuploaderror', 'sendmessage', 'savenewresponse', 'responsename', 'responsetext', 'save',
    'savingresponse');

$OUTPUT->set_env('compose_id', $COMPOSE['id']);
$OUTPUT->set_pagetitle(rcube_label('compose'));
@@ -1684,6 +1685,38 @@
}


/**
 *
 */
function rcmail_compose_responses_list($attrib)
{
    global $RCMAIL, $OUTPUT;

    $attrib += array('id' => 'rcmresponseslist', 'tagname' => 'ul', 'cols' => 1);

    $jsenv = array();
    $list = array();
    foreach ($RCMAIL->get_compose_responses(true) as $response) {
        $key = $response['key'];
        $item = html::a(array(
            'href '=> '#'.urlencode($response['name']),
            'class' => rtrim('insertresponse ' . $attrib['itemclass']),
            'unselectable' => 'on',
            'rel' => $key,
        ), Q($response['name']));

        $jsenv[$key] = $response;
        $list[] = html::tag('li', null, html::span(null, $item));
    }

    // set client env
    $OUTPUT->set_env('textresponses', $jsenv);
    $OUTPUT->add_gui_object('responseslist', $attrib['id']);

    return html::tag('ul', $attrib, join("\n", $list));
}


// register UI objects
$OUTPUT->add_handlers(array(
  'composeheaders' => 'rcmail_compose_headers',
@@ -1700,6 +1733,7 @@
  'storetarget' => 'rcmail_store_target_selection',
  'addressbooks' => 'rcmail_addressbook_list',
  'addresslist' => 'rcmail_contacts_list',
  'responseslist' => 'rcmail_compose_responses_list',
));

$OUTPUT->send('compose');

 program/steps/settings/edit_response.inc

New file
@@ -0,0 +1,107 @@
<?php

/*
 +-----------------------------------------------------------------------+
 | program/steps/settings/edit_response.inc                              |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2013, The Roundcube Dev Team                            |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
 | See the README file for a full license statement.                     |
 |                                                                       |
 | PURPOSE:                                                              |
 |   Show edit form for a canned response record or to add a new one     |
 |                                                                       |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+
*/

$responses = $RCMAIL->get_compose_responses();

// edit-response
if (($key = get_input_value('_key', RCUBE_INPUT_GPC))) {
    foreach ($responses as $i => $response) {
        if ($response['key'] == $key) {
            $RESPONSE_RECORD = $response;
            $RESPONSE_RECORD['index'] = $i;
            break;
        }
    }
}

// save response
if ($RCMAIL->action == 'save-response' && isset($_POST['_name']) && !$RESPONSE_RECORD['static']) {
    $name = trim(get_input_value('_name', RCUBE_INPUT_POST));
    $text = trim(get_input_value('_text', RCUBE_INPUT_POST));

    if (!empty($name) && !empty($text)) {
        $dupes = 0;
        foreach ($responses as $i => $resp) {
            if ($RESPONSE_RECORD && $RESPONSE_RECORD['index'] === $i)
                continue;
            if (strcasecmp($name, preg_replace('/\s\(\d+\)$/', '', $resp['name'])) == 0)
                $dupes++;
        }
        if ($dupes) {  // require a unique name
            $name .= ' (' . ++$dupes . ')';
        }

        $response = array('name' => $name, 'text' => $text, 'format' => 'text', 'key' => substr(md5($name), 0, 16));
        if ($RESPONSE_RECORD && $responses[$RESPONSE_RECORD['index']]) {
            $responses[$RESPONSE_RECORD['index']] = $response;
        }
        else {
            $responses[] = $response;
        }

        $responses = array_filter($responses, function($item){ return empty($item['static']); });
        if ($RCMAIL->user->save_prefs(array('compose_responses' => array_values($responses)))) {
            $RCMAIL->output->show_message('successfullysaved', 'confirmation');
            $RCMAIL->output->command('parent.update_response_row', $response, $key);
            $RCMAIL->overwrite_action('edit-response');
            $RESPONSE_RECORD = $response;
        }
    }
    else {
        $RCMAIL->output->show_message('formincomplete', 'error');
    }
}


function rcube_response_form($attrib)
{
    global $RCMAIL, $OUTPUT, $RESPONSE_RECORD;

    // Set form tags and hidden fields
    $disabled = !empty($RESPONSE_RECORD['static']);
    $key = $RESPONSE_RECORD['key'];
    list($form_start, $form_end) = get_form_tags($attrib, 'save-response', $key, array('name' => '_key', 'value' => $key));
    unset($attrib['form'], $attrib['id']);

    // return the complete edit form as table
    $out = "$form_start\n";

    $table = new html_table(array('cols' => 2));
    $label = rcube_label('responsename');

    $table->add('title', html::label('ffname', Q(rcube_label('responsename'))));
    $table->add(null, rcube_output::get_edit_field('name', $RESPONSE_RECORD['name'], array('id' => 'ffname', 'size' => $attrib['size'], 'disabled' => $disabled), 'text'));

    $table->add('title', html::label('fftext', Q(rcube_label('responsetext'))));
    $table->add(null, rcube_output::get_edit_field('text', $RESPONSE_RECORD['text'], array('id' => 'fftext', 'size' => $attrib['textareacols'], 'rows' => $attrib['textarearows'], 'disabled' => $disabled), 'textarea'));

    $out .= $table->show($attrib);
    $out .= $form_end;

    return $out;
}

$OUTPUT->set_env('readonly', !empty($RESPONSE_RECORD['static']));
$OUTPUT->add_handler('responseform', 'rcube_response_form');
$OUTPUT->set_pagetitle(rcube_label(($RCMAIL->action=='add-response' ? 'savenewresponse' : 'editresponse')));

$OUTPUT->send('responseedit');


 program/steps/settings/func.inc

@@ -992,4 +992,7 @@
    'purge'         => 'folders.inc',
    'folder-size'   => 'folders.inc',
    'add-identity'  => 'edit_identity.inc',
    'add-response'  => 'edit_response.inc',
    'save-response' => 'edit_response.inc',
    'delete-response' => 'responses.inc',
));

 program/steps/settings/responses.inc

New file
@@ -0,0 +1,128 @@
<?php

/*
 +-----------------------------------------------------------------------+
 | program/steps/settings/responses.inc                                  |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2013, The Roundcube Dev Team                            |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
 | See the README file for a full license statement.                     |
 |                                                                       |
 | PURPOSE:                                                              |
 |   Manage and save canned response texts                               |
 |                                                                       |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+
*/


if (!empty($_POST['_insert'])) {
    $name = trim(get_input_value('_name', RCUBE_INPUT_POST));
    $text = trim(get_input_value('_text', RCUBE_INPUT_POST));

    if (!empty($name) && !empty($text)) {
        $dupes = 0;
        $responses = $RCMAIL->get_compose_responses(false, true);
        foreach ($responses as $resp) {
            if (strcasecmp($name, preg_replace('/\s\(\d+\)$/', '', $resp['name'])) == 0)
                $dupes++;
        }
        if ($dupes) {  // require a unique name
            $name .= ' (' . ++$dupes . ')';
        }

        $response = array('name' => $name, 'text' => $text, 'format' => 'text', 'key' => substr(md5($name), 0, 16));
        $responses[] = $response;

        if ($RCMAIL->user->save_prefs(array('compose_responses' => $responses))) {
            $RCMAIL->output->command('add_response_item', $response);
            $RCMAIL->output->command('display_message', rcube_label('successfullysaved'), 'confirmation');
        }
        else {
            $RCMAIL->output->command('display_message', rcube_label('errorsaving'), 'error');
        }
    }

    // send response
    $RCMAIL->output->send();
}


if ($RCMAIL->action == 'delete-response') {
    if ($key = get_input_value('_key', RCUBE_INPUT_GPC)) {
        $responses = $RCMAIL->get_compose_responses(false, true);
        foreach ($responses as $i => $response) {
            if (empty($response['key']))
                $response['key'] = substr(md5($response['name']), 0, 16);
            if ($response['key'] == $key) {
                unset($responses[$i]);
                $deleted = $RCMAIL->user->save_prefs(array('compose_responses' => $responses));
                break;
            }
        }
    }

    if ($deleted) {
        $RCMAIL->output->command('display_message', rcube_label('deletedsuccessfully'), 'confirmation');
        $RCMAIL->output->command('remove_response', $key);
    }

    if ($RCMAIL->output->ajax_call) {
        $RCMAIL->output->send();
    }
}


$OUTPUT->set_pagetitle(rcube_label('responses'));
$OUTPUT->include_script('list.js');


/**
 *
 */
function rcmail_responses_list($attrib)
{
    global $RCMAIL, $OUTPUT;

    $attrib += array('id' => 'rcmresponseslist', 'tagname' => 'table', 'cols' => 1);

    $plugin = $RCMAIL->plugins->exec_hook('responses_list', array(
        'list' => $RCMAIL->get_compose_responses(true),
        'cols' => array('name')
    ));

    $out = rcube_table_output($attrib, $plugin['list'], $plugin['cols'], 'key');

    // set client env
    $OUTPUT->add_gui_object('responseslist', $attrib['id']);
    $OUTPUT->set_env('readonly_responses', array_values(array_map(function($rec){ return $rec['key']; },
      array_filter($plugin['list'], function($item){ return !empty($item['static']); }))));

    return $out;
}


// similar function as /steps/addressbook/func.inc::rcmail_contact_frame()
function rcmail_response_frame($attrib)
{
    global $OUTPUT;

    if (!$attrib['id']) {
        $attrib['id'] = 'rcmResponseFrame';
    }

    $OUTPUT->set_env('contentframe', $attrib['id']);
    return $OUTPUT->frame($attrib, true);
}

$OUTPUT->add_handlers(array(
    'responseframe' => 'rcmail_response_frame',
    'responseslist' => 'rcmail_responses_list',
));
$OUTPUT->add_label('deleteresponseconfirm');

$OUTPUT->send('responses');

 skins/classic/common.css

@@ -502,7 +502,8 @@
  margin: 3px -4px;
}

.popupmenu li a
.popupmenu li a,
.popupmenu li label
{
  display: block;
  color: #a0a0a0;
@@ -510,6 +511,14 @@
  text-decoration: none;
  min-height: 14px;
  background: transparent;
}

.popupmenu li label.comment
{
  color: #999;
  font-style: italic;
  padding-top: 4px;
  padding-bottom: 3px;
}

.popupmenu li a.active,
@@ -668,6 +677,24 @@
  border: none;
}

.propform div.prop
{
  margin-bottom: 0.5em;
}

.propform div.prop.block label
{
  display: block;
  margin-bottom: 2px;
}

.propform div.prop.block input,
.propform div.prop.block textarea
{
  width: 97%;
}


/***** roundcube webmail pre-defined classes *****/

#rcmversion

 skins/classic/images/mail_toolbar.png

 skins/classic/includes/settingstabs.html

@@ -2,6 +2,7 @@
<span id="settingstabdefault" class="tablink"><roundcube:button command="preferences" type="link" label="preferences" title="editpreferences" /></span>
<span id="settingstabfolders" class="tablink"><roundcube:button command="folders" type="link" label="folders" title="managefolders" class="tablink" /></span>
<span id="settingstabidentities" class="tablink"><roundcube:button command="identities" type="link" label="identities" title="manageidentities" class="tablink" /></span>
<span id="settingstabresponses" class="tablink"><roundcube:button command="responses" type="link" label="responses" title="editresponses" class="tablink" /></span>
<span id="settingstababout" class="tablink"><roundcube:button command="about" type="link" label="about" title="about" class="tablink" /></span>
<roundcube:container name="tabs" id="tabsbar" />
<script type="text/javascript"> if (window.rcmail) rcmail.add_onload(rcube_init_settings_tabs); </script>

 skins/classic/mail.css

@@ -155,6 +155,10 @@
  background-position: -416px -32px;
}

#messagetoolbar a.responses {
  background-position: -512px 0;
}

#messagetoolbar select.mboxlist
{
  position: relative;

 skins/classic/settings.css

@@ -34,6 +34,11 @@
  height: 18px;
}

#identities-table tbody tr.readonly td
{
  font-style: italic;
}

#subscription-table tr.virtual td
{
  color: #666;
@@ -81,10 +86,19 @@
}

#identity-details table td.title,
#response-details table td.title,
#folder-details table td.title
{
  font-weight: bold;
  text-align: right;
}

#response-details table td.title
{
  text-align: left;
  vertical-align: top;
  width: 140px;
  padding-top: 5px;
}

#bottomboxes
@@ -147,6 +161,12 @@
  float: right;
}

#formfooter .footerindent
{
  padding: 10px 0;
  margin-left: 155px;
}

#quota
{
  position: absolute;

 skins/classic/templates/compose.html

@@ -40,6 +40,7 @@
        <span id="spellmenulink" onclick="rcmail_ui.show_popup('spellmenu');return false"></span>
    </span>
<roundcube:endif />
    <a href="#responses" class="button responses" label="responses" title="<roundcube:label name='insertresponse' />" id="responsesmenulink" unselectable="on" onmousedown="return false" onclick="rcmail_ui.show_popup('responsesmenu');return false">&nbsp;</a>
    <roundcube:container name="toolbar" id="compose-toolbar" />
    <roundcube:button name="messageoptions" id="composemenulink" type="link" class="button messagemenu" title="messageoptions" onclick="rcmail_ui.show_popup('composemenu', true);return false" content=" " />
</div>
@@ -198,6 +199,16 @@
    </table>
</div>

<div id="responsesmenu" class="popupmenu">
    <ul id="textresponsesmenu">
        <li><label class="comment"><roundcube:label name="insertresponse" /></label></li>
        <roundcube:object name="responseslist" id="responseslist" tagname="ul" itemclass="active" />
        <li><label class="comment"><roundcube:label name="manageresponses" /></label></li>
        <li><roundcube:button command="save-response" type="link" label="savenewresponse" classAct="active" unselectable="on" /></li>
        <li><roundcube:button command="responses" type="link" label="editresponses" classAct="active" /></li>
    </ul>
</div>

<div id="spellmenu" class="popupmenu selectable"></div>

</form>

 skins/classic/templates/responseedit.html

New file
@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title><roundcube:object name="pagetitle" /></title>
<roundcube:include file="/includes/links.html" />
<script type="text/javascript" src="/functions.js"></script>

</head>
<body class="iframe">

<div id="prefs-title" class="boxtitle"><roundcube:object name="steptitle" /></div>

<div id="response-details" class="boxcontent">
  <roundcube:object name="responseform" class="propform" size="60" textareacols="60" textarearows="18" />

  <div id="formfooter">
    <div class="footerindent">
      <roundcube:button command="save" type="input" class="button mainaction" label="save" condition="!env:readonly" />
    </div>
  </div>
</div>

</body>
</html>

 skins/classic/templates/responses.html

New file
@@ -0,0 +1,46 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title><roundcube:object name="pagetitle" /></title>
<roundcube:include file="/includes/links.html" />
<script type="text/javascript" src="/functions.js"></script>
<script type="text/javascript" src="/splitter.js"></script>
<style type="text/css">
#identities-list { width: <roundcube:exp expression="!empty(cookie:identviewsplitter) ? cookie:identviewsplitter-5 : 295" />px; }
#identity-box { left: <roundcube:exp expression="!empty(cookie:identviewsplitter) ? cookie:identviewsplitter+5 : 305" />px;
  <roundcube:exp expression="browser:ie ? ('width:expression((parseInt(this.parentNode.offsetWidth)-'.(!empty(cookie:identviewsplitter) ? cookie:identviewsplitter+5 : 305).')+\\'px\\');') : ''" />
}
</style>

</head>
<body>

<roundcube:include file="/includes/taskbar.html" />
<roundcube:include file="/includes/header.html" />
<roundcube:include file="/includes/settingstabs.html" />

<div id="mainscreen">

<div id="identities-list">
<div id="identity-title" class="boxtitle"><roundcube:label name="responses" /></div>
<div class="boxlistcontent">
<roundcube:object name="responsesList" id="identities-table" class="records-table" cellspacing="0" summary="Responses list" noheader="true" editIcon="" />
</div>
<div class="boxfooter">
<roundcube:button command="add" type="link" title="newidentity" class="buttonPas addgroup" classAct="button addgroup" content=" " condition="config:identities_level:0<2" /><roundcube:button command="delete" type="link" title="delete" class="buttonPas delgroup" classAct="button delgroup" content=" " condition="config:identities_level:0<2" />
</div>
</div>

<script type="text/javascript">
  var identviewsplit = new rcube_splitter({id:'identviewsplitter', p1: 'identities-list', p2: 'identity-box', orientation: 'v', relative: true, start: 300 });
  rcmail.add_onload('identviewsplit.init()');
</script>

<div id="identity-box">
  <roundcube:object name="responseframe" id="identity-frame" width="100%" height="100%" frameborder="0" src="/watermark.html" />
</div>

</div>

</body>
</html>

 skins/larry/images/buttons.png

 skins/larry/images/listicons.png

 skins/larry/includes/settingstabs.html

@@ -4,6 +4,7 @@
    <span id="settingstabpreferences" class="listitem preferences"><roundcube:button command="preferences" type="link" label="preferences" title="editpreferences" /></span>
    <span id="settingstabfolders" class="listitem folders"><roundcube:button command="folders" type="link" label="folders" title="managefolders" /></span>
    <span id="settingstabidentities" class="listitem identities"><roundcube:button command="identities" type="link" label="identities" title="manageidentities" /></span>
    <span id="settingstabresponses" class="listitem responses"><roundcube:button command="responses" type="link" label="responses" title="editresponses" /></span>
    <roundcube:container name="tabs" id="settings-tabs" />
</div>
</div>

 skins/larry/mail.css

@@ -541,6 +541,10 @@
    background-position: -24px -1116px;
}

.messagelist thead tr td.priority span.priority {
    background-position: -24px -1845px;
}

#messagelist tr td.priority span.prio5 {
    background-position: 0 -1905px;
}

 skins/larry/settings.css

@@ -110,6 +110,14 @@
    background-position: 6px -1819px;
}

#settings-sections span.responses a {
    background-position: 6px -1972px;
}

#settings-sections span.responses.selected a {
    background-position: 6px -1996px;
}

#sections-table #rcmrowgeneral td.section {
    background-position: 6px -573px;
}
@@ -186,6 +194,10 @@
    text-overflow: ellipsis;
}

#identities-table tbody tr.readonly td {
    font-style: italic;
}

#folder-details,
#identity-details {
    position: absolute;

 skins/larry/styles.css

@@ -1354,6 +1354,20 @@
    font-size: 12px;
}

.propform div.prop {
    margin-bottom: 0.5em;
}

.propform div.prop.block label {
    display: block;
    margin-bottom: 0.3em;
}

.propform div.prop.block input,
.propform div.prop.block textarea {
    width: 95%;
}

fieldset.floating {
    float: left;
    margin-right: 10px;
@@ -1728,6 +1742,9 @@
    background-position: 0 -1745px;
}

.toolbar a.button.responses {
    background-position: center -1932px;
}

a.menuselector {
    display: inline-block;
@@ -1829,6 +1846,7 @@
}

ul.toolbarmenu,
ul.toolbarmenu ul,
#rcmKSearchpane ul {
    margin: 0;
    padding: 0;
@@ -1847,13 +1865,13 @@
}

.googie_list tr:first-child td,
ul.toolbarmenu li:first-child,
ul.toolbarmenu > li:first-child,
select.decorated option:first-child {
    border-top: 0;
}

.googie_list tr:last-child td,
ul.toolbarmenu li:last-child,
ul.toolbarmenu > li:last-child,
select.decorated option:last-child {
    border-bottom: 0;
}
@@ -1905,6 +1923,11 @@
    color: #fff;
    padding: 4px 8px;
    text-shadow: 0px 1px 1px #333;
}

ul.toolbarmenu li.separator label {
    color: #bbb;
    font-style: italic;
}

ul.toolbarmenu li a.icon {
@@ -1985,6 +2008,15 @@
    background-position: 0 -1532px;
}

#snippetslist {
    max-width: 200px;
}

#snippetslist li a {
    overflow: hidden;
    text-overflow: ellipsis;
}

#rcmKSearchpane {
    border-radius: 0 0 4px 4px;
    border-top: 0;

 skins/larry/templates/compose.html

@@ -30,6 +30,7 @@
    <roundcube:endif />
    <roundcube:button name="addattachment" type="link" class="button attach" classAct="button attach" classSel="button attach pressed" label="attach" title="addattachment" onclick="UI.show_uploadform();return false" />
    <roundcube:button command="insert-sig" type="link" class="button insertsig disabled" classAct="button insertsig" classSel="button insertsig pressed" label="signature" title="insertsignature" />
    <a href="#responses" class="button responses" label="responses" title="<roundcube:label name='insertresponse' />" id="responsesmenulink" unselectable="on" onmousedown="return false" onclick="UI.show_popup('responsesmenu');return false"><roundcube:label name="responses" /></a>
    <roundcube:container name="toolbar" id="compose-toolbar" />
</div>
</div>
@@ -196,6 +197,16 @@

<div id="spellmenu" class="popupmenu"></div>

<div id="responsesmenu" class="popupmenu">
    <ul class="toolbarmenu" id="textresponsesmenu">
        <li class="separator" id=""><label><roundcube:label name="insertresponse" /></label></li>
        <roundcube:object name="responseslist" id="responseslist" tagname="ul" itemclass="active" />
        <li class="separator"><label><roundcube:label name="manageresponses" /></label></li>
        <li><roundcube:button command="save-response" type="link" label="savenewresponse" classAct="active" unselectable="on" /></li>
        <li><roundcube:button command="responses" type="link" label="editresponses" classAct="active" /></li>
    </ul>
</div>

<roundcube:include file="/includes/footer.html" />

</body>

 skins/larry/templates/responseedit.html

New file
@@ -0,0 +1,22 @@
<roundcube:object name="doctype" value="html5" />
<html>
<head>
<title><roundcube:object name="pagetitle" /></title>
<roundcube:include file="/includes/links.html" />
</head>
<body class="iframe">

<h1 class="boxtitle"><roundcube:object name="steptitle" /></h1>

<div id="preferences-details" class="boxcontent">
<roundcube:object name="responseform" class="propform" size="60" textareacols="60" textarearows="18" />
</div>

<div class="footerleft formbuttons">
    <roundcube:button command="save" type="input" class="button mainaction" label="save" condition="!env:readonly" />
</div>

<roundcube:include file="/includes/footer.html" />

</body>
</html>

 skins/larry/templates/responses.html

New file
@@ -0,0 +1,41 @@
<roundcube:object name="doctype" value="html5" />
<html>
<head>
<title><roundcube:object name="pagetitle" /></title>
<roundcube:include file="/includes/links.html" />
</head>
<body class="noscroll">

<roundcube:include file="/includes/header.html" />

<div id="mainscreen" class="offset">

<roundcube:include file="/includes/settingstabs.html" />

<div id="settings-right">

<div id="identitieslist" class="uibox listbox">
<h2 class="boxtitle"><roundcube:label name="responses" /></h2>
<div class="scroller withfooter">
<roundcube:object name="responsesList" id="identities-table" class="listing" cellspacing="0" summary="Responses list" noheader="true" />
</div>
<div class="boxfooter">
<roundcube:button command="add" type="link" title="savenewresponse" class="listbutton add disabled" classAct="listbutton add" innerClass="inner" content="+" /><roundcube:button command="delete" type="link" title="delete" class="listbutton delete disabled" classAct="listbutton delete" innerClass="inner" content="-" />
</div>
</div>

<div id="identity-details" class="uibox contentbox">
    <div class="iframebox">
        <roundcube:object name="responseframe" id="preferences-frame" style="width:100%; height:100%" frameborder="0" src="/watermark.html" />
    </div>
    <roundcube:object name="message" id="message" class="statusbar" />
</div>

</div>

</div>

<roundcube:include file="/includes/footer.html" />

</body>
</html>