From bc1549f2ee74d5d3b2c95ff85598e37a3e6a4b7f Mon Sep 17 00:00:00 2001 From: chrisyates Date: Tue, 3 Apr 2012 14:19:07 -0400 Subject: [PATCH] added mailcomment to site --- modules/mailcomment/CHANGELOG.txt | 33 + modules/mailcomment/INSTALL.txt | 27 + modules/mailcomment/LICENSE.txt | 339 ++++++++++ modules/mailcomment/mailcomment.info | 17 + modules/mailcomment/mailcomment.install | 44 ++ modules/mailcomment/mailcomment.module | 632 ++++++++++++++++++ .../mailcomment_default.features.inc | 15 + ...comment_default.feeds_importer_default.inc | 83 +++ .../mailcomment_default.info | 17 + .../mailcomment_default.module | 3 + .../MailcommentAuthenticate.class.php | 48 ++ .../MailcommentAuthenticate.inc | 14 + modules/mailcomment/tests/mailcomment.test | 137 ++++ 13 files changed, 1409 insertions(+) create mode 100644 modules/mailcomment/CHANGELOG.txt create mode 100644 modules/mailcomment/INSTALL.txt create mode 100644 modules/mailcomment/LICENSE.txt create mode 100644 modules/mailcomment/mailcomment.info create mode 100644 modules/mailcomment/mailcomment.install create mode 100644 modules/mailcomment/mailcomment.module create mode 100644 modules/mailcomment/mailcomment_default/mailcomment_default.features.inc create mode 100644 modules/mailcomment/mailcomment_default/mailcomment_default.feeds_importer_default.inc create mode 100644 modules/mailcomment/mailcomment_default/mailcomment_default.info create mode 100644 modules/mailcomment/mailcomment_default/mailcomment_default.module create mode 100644 modules/mailcomment/plugins/authenticate_plugin/MailcommentAuthenticate.class.php create mode 100644 modules/mailcomment/plugins/authenticate_plugin/MailcommentAuthenticate.inc create mode 100644 modules/mailcomment/tests/mailcomment.test diff --git a/modules/mailcomment/CHANGELOG.txt b/modules/mailcomment/CHANGELOG.txt new file mode 100644 index 0000000..2e625bc --- /dev/null +++ b/modules/mailcomment/CHANGELOG.txt @@ -0,0 +1,33 @@ +Mail Comment 7.x-2.x, 2011-12-04 +-------------------------------- + +Mail Comment 7.x-2.0, 2011-12-04 +-------------------------------- +#1355106 by pereljon: Fixed message headers not added when node is posted. +#1336582 by Dane Powell: Fixed comments being imported even on disallowed node types. +#1352980 by pereljon: Fixed broken link to original comment in notification messages. +#1352940 by pereljon: Fixed minor code style errors. +#1350072 by pereljon: Fixed recoverable fatal error on comment import. +Fixed bad version dependency. +Added version requirements. + +Mail Comment 7.x-2.0-rc1, 2011-10-19 +------------------------------------ +Coder (code formatting) cleanup before next release. +#1188584 by davideads: Improved message cleaning/filtering options. +Fixed hook_feeds_after_parse (again). +Fixed hook_feeds_after_parse definition. + +Mail Comment 7.x-2.0-beta2, 2011-08-30 +-------------------------------------- +#1244224 by davideads: Fixed Mail Comment redirect showing up in menu. +#1188584 by arvinsingla, Dane Powell: Fixed reply text not being stripped from message body. +Removed hook_mailcomment_alter() - the same functionality can be achieved with existing Feeds hooks. +Updated for compatibility with Mailhandler 7.x-2.0-beta2 +#1248182 by Dane Powell: Fixed WSOD on configuration page (again) +#1248182 by Dane Powell: Fixed WSOD on configuration page + +Mail Comment 7.x-2.0-beta1, 2011-05-18 +-------------------------------------- +#1158562 by Dane Powell: Cleaned up code (Coder review and documentation) +Added CHANGELOG.txt diff --git a/modules/mailcomment/INSTALL.txt b/modules/mailcomment/INSTALL.txt new file mode 100644 index 0000000..1c8008d --- /dev/null +++ b/modules/mailcomment/INSTALL.txt @@ -0,0 +1,27 @@ +CONTENTS OF THIS FILE +--------------------- + + * Requirements + * Quick setup + * Overview + +REQUIREMENTS +------------ + +Dependencies: +- Mailhandler (matching version required - i.e., if you are using Mail Comment + 7.x-2.0-alpha5, you must use Mailhandler 7.x-2.0-alpha5) +- Notifications and Messaging (7.x-4.x branch) + +QUICK SETUP +----------- + +- Enable the "Mail Comment Default" module. +- Add a mailbox at admin/structure/mailhandler. +- Configure Mail Comment at admin/messaging/mailcomment +- Create a node and subscribe to the thread to receive email notifications. +- Add a comment to the thread to generate a notification message. +- Reply to the message. +- Go to /import, choose the Mailhandler comments importer, choose the mailbox + you just set up from the drop-down menu, and select "Import". Your email + should be imported as a comment. diff --git a/modules/mailcomment/LICENSE.txt b/modules/mailcomment/LICENSE.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/modules/mailcomment/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/modules/mailcomment/mailcomment.info b/modules/mailcomment/mailcomment.info new file mode 100644 index 0000000..a9aef3c --- /dev/null +++ b/modules/mailcomment/mailcomment.info @@ -0,0 +1,17 @@ +name = Mail Comment +description = Gateway module for responding to posts via mail +package = "Mailhandler" +dependencies[] = notifications +dependencies[] = mailhandler (>1.99) +core = 7.x + +files[] = mailcomment.install +files[] = mailcomment.module +files[] = plugins/MailcommentAuthenticate.inc +files[] = tests/mailcomment.test +; Information added by drupal.org packaging script on 2012-01-04 +version = "7.x-2.1" +core = "7.x" +project = "mailcomment" +datestamp = "1325704244" + diff --git a/modules/mailcomment/mailcomment.install b/modules/mailcomment/mailcomment.install new file mode 100644 index 0000000..341651b --- /dev/null +++ b/modules/mailcomment/mailcomment.install @@ -0,0 +1,44 @@ + 'Mail Comment', + 'description' => 'Configure automatic mail responses.', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('mailcomment_admin_settings'), + 'access arguments' => array('administer notifications'), + ); + $items['mailcomment/redirect'] = array( + 'title' => 'Mail Comment', + 'description' => 'Redirect Mail Comment links to original message.', + 'page callback' => 'mailcomment_message_redirect', + 'page arguments' => array(2), + 'access arguments' => array('access content'), + 'type' => MENU_CALLBACK, + ); + return $items; +} + +/** + * Admin settings form + */ +function mailcomment_admin_settings() { + $form['mailcomment_mailbox'] = array( + '#title' => t('Reply-To address'), + '#type' => 'textfield', + '#default_value' => variable_get('mailcomment_mailbox', variable_get('site_mail', '')), + '#description' => t('E-mail account used to set Reply-To for outgoing e-mail notifications.'), + ); + // Expiration time + $period = drupal_map_assoc(array(60, 3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval'); + $period[0] = t('Never'); + + $form['mailcomment_expiration'] = array( + '#title' => t('Expiration time'), + '#type' => 'select', + '#options' => $period, + '#required' => TRUE, + '#default_value' => variable_get('mailcomment_expiration', 0), + '#description' => t('Time after which the signature of outgoing e-mails expires and responses won\'t be accepted anymore.'), + ); + + $form['filter_options'] = array( + '#title' => t('Message filtering'), + '#type' => 'fieldset', + '#collapsible' => TRUE, + ); + + $form['filter_options']['mailcomment_import_filter_mode'] = array( + '#title' => t('Filter mode'), + '#type' => 'radios', + '#default_value' => variable_get('mailcomment_import_filter_mode', MAILCOMMENT_FILTER_NONE), + '#options' => array( + MAILCOMMENT_FILTER_NONE => t('No import filter. Leave messages as-is.'), + MAILCOMMENT_FILTER_BASIC => t('Basic import filter: Filter signatures and below custom reply separator.'), + MAILCOMMENT_FILTER_AGGRESSIVE => t('Aggressive: Filter below custom reply separator and common mail client text strings.'), + ), + '#description' => t('Should messages be filtered during import? If No import filter is selected, messages will be stored in the database as they are received.'), + ); + + $form['filter_options']['mailcomment_reply_text'] = array( + '#title' => t('Reply text'), + '#type' => 'textfield', + '#default_value' => variable_get('mailcomment_reply_text', t('((( Reply ABOVE this LINE to POST a COMMENT )))')), + '#description' => t('Text to separate reply from the rest of the e-mail. Leave blank to disable.'), + ); + $form['filter_options']['mailcomment_insert_reply_text'] = array( + '#title' => t('Insert reply to text'), + '#type' => 'checkbox', + '#default_value' => variable_get('mailcomment_insert_reply_text', 1), + '#description' => t('If this box is checked, mail comment will insert the text specified as the Reply text at the top of messages sent. You may uncheck this box and insert the text manually into a messaging template (for example, above the footer).'), + ); + + $form['mailcomment_error_bounce'] = array( + '#title' => t('Bounce rejected emails'), + '#type' => 'checkbox', + '#default_value' => variable_get('mailcomment_error_bounce', 1), + '#description' => t('If this box is checked, a reply will be sent for wrong emails with some information about the cause of rejection.'), + ); + + $form['mailcomment_server_string'] = array( + '#title' => t('Server string for Message Id'), + '#type' => 'textfield', + '#default_value' => variable_get('mailcomment_server_string', $_SERVER['HTTP_HOST']), + '#description' => t('Server name to be used in Message Id\'s. It will be included in outgoing emails and checked on responses.'), + ); + + $form['mailcomment_alter_subjects'] = array( + '#type' => 'radios', + '#title' => t('Use mailing list-style subjects'), + '#description' => t('When enabled this setting will alter the subjects of outgoing messages to look more like subjects used by mailing lists. For + example the subject will look like "[My Site] Subject of Message". This style makes message threading work better in certain email clients that + do not pay attention to the in-reply-to header parameter.'), + '#default_value' => variable_get('mailcomment_alter_subjects', 1), + '#options' => array(t('Off'), t('On')), + ); + return system_settings_form($form); +} + +/** + * Implements hook_notifications_message_alter(). + * + * Adds message headers into outgoing emails for notifications + */ +function mailcomment_notifications_message_alter(&$message) { + $params = array(); + // For now, just for non digested emails + if (($account = current($message->get_destinations())->get_user()) && $message->digest == FALSE && $message->send_method()->type == 'mail') { + $event = current($message->events); + if (($event->type == 'node-post' || $event->type == 'node-comment') && !empty($event->objects['node'])) { + $node = node_load($event->objects['node']->value); + $params['uid'] = $node->uid; + $params['nid'] = $node->nid; + $params['cid'] = 0; + $params['time'] = $node->created; + if ($event->action == 'comment' && !empty($event->objects['comment'])) { + $comment = comment_load($event->objects['comment']->value); + $params['uid'] = $comment->uid; + $params['cid'] = $comment->cid; + $ancestor_msg_id = mailcomment_mail_comment_ancestor_message_id($params['nid'], $params['cid']); + $params['time'] = $comment->created; + } + } + } + // If we've got some params out of the message, embed them into the message id for emails only + // and only if the recipient of the message is allowed to post comments. + if ($params && ($reply = variable_get('mailcomment_mailbox', '')) && user_access('post comments', $account) && (node_load($event->objects['node']->value)->comment == 2)) { + // Alter message subjects + if (variable_get('mailcomment_alter_subjects', 1)) { + $subject = $message->get_template()->get_element('subject'); + if (($event->type == 'node' || $event->type == 'node-comment') && !empty($event->objects['node'])) { + $subject['#markup'] = variable_get('site_name', '') ? '[' . variable_get('site_name', '') . '] ' . node_load($event->objects['node']->value)->title : $subject['#markup']; + } + if ($event->action == 'comment') { + $subject['#markup'] = t('Re:') . ' ' . $subject['#markup']; + } + $message->subject = $subject; + } + + $message->params['mail']['headers']['Message-ID'] = mailcomment_build_messageid($params); + $message->params['mail']['headers']['Reply-To'] = $reply; + if (isset($ancestor_msg_id)) { + $message->params['mail']['headers']['In-Reply-To'] = $ancestor_msg_id; + } + // Add marker text into the message header part taking care of already existing text + $insert_reply_text = variable_get('mailcomment_insert_reply_text', 1); + $text = variable_get('mailcomment_reply_text', t('((( Reply ABOVE this LINE to POST a COMMENT )))')); + if ($text && $insert_reply_text) { + $prefix = array($text); + $header = $message->get_template()->get_element('header'); + $prefix[] = $header['#markup']; + $header['#markup'] = implode("\n", $prefix); + $message->get_template()->add_element('header', $header); + } + // Alter $params in order to provide recipient uid in message signature + $params['uid'] = $account->uid; + $footer = $message->get_template()->get_element('footer'); + $footer['mailcomment'] = array('#type' => 'messaging_link', '#text' => 'View original post: ', '#url' => url('mailcomment/redirect/' . mailcomment_build_messageid($params), array('absolute' => TRUE))); + $message->get_template()->add_element('footer', $footer); + } +} + +/** + * Handle errors and bounce mail when authentication or validation fail + * + * We handle the incoming email carefully and don't add any user data in the response + * because everything in the mail can be forged. + * + * @param $error + * Error code + * @param $node + * Node object + * @param $header + * Message headers + */ +function mailcomment_error($error, $node, $header, $params = array()) { + $text_vars = array( + '!site' => variable_get('site_name', 'Drupal'), + '@subject' => $header->subject, + '@to' => $header->toaddress, + '@from' => $header->fromaddress, + ); + $reply = !empty($header->reply_to[0]->mailbox) ? $header->reply_to[0]->mailbox . '@' . $header->reply_to[0]->host + : $header->from[0]->mailbox . '@' . $header->from[0]->host; + + $message = array(); + + switch ($error) { + case MAILCOMMENT_ERROR_SIGNATURE: + watchdog('mailcomment', 'Received an email without signed parameters from @from: @subject', $text_vars, WATCHDOG_WARNING); + break; + case MAILCOMMENT_ERROR_EXPIRED: + watchdog('mailcomment', 'Received an email with a expired signature from @from: @subject', $text_vars); + break; + case MAILCOMMENT_ERROR_USER: + watchdog('mailcomment', 'Received an e-mail without a valid user id from @from: @subject', $text_vars, WATCHDOG_WARNING); + break; + case MAILCOMMENT_ERROR_PARAMS: + default: + watchdog('mailcomment', 'Received an email with no parameters from @from: @subject', $text_vars, WATCHDOG_WARNING); + break; + } + + // Send out bounce mail only if the mail address is valid and the feature is enabled. + // @ TODO Reply using the original messaging mail method used. + if ($reply && variable_get('mailcomment_error_bounce', 1) && valid_email_address($reply)) { + if ($node->uid && ($account = user_load($node->uid))) { + $language = user_preferred_language($account); + } + else { + $language = language_default(); + } + $params['error'] = $error; + $params['text_vars'] = $text_vars; + drupal_mail('mailcomment', 'bounce', $reply, $language, $params); + } +} + +/** + * Implements hook_mail(). + */ +function mailcomment_mail($key, &$message, $params) { + $language = $message['language']; + $text_vars = $params['text_vars']; + $message['subject'] = t('There was a problem with your email to !site (@subject)', $text_vars, $language->language); + // The error code will determine the main text + switch ($params['error']) { + case MAILCOMMENT_ERROR_SIGNATURE: + $text[] = t('The email you sent to @to was rejected because there was a signature error.', $text_vars, $language->language); + break; + case MAILCOMMENT_ERROR_EXPIRED: + $text[] = t('The email you sent to @to was rejected because it was sent after the allowed response time for the original email.', $text_vars, $language->language); + break; + case MAILCOMMENT_ERROR_USER: + $text[] = t('The email you sent to @to was rejected because we couldn\'t authenticate it.', $text_vars, $language->language); + break; + case MAILCOMMENT_ERROR_PARAMS: + default: + $text[] = t('The email you sent to @to was rejected because there was a validation error.', $text_vars, $language->language); + break; + + } + // More explanatory information + $text[] = ''; // Blank line + $text[] = t('In order for emails to be accepted by !site:', $text_vars, $language->language); + $text[] = t('- They must be sent in reply to a valid notification email.', array(), $language->language); + $text[] = t('- The reply must be done from the same email address the notification was sent to.', array(), $language->language); + if ($expire = variable_get('mailcomment_expiration', 0)) { + $text[] = t('- You can only reply within the time allotted by the system which is @expiration', array('@expiration' => format_interval($expire, 2, $language->language)), $language->language); + } + + // Add node link if we have it + if (!empty($params['nid'])) { + $text[] = ''; // Blank line + $text[] = t('You may post comments directly by visiting !node-url', array('!node-url' => url('node/' . $params['nid'], NULL, NULL, TRUE)), $language->language); + } + $message['body'] = implode("\n", $text); +} + +/** + * Build messageid embedding the parameters + * + * Not all chars are valid for our message-id, as some of them cause the PHP imap + * functions to retrieve an empty In-Reply-To header. + * + * Valid formats: numbers separated by dots + */ +function mailcomment_build_messageid($params) { + $elements = array($params['uid'], $params['nid'], $params['cid'], $params['time']); + // Add signature + $elements[] = mailcomment_signature($elements); + + return '<' . implode('.', $elements) . '@' . variable_get('mailcomment_server_string', 'example.com') . '>'; +} + +/** + * Determines whether the mail comment signature exists in the body + * + * @param $body + * raw email body + * + * @return + * String signature or FALSE if not found. + */ +function _mailcomment_get_signature($body) { + // Grab the server string and make it regex-friendly + $server = str_replace('.', '\.', variable_get('mailcomment_server_string', 'example.com')); + // Check for a signature match + if (preg_match("/([0-9]+\.){4}[a-z0-9]+@" . $server . "/is", $body, $matches)) { + // We have a match for the messageid and the mailcomment domain string so we are good + return $matches[0]; + } + // No matches found so assume we have no messageid and node->threading is not set + return FALSE; +} + +/** + * Redirect request to a node and comment anchor + * + * A link is added to the message body which contains the mail comment signature. + * If this link is clicked it will reach this callback which will redirect the request + * to the original node and comment anchor, if applicable. + * + * @param $string + * String - the mail comment signature + */ +function mailcomment_message_redirect($string) { + $options = array(); + $params = mailcomment_parse_messageparams(str_replace(array("<", ">"), "", $string)); + $params['cid'] ? $fragment = 'comment-' . $params['cid'] : $fragment = NULL; + $option['fragment'] = $fragment; + drupal_goto('node/' . $params['nid'], $options); +} + +/** + * Returns Message-ID for the immediate ancestor of a comment. + * + * The parent node is considered an ancestor with a cid value of zero. + * + * @param $nid + * Primary key of comment for which ancestors are sought. + * @param $cid + * Primary key of comment for which ancestors are sought. + */ +function mailcomment_mail_comment_ancestor_message_id($nid, $cid) { + $msg_ids = array(); + if ($cid != 0) { + // Every comment has a node ancestor. + $pid = db_query("SELECT pid from {comment} WHERE cid = :cid", array(':cid' => $cid))->fetchField(); + if ($pid) { + // A positive pid means this is a comment. If it's 0 that's a node. + $query = "SELECT uid, nid, cid, created as time FROM {comment} WHERE cid = :cid"; + $result = db_query($query, array(':cid' => $pid))->fetchAssoc(); + return mailcomment_build_messageid($result); + } + else { + $query = "SELECT uid, nid, 0 as cid, created as time FROM {node} WHERE nid = :nid"; + $result = db_query($query, array(':nid' => $nid))->fetchAssoc(); + return mailcomment_build_messageid($result); + } + } + return ''; +} + +/** + * Implements hook_ctools_plugin_directory(). + */ +function mailcomment_ctools_plugin_directory($module, $plugin) { + if ($module == 'mailhandler') { + return 'plugins/' . $plugin; + } +} + +/** + * Alter mapping sources. + * + * Use this hook to add additional mapping sources for any parser. Allows for + * registering a callback to be invoked at mapping time. + * + * my_callback(FeedsImportBatch $batch, $key) + * + * @see my_source_get_source() + * @see locale_feeds_parser_sources_alter() + */ +function mailcomment_feeds_parser_sources_alter(&$sources, $content_type) { + $sources['parent_nid'] = array( + 'name' => t('Parent NID'), + 'description' => t('Parent NID of comment'), + 'callback' => 'mailcomment_source_get_source', + ); + $sources['parent_cid'] = array( + 'name' => t('Parent CID'), + 'description' => t('Parent CID of comment'), + 'callback' => 'mailcomment_source_get_source', + ); +} + +/** + * Callback specified in hook_feeds_parser_sources_alter(). + * + * To be invoked on mapping time. + * + * @param $source + * The FeedsSource object being imported. + * @param $result + * The FeedsParserResult object being mapped from. + * @param $key + * The key specified in the $sources array in + * hook_feeds_parser_sources_alter(). + * + * @return + * The value to be extracted from the source. + * + * @see hook_feeds_parser_sources_alter() + * @see locale_feeds_get_source() + */ +function mailcomment_source_get_source($source, FeedsParserResult $result, $key) { + $item = $result->currentItem(); + $identifier = _mailcomment_get_signature(rawurldecode($item['origbody'])); + if (!$identifier) { + // Failed to find signature in body -- replicate mailhandler functionality to find node->threading + if (!empty($item['header']->references)) { + // we want the final element in references header, watching out for white space + $identifier = drupal_substr(strrchr($item['header']->references, '<'), 0); + } + elseif (!empty($item['header']->in_reply_to)) { + // Some MUAs send more info in this header. + $identifier = str_replace(strstr($item['header']->in_reply_to, '>'), '>', $item['header']->in_reply_to); + } + if (isset($identifier)) { + $identifier = rtrim(ltrim($identifier, '<'), '>'); + } + } + $params = mailcomment_check_messageparams($identifier); + switch ($key) { + case 'parent_nid': + return $params['nid']; + case 'parent_cid': + return $params['cid']; + } +} + +/** + * Gets the mail comment parameters based on mail comment signature + * + * It will check the digital signature and only return parameters if they match + * + * @param $identifier + * String - the mail comment signature string + * + * @return + * Array of parameters. + */ +function mailcomment_check_messageparams($identifier) { + if ($params = mailcomment_parse_messageparams($identifier)) { + $signature = $params['signature']; + unset($params['signature']); + // Check digital signature and expiration time if set + if ($signature && $signature == mailcomment_signature($params)) { + // Check signature has not expired + if (($expire = variable_get('mailcomment_expiration', 0)) && $params['time'] + $expire < REQUEST_TIME) { + $params['error'] = MAILCOMMENT_ERROR_EXPIRED; + } + return $params; + } + else { + $params['error'] = MAILCOMMENT_ERROR_SIGNATURE; + } + } + else { + $params['error'] = MAILCOMMENT_ERROR_PARAMS; + return $params; + } +} + +/** + * Parse message id into parameters + * + * The message id should have this form: + * uid.nid.cid.time.signature@server string + * @param $messageid + * Incoming message id + * + * @return + * Array of mail comment parameters parsed from signature string + */ +function mailcomment_parse_messageparams($messageid) { + $params = array(); + $parts = explode('@', $messageid); + if (count($parts) == 2 && $parts[1] == variable_get('mailcomment_server_string', 'example.com')) { + $parts = explode('.', $parts[0]); + if (count($parts) == 5) { + $params['uid'] = $parts[0]; + $params['nid'] = $parts[1]; + $params['cid'] = $parts[2]; + $params['time'] = $parts[3]; + $params['signature'] = $parts[4]; + } + } + return $params; +} + +/** + * Produce / verify digital signature + */ +function mailcomment_signature($params) { + $params[] = drupal_get_private_key(); + return md5(implode('-', $params)); +} + +/** + * Implements hook_feeds_after_parse(). + * + * Apply filters before writing to database. + */ +function mailcomment_feeds_after_parse(FeedsSource $source, FeedsParserResult $result) { + switch (variable_get('mailcomment_import_filter_mode', 0)) { + case MAILCOMMENT_FILTER_BASIC: + foreach ($result->items as &$message) { + $message['origbody'] = _mailcomment_filter_basic($message['origbody']); + } + break; + case MAILCOMMENT_FILTER_AGGRESSIVE: + foreach ($result->items as &$message) { + $message['origbody'] = _mailcomment_filter_aggressive($message['origbody']); + } + break; + } +} + +/** + * Implements hook_filter_info(). + */ +function mailcomment_filter_info() { + $filters['mailcomment_basic'] = array( + 'title' => t('Mailcomment basic message cleaner'), + 'description' => t('Attempt to remove email client gunk at bottom of emails, like "On Jan 26, 2009, John Doe wrote:"?'), + 'process callback' => '_mailcomment_basic_filter_process', + ); + $filters['mailcomment_extra'] = array( + 'title' => t('Mailcomment extra message cleaner'), + 'description' => t('A more aggressive version of the message cleaner'), + 'process callback' => '_mailcomment_extra_filter_process', + ); + return $filters; +} + +/** + * Filter callback. + */ +function _mailcomment_basic_filter_process($text, $filter, $format, $langcode, $cache, $cache_id) { + return _mailcomment_filter_basic($text); +} + +/** + * Filter callback. + */ +function _mailcomment_extra_filter_process($text, $filter, $format, $langcode, $cache, $cache_id) { + return _mailcomment_filter_aggressive($text); +} + +/** + * Filter a message for signature in a simple way. + * + * @param $text + * Text to filter. + * @return + * A filtered string. + */ +function _mailcomment_filter_basic($text) { + // Get the offset of the last two line breaks and substring. + $search = preg_match_all("/|\r\n\r\n|\n\n[^|\r\n\r\n|\n\n]+$/m", $text, $matches, PREG_OFFSET_CAPTURE); + if (!empty($matches[0])) { + $key = max(array_keys($matches[0])); + $offset = $matches[0][$key][1]; + $text = trim(drupal_substr($text, 0, $offset)); + } + + if ($marker = variable_get('mailcomment_reply_text', t('((( Reply ABOVE this LINE to POST a COMMENT )))'))) { + $search = preg_match_all("/[\> ]*" . preg_quote($marker) . "/", $text, $matches, PREG_OFFSET_CAPTURE); + if (!empty($matches[0])) { + $key = max(array_keys($matches[0])); + $offset = $matches[0][$key][1]; + $text = trim(drupal_substr($text, 0, $offset)); + } + } + + return $text; +} + +/** + * Aggressively filter a message for quotes and signatures. + * + * @param $text + * Text to filter. + * @return + * A filtered string. + */ +function _mailcomment_filter_aggressive($text) { + $delimiters = array(); + + $delimiters = array( + "On \d{1,2}[\/\-]{1}\d{1,2}[\/\-]{1}\d{1,2},", // Gmail form 1 + "On \w{3}, \w{3} \d{1,2}, \d{4} at \d{1,2}:\d{1,2} [AP]M", // Gmail form 1 + "On \w{3}, \w{3} \d{1,2}, \d{4} at \d{1,2}:\d{1,2} [AP]M", // Gmail form 2 + "On \d{1,2}\/\d{1,2}\/\d{4} \d{1,2}:\d{1,2} [AP]M,", // Thunderbird + "On [A-Z][a-z]{2} [0-9]{1,2}, [0-9]{4}, at [0-9]{1,2}:[0-9]{2} [AP]M, [a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4} wrote", // Mac mail form 1 + "On [A-Z][a-z]{2} [0-9]{1,2}, [0-9]{4}, at [0-9]{1,2}:[0-9]{2} [AP]M,", // Mac mail form 2 + "On \d{1,2} \w{3} \d{4}, at \d{1,2}:\d{2} [AP]M, [a-zA-Z0-9._%-]+@?[a-zA-Z0-9.-]*[\.]?[a-zA-Z]{0,4} wrote:", // Mac mail v4.2 + "-----\s?Original Message\s?-----", // Outlook Express + "From:(\s*)[A-Za-z0-9._%+-]+@[A-Za-z0-9._%+-]+\.[A-Za-z]{2,3}(\s*)\[mailto:[A-Za-z0-9._%+-]+@[A-Za-z0-9._%+-]+\.[A-Za-z]{2,3}\]", // Outlook legacy + "[_]*\nFrom:", // Yahoo + Outlook web + "From:.*Sent:.*To:.*Subject:", // Fallback + ); + + if ($marker = variable_get('mailcomment_reply_text', t('((( Reply ABOVE this LINE to POST a COMMENT )))'))) { + $delimiters[] = '[\> ]*' . preg_quote($marker); + } + + $expression = '/(' . implode('|', $delimiters) . ')/'; + + if (preg_match($expression, $text, $matches, PREG_OFFSET_CAPTURE)) { + $text = trim(drupal_substr($text, 0, $matches[0][1])); + } + + return $text; +} diff --git a/modules/mailcomment/mailcomment_default/mailcomment_default.features.inc b/modules/mailcomment/mailcomment_default/mailcomment_default.features.inc new file mode 100644 index 0000000..eb9cedf --- /dev/null +++ b/modules/mailcomment/mailcomment_default/mailcomment_default.features.inc @@ -0,0 +1,15 @@ + 1); + } +} diff --git a/modules/mailcomment/mailcomment_default/mailcomment_default.feeds_importer_default.inc b/modules/mailcomment/mailcomment_default/mailcomment_default.feeds_importer_default.inc new file mode 100644 index 0000000..320e51f --- /dev/null +++ b/modules/mailcomment/mailcomment_default/mailcomment_default.feeds_importer_default.inc @@ -0,0 +1,83 @@ +disabled = FALSE; /* Edit this to true to make a default feeds_importer disabled initially */ + $feeds_importer->api_version = 1; + $feeds_importer->id = 'mailhandler_comments'; + $feeds_importer->config = array( + 'name' => 'Mailhandler comments', + 'description' => 'Imports comments from a Mailhandler mailbox', + 'fetcher' => array( + 'plugin_key' => 'MailhandlerFetcher', + 'config' => array( + 'filter' => 'MailhandlerFiltersComments', + ), + ), + 'parser' => array( + 'plugin_key' => 'MailhandlerParser', + 'config' => array( + 'if_auth_fails' => 'remove', + 'default_commands' => 'status: 1', + 'command_plugin' => array( + 'MailhandlerCommandsDefault' => 'MailhandlerCommandsDefault', + 'MailhandlerCommandsHeaders' => 'MailhandlerCommandsHeaders', + ), + 'authenticate_plugin' => 'MailhandlerAuthenticateDefault', + ), + ), + 'processor' => array( + 'plugin_key' => 'FeedsCommentProcessor', + 'config' => array( + 'input_format' => 0, + 'update_existing' => 0, + 'expire' => -1, + 'mappings' => array( + 0 => array( + 'source' => 'parent_nid', + 'target' => 'nid', + 'unique' => FALSE, + ), + 1 => array( + 'source' => 'parent_cid', + 'target' => 'pid', + 'unique' => FALSE, + ), + 2 => array( + 'source' => 'subject', + 'target' => 'subject', + 'unique' => FALSE, + ), + 3 => array( + 'source' => 'origbody', + 'target' => 'comment', + 'unique' => FALSE, + ), + 4 => array( + 'source' => 'authenticated_uid', + 'target' => 'uid', + 'unique' => FALSE, + ), + ), + 'author' => 0, + ), + ), + 'content_type' => '', + 'update' => 0, + 'import_period' => '900', + 'expire_period' => 3600, + 'import_on_create' => 1, + ); + $export['mailhandler_comments'] = $feeds_importer; + + return $export; +} diff --git a/modules/mailcomment/mailcomment_default/mailcomment_default.info b/modules/mailcomment/mailcomment_default/mailcomment_default.info new file mode 100644 index 0000000..5406046 --- /dev/null +++ b/modules/mailcomment/mailcomment_default/mailcomment_default.info @@ -0,0 +1,17 @@ +core = "7.x" +dependencies[] = "mailcomment" +dependencies[] = "feeds_ui" +dependencies[] = "feeds_comment_processor" +description = "Default Mailcomment Feeds importer" +features[ctools][] = "feeds:feeds_importer_default:1" +features[feeds_importer][] = "mailhandler_comments" +name = "Mailcomment default" +package = "Mailhandler" +project = "Mailcomment" + +; Information added by drupal.org packaging script on 2012-01-04 +version = "7.x-2.1" +core = "7.x" +project = "mailcomment" +datestamp = "1325704244" + diff --git a/modules/mailcomment/mailcomment_default/mailcomment_default.module b/modules/mailcomment/mailcomment_default/mailcomment_default.module new file mode 100644 index 0000000..04f943a --- /dev/null +++ b/modules/mailcomment/mailcomment_default/mailcomment_default.module @@ -0,0 +1,3 @@ +threading + if (!$identifier) { + if (!empty($message['header']->references)) { + // we want the final element in references header, watching out for white space + $identifier = drupal_substr(strrchr($message['header']->references, '<'), 0); + } + elseif (!empty($message['header']->in_reply_to)) { + // Some MUAs send more info in this header. + $identifier = str_replace(strstr($message['header']->in_reply_to, '>'), '>', $message['header']->in_reply_to); + } + if (isset($identifier)) { + $identifier = rtrim(ltrim($identifier, '<'), '>'); + $force_user_lookup = TRUE; + } + } + $params = mailcomment_check_messageparams($identifier); + + if ($force_user_lookup) { + // get uid from email address because we are using the header information to load the params + // these contain the uid of the person who's post you are responding to + $sender = $message['header']->from[0]->mailbox . '@' . $message['header']->from[0]->host; + $params['uid'] = user_load(array('mail' => $sender))->uid; + } + + if ($params['uid']) { + $account = user_load($params['uid']); + $message['authenticated_uid'] = $account->uid; + } + else { + $message['authenticated_uid'] = 0; + } + } +} diff --git a/modules/mailcomment/plugins/authenticate_plugin/MailcommentAuthenticate.inc b/modules/mailcomment/plugins/authenticate_plugin/MailcommentAuthenticate.inc new file mode 100644 index 0000000..7880d73 --- /dev/null +++ b/modules/mailcomment/plugins/authenticate_plugin/MailcommentAuthenticate.inc @@ -0,0 +1,14 @@ + 'Mailcomment Authentication', + 'description' => 'Authenticate mail based on message parameters and secret key.', + 'handler' => array( + 'class' => 'MailcommentAuthenticate', + 'parent' => 'MailhandlerAuthenticate', + ), +); diff --git a/modules/mailcomment/tests/mailcomment.test b/modules/mailcomment/tests/mailcomment.test new file mode 100644 index 0000000..80c3980 --- /dev/null +++ b/modules/mailcomment/tests/mailcomment.test @@ -0,0 +1,137 @@ + 'Mailcomment', + 'description' => 'Test mailcomment message parsing.', + 'group' => 'mailcomment', + ); + } + + /** + * setUp() performs any pre-requisite tasks that need to happen. + */ + public function setUp() { + variable_set('mailcomment_reply_text', t('((( Reply ABOVE this LINE to POST a COMMENT )))')); + + // Enable any modules required for the test. + parent::setUp( + 'ctools', + 'notifications', + 'messaging', + 'feeds', + 'autoload', + 'token', + 'job_scheduler', + 'messaging_template', + 'mailhandler', + 'mailcomment' + ); + } + + public static function mailCommentTestMessages() { + $messages = array(); + + // Gmail + $messages['gmail'] = "Hello world. + +On Fri, Aug 19, 2011 at 9:51 AM, test person wrote: +> ((( Reply ABOVE this LINE to POST a COMMENT ))) +> +> user said: +> +> Courgette lettuce bell pepper asparagus collard greens epazote broccoli rabe. Wattle +> seed cress welsh onion broccoli rabe pea sprouts tomatillo celery ricebean napa cabbage +> bush tomato daikon horseradish turnip winter purslane. Chickweed radicchio taro tigernut +> spinach tomatillo black-eyed pea avocado. + +-- +Test person name | http://hostname.tld"; + + // Thunderbird + $messages['thunderbird'] = "Hello world. + +On 08/18/2011 04:19 PM, Test Person wrote: +> ((( Reply ABOVE this LINE to POST a COMMENT ))) +> +> user said: +> +> Mustard scallion yarrow aubergine sierra leone bologi sea lettuce +> chicory broccoli collard greens turnip greens shallot radicchio komatsuna. +> Broccoli celery grape bell pepper kohlrabi radicchio sierra leone bologi."; + + // Mac Mail 4.2 + $messages['mac_mail42'] = "Hello world. + +On 14 Sep 2011, at 4:37 PM, someuser wrote: + +> ((( Reply ABOVE this LINE to POST a COMMENT ))) +> +> Kakadu plum burdock collard greens sorrel dulse seakale winter purslane soko +> beet greens summer purslane radish tomato bunya nuts. Amaranth chickweed onion +> broccoli rabe shallot kombu pea napa cabbage welsh onion soko water chestnut +> tomatillo bell pepper arugula pea sprouts. Azuki bean seakale scallion turnip +> greens azuki bean groundnut beetroot cress courgette lentil epazote kale celery +> garbanzo watercress."; + + // Yahoo mail + $messages['yahoo'] = "Hello world. +________________________________ +From: Firstname Lastname +To: recipient@hostname.tld +Sent: Tuesday, September 13, 2011 10:14 AM +Subject: Re: Test subject + +((( Reply ABOVE this LINE to POST a COMMENT ))) + +Earthnut pea eggplant brussels sprout bitterleaf quandong desert raisin wattle +seed celtuce bamboo shoot mung bean cauliflower maize salad chickpea celery. +Winter purslane silver beet daikon brussels sprout broccoli rabe lotus root +water chestnut garlic melon lettuce potato pumpkin. Ricebean groundnut potato +celery corn artichoke sea lettuce. No joke."; + + // Outlook web + $messages['outlook_web'] = "Hello world. +________________________________________ +From: user@hostname.tld [user@hostname.tld] +Sent: Thursday, August 18, 2011 4:19 PM +To: Recipient Name +Subject: Re: [Site-name] Subject + +((( Reply ABOVE this LINE to POST a COMMENT ))) + +Test user said: + +Pea cress water spinach summer purslane asparagus scallion squash sorrel. Pea +green bean celery chickpea lotus root parsnip celery arugula carrot winter +purslane cress plantain tatsoi pumpkin pea ricebean mung bean lentil."; + + $messages['generic_reply'] = "Hello world. + +> ((( Reply ABOVE this LINE to POST a COMMENT ))) +> +> user said: +> +> Mustard scallion yarrow aubergine sierra leone bologi sea lettuce +> chicory broccoli collard greens turnip greens shallot radicchio komatsuna. +> Broccoli celery grape bell pepper kohlrabi radicchio sierra leone bologi."; + + return $messages; + } + + public function testMailCommentParseMessage() { + $messages = $this->mailCommentTestMessages(); + foreach ($messages as $key => $message) { + $text = _mailcomment_filter_aggressive($message); + $this->assertEqual($text, 'Hello world.', 'Filtered ' . $key); + } + } +} \ No newline at end of file