<!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][10151] trunk/src/bp-core: Introduce new functions to the BuddyPress Attachments API</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/10151">10151</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/10151","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-09-29 21:43:13 +0000 (Tue, 29 Sep 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'>Introduce new functions to the BuddyPress Attachments API
The first benefit of the BuddyPress Cover Images feature is the improvement of the BuddyPress Attachments API. We are introducing new functions to deal with file management. Some of these functions come from functions previously restricted to avatars.
- is there to get the new attachments features Uploads directory. New Attachments features will now store their files within the directory. Inside this directory we will have subdirectories to organize files according to the object they belong to (eg: members, groups), to the item ID they are attached to and eventually to the BuddyPress attachment type. For the cover image of a user it is looking like
- , , , are inspired by functions restricted to avatars so far. They will help us to control max upload size, allowed types and mimes for any attachments. The last function will help us to check the uploaded file match the allowed types. Corresponding Avatar functions are now using these new functions.
- and are there to respectively get the path or the url of any attachment using the new Uploads directory organization (avatars and group-avatars are not concerned so far) and to delete an attachment.
See <a href="http://buddypress.trac.wordpress.org/ticket/6570">#6570</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreattachmentsphp">trunk/src/bp-core/bp-core-attachments.php</a></li>
<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.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 2015-09-27 06:04:27 UTC (rev 10150)
+++ trunk/src/bp-core/bp-core-attachments.php 2015-09-29 21:43:13 UTC (rev 10151)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,6 +25,293 @@
</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">+ * Get the Attachments Uploads dir data
+ *
+ * @since 2.4.0
+ *
+ * @param string $data The data to get. Possible values are: 'dir', 'basedir' & 'baseurl'
+ * Leave empty to get all datas.
+ * @return string|array The needed Upload dir data.
+ */
+function bp_attachments_uploads_dir_get( $data = '' ) {
+ $attachments_dir = 'buddypress';
+ $retval = '';
+
+ if ( 'dir' === $data ) {
+ $retval = $attachments_dir;
+ } else {
+ $upload_data = bp_upload_dir();
+
+ // Build the Upload data array for BuddyPress attachments
+ foreach ( $upload_data as $key => $value ) {
+ if ( 'basedir' === $key || 'baseurl' === $key ) {
+ $upload_data[ $key ] = trailingslashit( $value ) . $attachments_dir;
+ } else {
+ unset( $upload_data[ $key ] );
+ }
+ }
+
+ // Add the dir to the array
+ $upload_data['dir'] = $attachments_dir;
+
+ if ( empty( $data ) ) {
+ $retval = $upload_data;
+ } elseif ( isset( $upload_data[ $data ] ) ) {
+ $retval = $upload_data[ $data ];
+ }
+ }
+
+ /**
+ * Filter here to edit the Attachments upload dir data.
+ *
+ * @since 2.4.0
+ *
+ * @param string|array $retval The needed Upload dir data or the full array of data
+ * @param string $data The data requested
+ */
+ return apply_filters( 'bp_attachments_uploads_dir_get', $retval, $data );
+}
+
+/**
+ * Get the max upload file size for any attachment
+ *
+ * @since 2.4.0
+ *
+ * @param string $type A string to inform about the type of attachment
+ * we wish to get the max upload file size for
+ * @return int max upload file size for any attachment
+ */
+function bp_attachments_get_max_upload_file_size( $type = '' ) {
+ $fileupload_maxk = bp_core_get_root_option( 'fileupload_maxk' );
+
+ if ( '' === $fileupload_maxk ) {
+ $fileupload_maxk = 5120000; // 5mb;
+ } else {
+ $fileupload_maxk = $fileupload_maxk * 1024;
+ }
+
+ /**
+ * Filter here to edit the max upload file size.
+ *
+ * @since 2.4.0
+ *
+ * @param int $fileupload_maxk Max upload file size for any attachment
+ * @param string $type The attachment type (eg: 'avatar' or 'cover_image')
+ */
+ return apply_filters( 'bp_attachments_get_max_upload_file_size', $fileupload_maxk, $type );
+}
+
+/**
+ * Get allowed types for any attachment
+ *
+ * @since 2.4.0
+ *
+ * @param string $type The extension types to get.
+ * Default: 'avatar'
+ * @return array The list of allowed extensions for attachments
+ */
+function bp_attachments_get_allowed_types( $type = 'avatar' ) {
+ // Defaults to BuddyPress supported image extensions
+ $exts = array( 'jpeg', 'gif', 'png' );
+
+ /**
+ * It's not a BuddyPress feature, get the allowed extensions
+ * matching the $type requested
+ */
+ if ( 'avatar' !== $type && 'cover_image' !== $type ) {
+ // Reset the default exts
+ $exts = array();
+
+ switch ( $type ) {
+ case 'video' :
+ $exts = wp_get_video_extensions();
+ break;
+
+ case 'audio' :
+ $exts = wp_get_video_extensions();
+ break;
+
+ default:
+ $allowed_mimes = get_allowed_mime_types();
+
+ /**
+ * Search for allowed mimes matching the type
+ *
+ * eg: using 'application/vnd.oasis' as the $type
+ * parameter will get all OpenOffice extensions supported
+ * by WordPress and allowed for the current user.
+ */
+ if ( '' !== $type ) {
+ $allowed_mimes = preg_grep( '/' . addcslashes( $type, '/.+-' ) . '/', $allowed_mimes );
+ }
+
+ $allowed_types = array_keys( $allowed_mimes );
+
+ // Loop to explode keys using '|'
+ foreach ( $allowed_types as $allowed_type ) {
+ $t = explode( '|', $allowed_type );
+ $exts = array_merge( $exts, (array) $t );
+ }
+ break;
+ }
+ }
+
+ /**
+ * Filter here to edit the allowed extensions by attachment type.
+ *
+ * @since 2.4.0
+ *
+ * @param array $exts List of allowed extensions
+ * @param string $type The requested file type
+ */
+ return apply_filters( 'bp_attachments_get_allowed_types', $exts, $type );
+}
+
+/**
+ * Get allowed attachment mime types.
+ *
+ * @since 2.4.0
+ *
+ * @param string $type The extension types to get (Optional).
+ * @param array $allowed_types List of allowed extensions
+ * @return array List of allowed mime types
+ */
+function bp_attachments_get_allowed_mimes( $type = '', $allowed_types = array() ) {
+ if ( empty( $allowed_types ) ) {
+ $allowed_types = bp_attachments_get_allowed_types( $type );
+ }
+
+ $validate_mimes = wp_match_mime_types( join( ',', $allowed_types ), wp_get_mime_types() );
+ $allowed_mimes = array_map( 'implode', $validate_mimes );
+
+ /**
+ * Include jpg type if jpeg is set
+ */
+ if ( isset( $allowed_mimes['jpeg'] ) && ! isset( $allowed_mimes['jpg'] ) ) {
+ $allowed_mimes['jpg'] = $allowed_mimes['jpeg'];
+ }
+
+ return $allowed_mimes;
+}
+
+/**
+ * Check the uploaded attachment type is allowed
+ *
+ * @since 2.4.0
+ *
+ * @param string $file Full path to the file.
+ * @param string $filename The name of the file (may differ from $file due to $file being
+ * in a tmp directory).
+ * @param array $allowed_mimes The attachment allowed mimes (Required)
+ * @return bool True if the attachment type is allowed. False otherwise
+ */
+function bp_attachments_check_filetype( $file, $filename, $allowed_mimes ) {
+ $filetype = wp_check_filetype_and_ext( $file, $filename, $allowed_mimes );
+
+ if ( ! empty( $filetype['ext'] ) && ! empty( $filetype['type'] ) ) {
+ return true;
+ }
+
+ return false;
+}
+
+/**
+ * Get the url or the path for a type of attachment
+ *
+ * @since 2.4.0
+ *
+ * @param string $data whether to get the url or the path
+ * @param array $args {
+ * @type string $object_dir The object dir (eg: members/groups). Defaults to members.
+ * @type int $item_id The object id (eg: a user or a group id). Defaults to current user.
+ * @type string $type The type of the attachment which is also the subdir where files are saved.
+ * Defaults to 'cover-image'
+ * @type string $file The name of the file.
+ * }
+ * @return string|bool the url or the path to the attachment, false otherwise
+ */
+function bp_attachments_get_attachment( $data = 'url', $args = array() ) {
+ // Default value
+ $attachment_data = false;
+
+ $r = bp_parse_args( $args, array(
+ 'object_dir' => 'members',
+ 'item_id' => bp_loggedin_user_id(),
+ 'type' => 'cover-image',
+ 'file' => '',
+ ), 'attachments_get_attachment_src' );
+
+ // Get BuddyPress Attachments Uploads Dir datas
+ $bp_attachments_uploads_dir = bp_attachments_uploads_dir_get();
+
+ $type_subdir = $r['object_dir'] . '/' . $r['item_id'] . '/' . $r['type'];
+ $type_dir = trailingslashit( $bp_attachments_uploads_dir['basedir'] ) . $type_subdir;
+
+ if ( ! is_dir( $type_dir ) ) {
+ return $attachment_data;
+ }
+
+ if ( ! empty( $r['file'] ) ) {
+ if ( ! file_exists( trailingslashit( $type_dir ) . $r['file'] ) ) {
+ return $attachment_data;
+ }
+
+ if ( 'url' === $data ) {
+ $attachment_data = trailingslashit( $bp_attachments_uploads_dir['baseurl'] ) . $type_subdir . '/' . $r['file'];
+ } else {
+ $attachment_data = trailingslashit( $type_dir ) . $r['file'];
+ }
+
+ } else {
+ $file = false;
+
+ // Open the directory and get the first file
+ if ( $att_dir = opendir( $type_dir ) ) {
+
+ while ( false !== ( $attachment_file = readdir( $att_dir ) ) ) {
+ // Look for the first file having the type in its name
+ if ( false !== strpos( $attachment_file, $r['type'] ) && empty( $file ) ) {
+ $file = $attachment_file;
+ break;
+ }
+ }
+ }
+
+ if ( empty( $file ) ) {
+ return $attachment_data;
+ }
+
+ if ( 'url' === $data ) {
+ $attachment_data = trailingslashit( $bp_attachments_uploads_dir['baseurl'] ) . $type_subdir . '/' . $file;
+ } else {
+ $attachment_data = trailingslashit( $type_dir ) . $file;
+ }
+ }
+
+ return $attachment_data;
+}
+
+/**
+ * Delete an attachment for the given arguments
+ *
+ * @since 2.4.0
+ *
+ * @param array $args
+ * @see bp_attachments_get_attachment() For more information on accepted arguments.
+ * @return bool True if the attachment was deleted, false otherwise
+ */
+function bp_attachments_delete_file( $args = array() ) {
+ $attachment_path = bp_attachments_get_attachment( 'path', $args );
+
+ if ( empty( $attachment_path ) ) {
+ return false;
+ }
+
+ @unlink( $attachment_path );
+ return true;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get the BuddyPress Plupload settings.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span></span></pre></div>
<a id="trunksrcbpcorebpcoreavatarsphp"></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-avatars.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-avatars.php 2015-09-27 06:04:27 UTC (rev 10150)
+++ trunk/src/bp-core/bp-core-avatars.php 2015-09-29 21:43:13 UTC (rev 10151)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,13 +32,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'BP_AVATAR_ORIGINAL_MAX_WIDTH', 450 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !defined( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $fileupload_maxk = bp_core_get_root_option( 'fileupload_maxk' );
- if ( '' === $fileupload_maxk ) {
- define( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE', 5120000 ); // 5mb
- } else {
- define( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE', $fileupload_maxk * 1024 );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ define( 'BP_AVATAR_ORIGINAL_MAX_FILESIZE', bp_attachments_get_max_upload_file_size( 'avatar' ) );
</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"> if ( ! defined( 'BP_SHOW_AVATARS' ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1370,7 +1364,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_get_allowed_avatar_types() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $allowed_types = array( 'jpeg', 'gif', 'png' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_types = bp_attachments_get_allowed_types( 'avatar' );
</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"> * Filters the list of allowed image types.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1397,18 +1391,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_get_allowed_avatar_mimes() {
</span><span class="cx" style="display: block; padding: 0 10px"> $allowed_types = bp_core_get_allowed_avatar_types();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $validate_mimes = wp_match_mime_types( join( ',', $allowed_types ), wp_get_mime_types() );
- $allowed_mimes = array_map( 'implode', $validate_mimes );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Include jpg type if needed so that bp_core_check_avatar_type()
- * will check for jpeg and jpg extensions.
- */
- if ( isset( $allowed_mimes['jpeg'] ) ) {
- $allowed_mimes['jpg'] = $allowed_mimes['jpeg'];
- }
-
- return $allowed_mimes;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_attachments_get_allowed_mimes( 'avatar', $allowed_types );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1421,13 +1405,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the file extension is permitted, otherwise false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_check_avatar_type( $file ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $avatar_filetype = wp_check_filetype_and_ext( $file['file']['tmp_name'], $file['file']['name'], bp_core_get_allowed_avatar_mimes() );
-
- if ( ! empty( $avatar_filetype['ext'] ) && ! empty( $avatar_filetype['type'] ) ) {
- return true;
- }
-
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_attachments_check_filetype( $file['file']['tmp_name'], $file['file']['name'], bp_core_get_allowed_avatar_mimes() );
</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>