Ticket #6592: 6592-posttype.01.patch

src/bp-core/bp-core-admin.php

@@ -295 +295 @@
                         'bp_core_admin_tools'
                 );
 
-                // Fudge the highlighted subnav item when on a BuddyPress admin page.
                 foreach( $hooks as $hook ) {
                         add_action( "admin_head-$hook", 'bp_core_modify_admin_menu_highlight' );
                 }
@@ -767 +766 @@
                                 <a href="https://github.com/ichord/At.js">At.js</a>,
                                 <a href="https://bbpress.org">bbPress</a>,
                                 <a href="https://github.com/ichord/Caret.js">Caret.js</a>,
+                                <a href="http://tedgoas.github.io/Cerberus/">Cerberus</a>,
                                 <a href="https://github.com/carhartl/jquery-cookie">jquery.cookie</a>,
                                 <a href="https://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a>,
                                 <a href="https://wordpress.org">WordPress</a>.
@@ -876 +876 @@
         }
 
         /**
+         * Add Emails menu item to custom menus array.
+         *
+         * Several BuddyPress components have top-level menu items in the Dashboard,
+         * which all appear together in the middle of the Dashboard menu. This function
+         * adds the Emails screen to the array of these menu items.
+         *
+         * @since 2.4.0
+         *
+         * @param array $custom_menus The list of top-level BP menu items.
+         * @return array $custom_menus List of top-level BP menu items, with Emails added.
+         */
+        public function emails_admin_menu_order( $custom_menus = array() ) {
+                array_push( $custom_menus, 'edit.php?post_type=' . bp_get_email_post_type() );
+                return $custom_menus;
+        }
+
+        /**
          * Register styles commonly used by BuddyPress wp-admin screens.
          *
          * @since 2.5.0

src/bp-core/bp-core-filters.php

@@ -1038 +1038 @@
         return $params;
 }
 add_filter( 'dynamic_sidebar_params', '_bp_core_inject_bp_widget_css_class' );
+
+/**
+ * Find and render the template for Email posts (the Customizer and admin previews).
+ *
+ * Misuses the `template_include` filter which expects a string, but as we need to replace
+ * the `{{{content}}}` token with the post's content, we use object buffering to load the
+ * template, replace the token, and render it.
+ *
+ * The function returns an empty string to prevent WordPress rendering another template.
+ *
+ * @since 2.5.0
+ *
+ * @param string $template Path to template (probably single.php).
+ * @return string
+ */
+function bp_core_render_email_template( $template ) {
+        if ( get_post_type() !== bp_get_email_post_type() || ! is_single() ) {
+                return $template;
+        }
+
+        /**
+         * Filter template used to display Email posts.
+         *
+         * @since 2.5.0
+         *
+         * @param string $template Path to current template (probably single.php).
+         */
+        $email_template = apply_filters( 'bp_core_render_email_template',
+                bp_locate_template( bp_email_get_template( get_queried_object() ), false ),
+                $template
+        );
+
+        if ( ! $email_template ) {
+                return $template;
+        }
+
+        ob_start();
+        include( $email_template );
+        $template = ob_get_contents();
+        ob_end_clean();
+
+        echo str_replace( '{{{content}}}', nl2br( get_post()->post_content ), $template );
+
+        /*
+         * Link colours are applied directly in the email template before sending, so we
+         * need to add an extra style here to set the colour for the Customizer or preview.
+         */
+        $settings = bp_email_get_appearance_settings();
+        printf(
+                '<style>a { color: %s; }</style>',
+                esc_attr( $settings['highlight_color'] )
+        );
+
+        return '';
+}
+add_action( 'bp_template_include', 'bp_core_render_email_template', 12 );

src/bp-core/bp-core-functions.php

@@ -2591 +2591 @@
 
         return $bp->upload_dir;
 }
+
+
+/** Post Types *****************************************************************/
+
+/**
+ * Output the name of the email post type.
+ *
+ * @since 2.5.0
+ */
+function bp_email_post_type() {
+        echo bp_get_email_post_type();
+}
+        /**
+         * Returns the name of the email post type.
+         *
+         * @since 2.5.0
+         *
+         * @return string The name of the email post type.
+         */
+        function bp_get_email_post_type() {
+
+                /**
+                 * Filters the name of the email post type.
+                 *
+                 * @since 2.5.0
+                 *
+                 * @param string $post_type Email post type name.
+                 */
+                return apply_filters( 'bp_get_email_post_type', buddypress()->email_post_type );
+        }
+
+/**
+ * Return labels used by the email post type.
+ *
+ * @since 2.5.0
+ *
+ * @return array
+ */
+function bp_get_email_post_type_labels() {
+
+        /**
+         * Filters email post type labels.
+         *
+         * @since 2.5.0
+         *
+         * @param string[] $labels Associative array (name => label).
+         */
+        return apply_filters( 'bp_get_email_post_type_labels', array(
+                'add_new'               => _x( 'Add New', 'email post type label', 'buddypress' ),
+                'add_new_item'          => _x( 'Add a New Email', 'email post type label', 'buddypress' ),
+                'all_items'             => _x( 'All Emails', 'email post type label', 'buddypress' ),
+                'edit_item'             => _x( 'Edit Email', 'email post type label', 'buddypress' ),
+                'filter_items_list'     => _x( 'Filter email list', 'email post type label', 'buddypress' ),
+                'items_list'            => _x( 'Email list', 'email post type label', 'buddypress' ),
+                'items_list_navigation' => _x( 'Email list navigation', 'email post type label', 'buddypress' ),
+                'name'                  => _x( 'Emails', 'email post type name', 'buddypress' ),
+                'new_item'              => _x( 'New Email', 'email post type label', 'buddypress' ),
+                'not_found'             => _x( 'No emails found', 'email post type label', 'buddypress' ),
+                'not_found_in_trash'    => _x( 'No emails found in Trash', 'email post type label', 'buddypress' ),
+                'search_items'          => _x( 'Search Emails', 'email post type label', 'buddypress' ),
+                'singular_name'         => _x( 'Email', 'email post type singular name', 'buddypress' ),
+                'uploaded_to_this_item' => _x( 'Uploaded to this email', 'email post type label', 'buddypress' ),
+                'view_item'             => _x( 'View Email', 'email post type label', 'buddypress' ),
+        ) );
+}
+
+/**
+ * Return array of features that the email post type supports.
+ *
+ * @since 2.5.0
+ *
+ * @return array
+ */
+function bp_get_email_post_type_supports() {
+
+        /**
+         * Filters the features that the email post type supports.
+         *
+         * @since 2.5.0
+         *
+         * @param string[] $features Supported features.
+         */
+        return apply_filters( 'bp_get_email_post_type_supports', array(
+                'editor',
+                'excerpt',
+                'revisions',
+                'title',
+        ) );
+}
+
+
+/** Taxonomies *****************************************************************/
+
+/**
+ * Output the name of the email type taxonomy.
+ *
+ * @since 2.5.0
+ */
+function bp_email_tax_type() {
+        echo bp_get_email_tax_type();
+}
+        /**
+         * Return the name of the email type taxonomy.
+         *
+         * @since 2.5.0
+         *
+         * @return string The unique email taxonomy type ID.
+         */
+        function bp_get_email_tax_type() {
+
+                /**
+                 * Filters the name of the email type taxonomy.
+                 *
+                 * @since 2.5.0
+                 *
+                 * @param string $taxonomy Email type taxonomy name.
+                 */
+                return apply_filters( 'bp_get_email_tax_type', buddypress()->email_taxonomy_type );
+        }
+
+/**
+ * Return labels used by the email type taxonomy.
+ *
+ * @since 2.5.0
+ *
+ * @return string[]
+ */
+function bp_get_email_tax_type_labels() {
+
+        /**
+         * Filters email type taxonomy labels.
+         *
+         * @since 2.5.0
+         *
+         * @param string[] $labels Associative array (name => label).
+         */
+        return apply_filters( 'bp_get_email_tax_type_labels', array(
+                'add_new_item'          => _x( 'New Email Type', 'email type taxonomy label', 'buddypress' ),
+                'all_items'             => _x( 'All Email Types', 'email type taxonomy label', 'buddypress' ),
+                'edit_item'             => _x( 'Edit Email Types', 'email type taxonomy label', 'buddypress' ),
+                'items_list'            => _x( 'Email list', 'email type taxonomy label', 'buddypress' ),
+                'items_list_navigation' => _x( 'Email list navigation', 'email type taxonomy label', 'buddypress' ),
+                'menu_name'             => _x( 'Types', 'email type taxonomy label', 'buddypress' ),
+                'name'                  => _x( 'Email Types', 'email type taxonomy name', 'buddypress' ),
+                'new_item_name'         => _x( 'New Email Type Name', 'email type taxonomy label', 'buddypress' ),
+                'not_found'             => _x( 'No email types found.', 'email type taxonomy label', 'buddypress' ),
+                'no_terms'              => _x( 'No email types', 'email type taxonomy label', 'buddypress' ),
+                'popular_items'         => _x( 'Popular Email Types', 'email type taxonomy label', 'buddypress' ),
+                'search_items'          => _x( 'Search Emails', 'email type taxonomy label', 'buddypress' ),
+                'singular_name'         => _x( 'Email', 'email type taxonomy singular name', 'buddypress' ),
+                'update_item'           => _x( 'Update Email Type', 'email type taxonomy label', 'buddypress' ),
+                'view_item'             => _x( 'View Email Type', 'email type taxonomy label', 'buddypress' ),
+        ) );
+}
+
+/**
+ * Get the paths to possible templates for the specified email object.
+ *
+ * @since 2.5.0
+ *
+ * @param WP_Post $object Post to get email template for.
+ * @return string[]
+ */
+function bp_email_get_template( WP_Post $object ) {
+        $single = "single-{$object->post_type}";
+
+        /**
+         * Filter the possible template paths for the specified email object.
+         *
+         * @since 2.5.0
+         *
+         * @param string[] $templates
+         */
+        return apply_filters( 'bp_email_get_template', array(
+                "{$single}-{$object->post_name}.php",
+                "{$single}.php",
+                "assets/emails/{$single}.php",
+        ), $object );
+}

src/bp-core/bp-core-loader.php

@@ -285 +285 @@
 
                 parent::setup_cache_groups();
         }
+
+        /**
+         * Set up post types.
+         *
+         * @since BuddyPress (2.4.0)
+         */
+        public function register_post_types() {
+
+                // Emails
+                register_post_type(
+                        bp_get_email_post_type(),
+                        apply_filters( 'bp_register_email_post_type', array(
+                                //'capability_type'   => array( 'bpemail', 'bpemails' ), TODO
+                                'description'       => _x( 'BuddyPress emails', 'email post type description', 'buddypress' ),
+                                'labels'            => bp_get_email_post_type_labels(),
+                                'menu_icon'         => 'dashicons-email',
+                                'public'            => false,
+                                'publicly_queryable' => bp_current_user_can( 'bp_moderate' ),
+                                'query_var'         => false,
+                                'rewrite'           => false,
+                                'show_in_admin_bar' => false,
+                                'show_ui'           => bp_current_user_can( 'bp_moderate' ),  // TODO
+                                'supports'          => bp_get_email_post_type_supports(),
+                        ) )
+                );
+
+                parent::register_post_types();
+        }
 }
 
 /**

src/bp-core/bp-core-taxonomy.php

@@ -24 +24 @@
         register_taxonomy( 'bp_member_type', 'user', array(
                 'public' => false,
         ) );
+
+        // Email type.
+        register_taxonomy(
+                bp_get_email_tax_type(),
+                bp_get_email_post_type(),
+                apply_filters( 'bp_register_email_tax_type', array(
+                        'description'       => _x( 'BuddyPress email types', 'email type taxonomy description', 'buddypress' ),
+                        'labels'            => bp_get_email_tax_type_labels(),
+                        'public'            => false,
+                        'query_var'         => false,
+                        'rewrite'           => false,
+                        'show_admin_column' => true,
+                        'show_tagcloud'     => false,
+                        'show_ui'           => bp_current_user_can( 'bp_moderate' ),  // TODO
+                ) )
+        );
 }
 add_action( 'bp_register_taxonomies', 'bp_register_default_taxonomies' );
 

src/bp-core/bp-core-update.php

@@ -213 +213 @@
                 bp_core_install( $default_components );
                 bp_update_option( 'bp-active-components', $default_components );
                 bp_core_add_page_mappings( $default_components, 'delete' );
+                bp_core_install_emails();
 
         // Upgrades
         } else {
@@ -260 +261 @@
                 if ( $raw_db_version < 9615 ) {
                         bp_update_to_2_3();
                 }
+
+                // 2.5.0
+                if ( $raw_db_version < 10440 ) {
+                        bp_update_to_2_5();
+                }
         }
 
         /** All done! *************************************************************/
@@ -484 +490 @@
 }
 
 /**
+ * 2.5.0 update routine.
+ *
+ * - Add emails.
+ *
+ * @since 2.5.0
+ */
+function bp_update_to_2_5() {
+        bp_core_install_emails();
+}
+
+/**
  * Updates the component field for new_members type.
  *
  * @since 2.2.0

src/bp-loader.php

@@ -328 +328 @@
                 /** Versions **********************************************************/
 
                 $this->version    = '2.5.0-alpha';
-                $this->db_version = 10071;
+                $this->db_version = 10440;
 
                 /** Loading ***********************************************************/
 
@@ -422 +422 @@
 
                 $this->current_user   = new stdClass();
                 $this->displayed_user = new stdClass();
+
+                /** Post types and taxonomies *****************************************/
+                $this->email_post_type     = apply_filters( 'bp_email_post_type', 'bp-email' );
+                $this->email_taxonomy_type = apply_filters( 'bp_email_tax_type', 'bp-email-type' );
         }
 
         /**

new file src/bp-templates/bp-legacy/buddypress/assets/emails/single-bp-email.php

@@ +1 @@
+<?php
+/**
+ * BuddyPress email template.
+ *
+ * Magic numbers:
+ *  1.618 = golden mean.
+ *  1.35  = default body_text_size multipler. Gives default heading of 20px.
+ * @since 2.5.0
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ */
+
+/*
+Based on the Cerberus "Fluid" template by Ted Goas (http://tedgoas.github.io/Cerberus/).
+License for the original template:
+
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Ted Goas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+$settings = bp_email_get_appearance_settings();
+
+?><!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>
+        <meta charset="<?php echo esc_attr( get_bloginfo( 'charset' ) ); ?>">
+        <meta name="viewport" content="width=device-width"> <!-- Forcing initial-scale shouldn't be necessary -->
+        <meta http-equiv="X-UA-Compatible" content="IE=edge"> <!-- Use the latest (edge) version of IE rendering engine -->
+        <title></title> <!-- The title tag shows in email notifications, like Android 4.4. -->
+
+        <!-- CSS Reset -->
+        <style type="text/css">
+                /* What it does: Remove spaces around the email design added by some email clients. */
+                /* Beware: It can remove the padding / margin and add a background color to the compose a reply window. */
+                html,
+                body {
+                        Margin: 0 !important;
+                        padding: 0 !important;
+                        height: 100% !important;
+                        width: 100% !important;
+                }
+
+                /* What it does: Stops email clients resizing small text. */
+                * {
+                        -ms-text-size-adjust: 100%;
+                        -webkit-text-size-adjust: 100%;
+                }
+
+                /* What it does: Forces Outlook.com to display emails full width. */
+                .ExternalClass {
+                        width: 100%;
+                }
+
+                /* What is does: Centers email on Android 4.4 */
+                div[style*="margin: 16px 0"] {
+                        margin: 0 !important;
+                }
+
+                /* What it does: Stops Outlook from adding extra spacing to tables. */
+                table,
+                td {
+                        mso-table-lspace: 0pt !important;
+                        mso-table-rspace: 0pt !important;
+                }
+
+                /* What it does: Fixes webkit padding issue. Fix for Yahoo mail table alignment bug. Applies table-layout to the first 2 tables then removes for anything nested deeper. */
+                table {
+                        border-spacing: 0 !important;
+                        border-collapse: collapse !important;
+                        table-layout: fixed !important;
+                        Margin: 0 auto !important;
+                }
+                table table table {
+                        table-layout: auto;
+                }
+
+                /* What it does: Uses a better rendering method when resizing images in IE. */
+                img {
+                        -ms-interpolation-mode:bicubic;
+                }
+
+                /* What it does: Overrides styles added when Yahoo's auto-senses a link. */
+                .yshortcuts a {
+                        border-bottom: none !important;
+                }
+
+                /* What it does: A work-around for iOS meddling in triggered links. */
+                a[x-apple-data-detectors] {
+                        color: inherit !important;
+                        text-decoration: underline !important;
+                }
+        </style>
+
+</head>
+<body class="email_bg" width="100%" height="100%" bgcolor="<?php echo esc_attr( $settings['email_bg'] ); ?>" style="Margin: 0;">
+<table cellpadding="0" cellspacing="0" border="0" height="100%" width="100%" bgcolor="<?php echo esc_attr( $settings['email_bg'] ); ?>" style="border-collapse:collapse;" class="email_bg"><tr><td valign="top">
+        <center style="width: 100%;">
+
+                <!-- Visually Hidden Preheader Text : BEGIN -->
+                <div style="display: none; font-size: 1px; line-height: 1px; max-height: 0px; max-width: 0px; opacity: 0; overflow: hidden; mso-hide: all; font-family: sans-serif;">
+                        (Optional) This text will appear in the inbox preview, but not the email body.
+                </div>
+                <!-- Visually Hidden Preheader Text : END -->
+
+                <div style="max-width: 600px;">
+                        <!--[if (gte mso 9)|(IE)]>
+                        <table cellspacing="0" cellpadding="0" border="0" width="600" align="center">
+                        <tr>
+                        <td>
+                        <![endif]-->
+
+                        <!-- Email Header : BEGIN -->
+                        <table cellspacing="0" cellpadding="0" border="0" align="center" width="100%" style="max-width: 600px; border-top: 7px solid <?php echo esc_attr( $settings['highlight_color'] ); ?>" class="header_bg">
+                                <tr>
+                                        <td style="text-align: center; padding: 15px 0; font-family: sans-serif; mso-height-rule: exactly; font-weight: bold; color: <?php echo esc_attr( $settings['header_text_color'] ); ?>; font-size: <?php echo esc_attr( $settings['header_text_size'] . 'px' ); ?>" class="header_text_color header_text_size">
+                                                <?php echo bp_get_option( 'blogname' ); ?>
+                                        </td>
+                                </tr>
+                        </table>
+                        <!-- Email Header : END -->
+
+                        <!-- Email Body : BEGIN -->
+                        <table cellspacing="0" cellpadding="0" border="0" align="center" bgcolor="<?php echo esc_attr( $settings['body_bg'] ); ?>" width="100%" style="max-width: 600px; border-radius: 5px;" class="body_bg">
+
+                                <!-- 1 Column Text : BEGIN -->
+                                <tr>
+                                        <td>
+                                                <table cellspacing="0" cellpadding="0" border="0" width="100%">
+                                                  <tr>
+                                                                <td style="padding: 20px; font-family: sans-serif; mso-height-rule: exactly; line-height: <?php echo esc_attr( floor( $settings['body_text_size'] * 1.618 ) . 'px' ) ?>; color: <?php echo esc_attr( $settings['body_text_color'] ); ?>; font-size: <?php echo esc_attr( $settings['body_text_size'] . 'px' ); ?>" class="body_text_color body_text_size">
+                                                                        <span style="font-weight: bold; font-size: <?php echo esc_attr( floor( $settings['body_text_size'] * 1.35 ) . 'px' ); ?>" class="welcome">Hi Paul Gibbs,</span>
+                                                                        <hr color="<?php echo esc_attr( $settings['email_bg'] ); ?>"><br>
+                                                                        {{{content}}}
+                                                                </td>
+                                                  </tr>
+                                                </table>
+                                        </td>
+                                </tr>
+                                <!-- 1 Column Text : BEGIN -->
+
+                        </table>
+                        <!-- Email Body : END -->
+
+                        <!-- Email Footer : BEGIN -->
+                        <br>
+                        <table cellspacing="0" cellpadding="0" border="0" align="left" width="100%" style="max-width: 600px; border-radius: 5px;" bgcolor="<?php echo esc_attr( $settings['footer_bg'] ); ?>" class="footer_bg">
+                                <tr>
+                                        <td style="padding: 20px; width: 100%; font-size: <?php echo esc_attr( $settings['footer_text_size'] . 'px' ); ?>; font-family: sans-serif; mso-height-rule: exactly; line-height: <?php echo esc_attr( floor( $settings['footer_text_size'] * 1.618 ) . 'px' ) ?>; text-align: left; color: <?php echo esc_attr( $settings['footer_text_color'] ); ?>;" class="footer_text_color footer_text_size">
+                                                <span class="footer_text"><?php echo nl2br( $settings['footer_text'] ); ?></span>
+                                                <br><br>
+                                                <a href="{{{unsubscribe}}}" style="text-decoration: underline;"><?php _ex( 'unsubscribe', 'email', 'buddypress' ); ?></a>
+                                        </td>
+                                </tr>
+                        </table>
+                        <!-- Email Footer : END -->
+
+                        <!--[if (gte mso 9)|(IE)]>
+                        </td>
+                        </tr>
+                        </table>
+                        <![endif]-->
+                </div>
+        </center>
+</td></tr></table>
+<?php if ( is_customize_preview() ) wp_footer(); ?>
+</body>
+</html>