<!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>[BuddyPress][11875] trunk/src/bp-core: Centralize the generation of the cover image upload directory.</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 { 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://buddypress.trac.wordpress.org/changeset/11875">11875</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/11875","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-03-02 19:37:55 +0000 (Fri, 02 Mar 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'>Centralize the generation of the cover image upload directory.
By using `bp_attachments_cover_image_upload_dir()` wherever the cover image
directory is needed, we ensure that it's possible to filter consistently, for
installations (such as multi-network installations) that may want a custom
location for these files.
Props rekmla, imath.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7265">#7265</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreattachmentsphp">trunk/src/bp-core/bp-core-attachments.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpattachmentcoverimagephp">trunk/src/bp-core/classes/class-bp-attachment-cover-image.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreattachmentsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-attachments.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-attachments.php 2018-03-02 02:06:51 UTC (rev 11874)
+++ trunk/src/bp-core/bp-core-attachments.php 2018-03-02 19:37:55 UTC (rev 11875)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,6 +84,58 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the upload dir array for cover images.
+ *
+ * @since 3.0.0
+ *
+ * @return array See wp_upload_dir().
+ */
+function bp_attachments_cover_image_upload_dir( $args = array() ) {
+ // Default values are for profiles.
+ $object_id = bp_displayed_user_id();
+
+ if ( empty( $object_id ) ) {
+ $object_id = bp_loggedin_user_id();
+ }
+
+ $object_directory = 'members';
+
+ // We're in a group, edit default values.
+ if ( bp_is_group() || bp_is_group_create() ) {
+ $object_id = bp_get_current_group_id();
+ $object_directory = 'groups';
+ }
+
+ $r = bp_parse_args( $args, array(
+ 'object_id' => $object_id,
+ 'object_directory' => $object_directory,
+ ), 'cover_image_upload_dir' );
+
+
+ // Set the subdir.
+ $subdir = '/' . $r['object_directory'] . '/' . $r['object_id'] . '/cover-image';
+
+ $upload_dir = bp_attachments_uploads_dir_get();
+
+ /**
+ * Filters the cover image upload directory.
+ *
+ * @since 2.4.0
+ *
+ * @param array $value Array containing the path, URL, and other helpful settings.
+ * @param array $upload_dir The original Uploads dir.
+ */
+ return apply_filters( 'bp_attachments_cover_image_upload_dir', array(
+ 'path' => $upload_dir['basedir'] . $subdir,
+ 'url' => set_url_scheme( $upload_dir['baseurl'] ) . $subdir,
+ 'subdir' => $subdir,
+ 'basedir' => $upload_dir['basedir'],
+ 'baseurl' => set_url_scheme( $upload_dir['baseurl'] ),
+ 'error' => false,
+ ), $upload_dir );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get the max upload file size for any attachment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.4.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -312,7 +364,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment_data = call_user_func_array( $r['component'] . '_avatar_upload_dir', $dir_args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'cover_image' === $type ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment_data = bp_attachments_uploads_dir_get();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment_data = bp_attachments_cover_image_upload_dir();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The BP Attachments Uploads Dir is not set, stop.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $attachment_data ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1130,8 +1182,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cover_image_class = new BP_Attachment_Cover_Image();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $upload_dir = bp_attachments_cover_image_upload_dir();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Make sure the file is inside the Cover Image Upload path.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( false === strpos( $args['file'], $cover_image_class->upload_path ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === strpos( $args['file'], $upload_dir['basedir'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1290,7 +1344,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $error_message = __( 'There was a problem uploading the cover image.', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bp_attachments_uploads_dir = bp_attachments_uploads_dir_get();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $bp_attachments_uploads_dir = bp_attachments_cover_image_upload_dir();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The BP Attachments Uploads Dir is not set, stop.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $bp_attachments_uploads_dir ) {
</span></span></pre></div>
<a id="trunksrcbpcoreclassesclassbpattachmentcoverimagephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-attachment-cover-image.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-attachment-cover-image.php 2018-03-02 02:06:51 UTC (rev 11874)
+++ trunk/src/bp-core/classes/class-bp-attachment-cover-image.php 2018-03-02 19:37:55 UTC (rev 11875)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,40 +96,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array $value Upload data (path, url, basedir...).
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function upload_dir_filter( $upload_dir = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Default values are for profiles.
- $object_id = bp_displayed_user_id();
-
- if ( empty( $object_id ) ) {
- $object_id = bp_loggedin_user_id();
- }
-
- $object_directory = 'members';
-
- // We're in a group, edit default values.
- if ( bp_is_group() || bp_is_group_create() ) {
- $object_id = bp_get_current_group_id();
- $object_directory = 'groups';
- }
-
- // Set the subdir.
- $subdir = '/' . $object_directory . '/' . $object_id . '/cover-image';
-
- /**
- * Filters the cover image upload directory.
- *
- * @since 2.4.0
- *
- * @param array $value Array containing the path, URL, and other helpful settings.
- * @param array $upload_dir The original Uploads dir.
- */
- return apply_filters( 'bp_attachments_cover_image_upload_dir', array(
- 'path' => $this->upload_path . $subdir,
- 'url' => $this->url . $subdir,
- 'subdir' => $subdir,
- 'basedir' => $this->upload_path,
- 'baseurl' => $this->url,
- 'error' => false
- ), $upload_dir );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_attachments_cover_image_upload_dir();
</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"> /**
</span></span></pre>
</div>
</div>
</body>
</html>