<!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][9874] trunk: In `BP_Attachment->upload()`, only filter the WordPress upload_dir if the callback function is set.</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/9874">9874</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/9874","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-17 11:14:39 +0000 (Sun, 17 May 2015)</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'>In `BP_Attachment->upload()`, only filter the WordPress upload_dir if the callback function is set.
This callback function can be passed as the second argument of `BP_Attachment->upload()`, or dynamically created if the specific `$base_dir` parameter was provided by the extending class.
About this second case, if the extending class forgets to set the `$base_dir` parameter or do it on purpose in order to use the WordPress default upload directory, we will not filter the WordPress upload_dir to avoid a warning.
This commit also adds a third argument to `BP_Attachment->upload()`, in case there is a need to pass a specific time (yyyy/mm) to set the WordPress default upload sub directory.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6438">#6438</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpattachmentphp">trunk/src/bp-core/classes/class-bp-attachment.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpattachmentphp">trunk/tests/phpunit/testcases/core/class-bp-attachment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpattachmentphp"></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.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.php 2015-05-17 01:54:51 UTC (rev 9873)
+++ trunk/src/bp-core/classes/class-bp-attachment.php 2015-05-17 11:14:39 UTC (rev 9874)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,6 +196,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $file The appropriate entry the from $_FILES superglobal.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $upload_dir_filter A specific filter to be applied to 'upload_dir' (optional).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @uses wp_handle_upload() To upload the file
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses add_filter() To temporarly overrides WordPress uploads data
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses remove_filter() To stop overriding WordPress uploads data
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,7 +206,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * On failure, returns an array containing the error message
</span><span class="cx" style="display: block; padding: 0 10px"> * (eg: array( 'error' => $message ) )
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function upload( $file, $upload_dir_filter = '' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function upload( $file, $upload_dir_filter = '', $time = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Upload action and the file input name are required parameters
</span><span class="cx" style="display: block; padding: 0 10px"> * @see BP_Attachment:__construct()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,13 +265,17 @@
</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"> // Make sure the file will be uploaded in the attachment directory
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $upload_dir_filter ) ) {
+ add_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Upload the attachment
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->attachment = wp_handle_upload( $file[ $this->file_input ], $overrides );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->attachment = wp_handle_upload( $file[ $this->file_input ], $overrides, $time );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Restore WordPress Uploads data
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $upload_dir_filter ) ) {
+ remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove the pre WordPress 4.0 static filter
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'wp_handle_upload_prefilter', array( $this, 'validate_upload' ), 10, 1 );
</span></span></pre></div>
<a id="trunktestsphpunittestcasescoreclassbpattachmentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/class-bp-attachment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/class-bp-attachment.php 2015-05-17 01:54:51 UTC (rev 9873)
+++ trunk/tests/phpunit/testcases/core/class-bp-attachment.php 2015-05-17 11:14:39 UTC (rev 9874)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,9 +13,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function setUp() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_attachment_upload_overrides', array( $this, 'filter_overrides' ), 10, 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'bp_attachment_upload_dir', array( $this, 'filter_upload_dir' ), 10, 1 );
- add_filter( 'xprofile_avatar_upload_dir', array( $this, 'filter_upload_dir' ), 10, 1 );
- add_filter( 'groups_avatar_upload_dir', array( $this, 'filter_upload_dir' ), 10, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'upload_dir', array( $this, 'filter_upload_dir' ), 20, 1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->upload_results = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image_file = trailingslashit( buddypress()->plugin_dir ) . 'bp-core/images/mystery-man.jpg';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,9 +21,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function tearDown() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'bp_attachment_upload_overrides', array( $this, 'filter_overrides' ), 10, 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'bp_attachment_upload_dir', array( $this, 'filter_upload_dir' ), 10, 1 );
- remove_filter( 'xprofile_avatar_upload_dir', array( $this, 'filter_upload_dir' ), 10, 1 );
- remove_filter( 'groups_avatar_upload_dir', array( $this, 'filter_upload_dir' ), 10, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'upload_dir', array( $this, 'filter_upload_dir' ), 20, 1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->upload_results = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image_file = '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,6 +171,39 @@
</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"> * @group upload
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ */
+ public function test_bp_attachment_upload_no_base_dir_specific_time() {
+ $reset_files = $_FILES;
+ $reset_post = $_POST;
+
+ $attachment_class = new BPTest_Attachment_Extension( array(
+ 'action' => 'attachment_action',
+ 'file_input' => 'attachment_file_input',
+ ) );
+
+ $_POST['action'] = $attachment_class->action;
+ $_FILES[ $attachment_class->file_input ] = array(
+ 'tmp_name' => $this->image_file,
+ 'name' => 'mystery-man.jpg',
+ 'type' => 'image/jpeg',
+ 'error' => 0,
+ 'size' => filesize( $this->image_file ),
+ );
+
+ $time = '2015/01';
+
+ $upload = $attachment_class->upload( $_FILES, '', $time );
+
+ // If no base_dir was provided, default WordPress uploads dir should be used.
+ $this->assertEquals( $upload['file'], $attachment_class->upload_path . '/' . $time . '/mystery-man.jpg' );
+
+ // clean up!
+ $_FILES = $reset_files;
+ $_POST = $reset_post;
+ }
+
+ /**
+ * @group upload
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group avatar
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_bp_attachment_avatar_user_upload() {
</span></span></pre>
</div>
</div>
</body>
</html>