<!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][9660] trunk/src/bp-core/classes: Improve the `BP_Attachment` class</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/9660">9660</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/9660","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-03-29 18:25:35 +0000 (Sun, 29 Mar 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'>Improve the `BP_Attachment` class
- abstract the `BP_Attachment` class, so it must be extended,
- avoid using `get_class_vars( __CLASS__ )` to get the default values in the constructor,
- sanitize the base_dir if set,
- make sure the action and file_input parameters are sanitized,
- use a `is_dir()` check instead of a `file_exists()` one when checking if the upload_path exists,
- use `bp_parse_args()` in the `BP_Attachment->crop()` method and include a filter,
- improve code formatting.
Props DJPaul
See <a href="http://buddypress.trac.wordpress.org/ticket/6278">#6278</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpattachmentavatarphp">trunk/src/bp-core/classes/class-bp-attachment-avatar.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpattachmentphp">trunk/src/bp-core/classes/class-bp-attachment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpattachmentavatarphp"></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-avatar.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-avatar.php 2015-03-29 04:33:08 UTC (rev 9659)
+++ trunk/src/bp-core/classes/class-bp-attachment-avatar.php 2015-03-29 18:25:35 UTC (rev 9660)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,7 +85,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $file['error'] = 9;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // File is of invalid type
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else if ( ! bp_core_check_avatar_type( array( 'file' => $file ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( ! bp_core_check_avatar_type( array( 'file' => $file ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $file['error'] = 10;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<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-03-29 04:33:08 UTC (rev 9659)
+++ trunk/src/bp-core/classes/class-bp-attachment.php 2015-03-29 18:25:35 UTC (rev 9660)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,7 +16,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (2.3.0)
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-class BP_Attachment {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+abstract class BP_Attachment {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** Upload properties *****************************************************/
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,56 +28,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $attachment = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Maximum file size in kilobytes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The default args to be merged with the
+ * ones passed by the child class
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var int
- */
- public $original_max_filesize = 0;
-
- /**
- * List of allowed file extensions
- * Defaults to get_allowed_mime_types()
- *
- * @var int
- */
- public $allowed_mime_types = array();
-
- /**
- * component's upload base directory.
- *
- * @var string
- */
- public $base_dir = '';
-
- /**
- * The upload action.
- *
- * @var string
- */
- public $action = '';
-
- /**
- * The file input name attribute
- *
- * @var string
- */
- public $file_input = '';
-
- /**
- * List of upload errors.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @var array
</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 $upload_error_strings = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $default_args = array(
+ 'original_max_filesize' => 0,
+ 'allowed_mime_types' => array(),
+ 'base_dir' => '',
+ 'action' => '',
+ 'file_input' => '',
+ 'upload_error_strings' => array(),
+ 'required_wp_files' => array( 'file' ),
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * List of required core files
- *
- * @var array
- */
- public $required_wp_files = array( 'file' );
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Construct Upload parameters
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (2.3.0)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,14 +79,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Max file size defaults to php ini settings or, in the case of
</span><span class="cx" style="display: block; padding: 0 10px"> * a multisite config, the root site fileupload_maxk option
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->original_max_filesize = (int) wp_max_upload_size();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->default_args['original_max_filesize'] = (int) wp_max_upload_size();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $params = bp_parse_args( $args, get_class_vars( __CLASS__ ), $this->action . '_upload_params' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $params = bp_parse_args( $args, $this->default_args, $this->action . '_upload_params' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $params as $key => $param ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'upload_error_strings' === $key ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->{$key} = $this->set_upload_error_strings( $param );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Sanitize the base dir
+ } elseif ( 'base_dir' === $key ) {
+ $this->{$key} = sanitize_title( $param );
+
+ // Action & File input are already set and sanitized
+ } elseif ( 'action' !== $key && 'file_input' !== $key ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->{$key} = $param;
</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">@@ -315,7 +287,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Set the allowed mimes for the upload
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $this->allowed_mime_types as $ext ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wp_mimes as $ext_pattern => $mime ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $ext != '' && strpos( $ext_pattern, $ext ) !== false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $ext !== '' && strpos( $ext_pattern, $ext ) !== false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $valid_mimes[$ext_pattern] = $mime;
</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">@@ -395,7 +367,7 @@
</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"> // Check if upload path already exists
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! file_exists( $this->upload_path ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_dir( $this->upload_path ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If path does not exist, attempt to create it
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_mkdir_p( $this->upload_path ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -429,7 +401,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function crop( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_error = new WP_Error();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_parse_args( $args, array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = bp_parse_args( $args, array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'original_file' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'crop_x' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'crop_y' => 0,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -439,7 +411,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'dst_h' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'src_abs' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'dst_file' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ), 'bp_attachment_crop_args' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['original_file'] ) || ! file_exists( $r['original_file'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_error->add( 'crop_error', __( 'Cropping the file failed: missing source file.', 'buddypress' ) );
</span></span></pre>
</div>
</div>
</body>
</html>