<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[7121] sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe: WPF Stripe: Add post type for email templates.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/7121">7121</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/7121","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-04-17 22:20:25 +0000 (Tue, 17 Apr 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>WPF Stripe: Add post type for email templates.
Props coreymckrill.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressfoundationorgpublic_htmlcontentpluginswpfstripewpfstripephp">sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/wpf-stripe.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressfoundationorgpublic_htmlcontentpluginswpfstripeemailphp">sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/email.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressfoundationorgpublic_htmlcontentpluginswpfstripeemailphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/email.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/email.php (rev 0)
+++ sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/email.php 2018-04-17 22:20:25 UTC (rev 7121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,266 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace WordPress_Foundation\Stripe\Email;
+
+use WordPress_Foundation\Stripe;
+use WP_Post;
+
+defined( 'WPINC' ) || die();
+
+const EMAIL_POST_TYPE = 'wpf_donation_email';
+
+/**
+ * Send a donation email.
+ *
+ * @param string $template_name
+ * @param array $transaction_data
+ */
+function send_email( $template_name, $transaction_data ) {
+ $transaction_data = wp_parse_args( $transaction_data, array(
+ 'email' => '',
+ ) );
+
+ $template = get_email_template( $template_name );
+
+ if ( ! $template ) {
+ Stripe\log( 'Email template is missing.', compact( 'template_name', 'transaction_data' ) );
+ return;
+ }
+
+ $to = $transaction_data['email'];
+ $subject = merge_template_data( $template->post_title, $transaction_data );
+ $message = merge_template_data( $template->post_content, $transaction_data );
+
+ if ( ! is_email( $to ) || empty( $subject ) || empty( $message ) ) {
+ Stripe\log( 'Invalid email parameters.', compact( 'to', 'subject', 'message' ) );
+ return;
+ }
+
+ //todo create multipart HTML/plaintext
+
+ $success = wp_mail( $to, $subject, $message );
+
+ if ( ! $success ) {
+ Stripe\log( 'Email failed to send.', compact( 'to', 'subject', 'message' ) );
+ }
+}
+
+/**
+ * List the possible template names for a donation email.
+ *
+ * @return array
+ */
+function get_template_names() {
+ return array(
+ 'upcoming-renewal',
+ 'thanks-one-time-donation',
+ 'thanks-recurring-donation',
+ );
+}
+
+/**
+ * Get a template post for a donation email.
+ *
+ * @param string $template_name
+ *
+ * @return WP_Post|bool
+ */
+function get_email_template( $template_name ) {
+ $query_args = array(
+ 'post_type' => EMAIL_POST_TYPE,
+ 'orderby' => 'date',
+ 'order' => 'DESC',
+ 'numberposts' => 1,
+ 'meta_key' => 'wpf-stripe_email-template-name',
+ 'meta_value' => $template_name,
+ );
+
+ $result = get_posts( $query_args );
+
+ if ( empty( $result ) ) {
+ return false;
+ }
+
+ $current_template = array_shift( $result );
+
+ return $current_template;
+}
+
+/**
+ * List the merge tags that can be used in a donation email template.
+ *
+ * @return array
+ */
+function get_merge_tags() {
+ return array(
+ 'full_name',
+ 'first_name',
+ 'last_name',
+ 'full_address',
+ 'address1',
+ 'address2',
+ 'city',
+ 'state',
+ 'zip_code',
+ 'country',
+ 'transaction_date',
+ 'transaction_amount',
+ 'payment_card_type',
+ 'payment_card_last4',
+ );
+}
+
+/**
+ * Take a template string with merge tags and replace the tags with data.
+ *
+ * Note that this should be used for both the email subject and message.
+ *
+ * @param string $template
+ * @param array $data
+ *
+ * @return null|string|string[]
+ */
+function merge_template_data( $template, $data ) {
+ foreach ( get_merge_tags() as $tag ) {
+ $replacement = ( array_key_exists( $tag, $data ) ) ? $data[ $tag ] : '';
+ $template = preg_replace( "#\{$tag\}#", $replacement, $template );
+ }
+
+ return $template;
+}
+
+/**
+ * Email template CPT.
+ */
+function register_post_type() {
+ $labels = array(
+ 'name' => 'Donation Email Templates',
+ 'singular_name' => 'Donation Email Template',
+ 'menu_name' => 'Donation Emails',
+ 'name_admin_bar' => 'Donation Email',
+ 'all_items' => 'All Email Templates',
+ 'add_new_item' => 'Add New Email Template',
+ 'add_new' => 'Add New',
+ 'new_item' => 'New Email Template',
+ 'edit_item' => 'Edit Email Template',
+ 'update_item' => 'Update Email Template',
+ 'view_item' => 'View Email Template',
+ 'view_items' => 'View Email Templates',
+ );
+
+ $args = array(
+ 'label' => __( 'Donation Email Templates', 'text_domain' ),
+ 'description' => __( 'Templates for emails sent to donors', 'text_domain' ),
+ 'labels' => $labels,
+ 'supports' => array( 'title', 'editor', 'author', 'revisions', 'custom-fields' ),
+ 'hierarchical' => false,
+ 'public' => false,
+ 'show_ui' => true,
+ );
+
+ \register_post_type( EMAIL_POST_TYPE, $args );
+}
+
+add_action( 'init', __NAMESPACE__ . '\register_post_type' );
+
+/**
+ * Add a help tab to the edit screen for email template posts.
+ */
+function add_contextual_help_tabs() {
+ global $typenow;
+
+ if ( ! isset( $typenow ) || EMAIL_POST_TYPE !== $typenow ){
+ return;
+ }
+
+ $screen = get_current_screen();
+
+ $tabs = array(
+ 'instructions' => 'Instructions',
+ );
+
+ foreach ( $tabs as $id => $label ) {
+ $screen->add_help_tab( array(
+ 'id' => 'wpf-stripe_' . $id,
+ 'title' => $label,
+ 'callback' => __NAMESPACE__ . '\render_contextual_help_tabs',
+ ) );
+ }
+}
+
+add_action( 'load-edit.php', __NAMESPACE__ . '\add_contextual_help_tabs' );
+add_action( 'load-post-new.php', __NAMESPACE__ . '\add_contextual_help_tabs' );
+
+/**
+ * Callback to render the help tab.
+ *
+ * @param \WP_Screen $screen
+ * @param array $tab
+ */
+function render_contextual_help_tabs( $screen, $tab ) {
+ $tab_id = str_replace( 'wpf-stripe_', '', $tab['id'] );
+
+ switch ( $tab_id ) {
+ case 'instructions' :
+ $merge_tags = get_merge_tags();
+ $template_names = get_template_names();
+
+ ?>
+
+ <p><strong>Donation Email Template Instructions</strong></p>
+ <p>The post title is the email <strong>subject</strong>, and the post content is the email <strong>message</strong>.</p>
+ <p>The following merge tags can be used in the subject and the message:</p>
+
+ <ul>
+ <?php foreach ( $merge_tags as $merge_tag ) : ?>
+ <li><code>{<?php echo $merge_tag; ?>}</code></li>
+ <?php endforeach; ?>
+ </ul>
+
+ <p>To assign a template to a particular donation email, create a custom field with <code>wpf-stripe_email-template-name</code> as the key and the email name as the value. The following emails need to have templates assigned to them:</p>
+
+ <ul>
+ <?php foreach ( $template_names as $template_name ) : ?>
+ <li><code><?php echo $template_name; ?></code></li>
+ <?php endforeach; ?>
+ </ul>
+
+ <?php
+ break;
+ }
+}
+
+/**
+ * Show admin notices.
+ */
+function admin_notices() {
+ $notices = array();
+
+ // Missing email templates.
+ $email_page_url = add_query_arg( 'post_type', EMAIL_POST_TYPE, admin_url( 'edit.php' ) );
+
+ foreach ( get_template_names() as $name ) {
+ $template = get_email_template( $name );
+
+ if ( ! $template ) {
+ $notices[] = sprintf(
+ 'The <code>%s</code> email does not have an assigned template. Check the Help tab for <a href="%s">Donation Email Templates</a> for more information.',
+ esc_html( $name ),
+ esc_url( $email_page_url )
+ );
+ }
+ }
+
+ // Output all notices.
+ foreach ( $notices as $notice ) {
+ ?>
+
+ <div class="notice notice-error">
+ <?php echo wpautop( $notice ); ?>
+ </div>
+
+ <?php
+ }
+}
+
+add_action( 'admin_notices', __NAMESPACE__ . '\admin_notices' );
</ins></span></pre></div>
<a id="sitestrunkwordpressfoundationorgpublic_htmlcontentpluginswpfstripewpfstripephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/wpf-stripe.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/wpf-stripe.php 2018-04-17 22:20:22 UTC (rev 7120)
+++ sites/trunk/wordpressfoundation.org/public_html/content/plugins/wpf-stripe/wpf-stripe.php 2018-04-17 22:20:25 UTC (rev 7121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,6 +14,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> defined( 'WPINC' ) || die();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require_once( __DIR__ . '/email.php' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Display Stripe donate buttons.
</span></span></pre>
</div>
</div>
</body>
</html>