<!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][10193] trunk/src/bp-core/bp-core-attachments.php: Introduce a new function to generate an Avatar or a Cover Image for a given User or Group.</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/10193">10193</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/10193","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-10-06 23:17:06 +0000 (Tue, 06 Oct 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 a new function to generate an Avatar or a Cover Image for a given User or Group.
You can now use the absolute path to an existing image of your WordPress site to dynamically set the avatar or the cover image of a Group or a User.
Props svenl77, boonebgorges, DJPaul
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5202">#5202</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreattachmentsphp">trunk/src/bp-core/bp-core-attachments.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-10-05 23:56:42 UTC (rev 10192)
+++ trunk/src/bp-core/bp-core-attachments.php 2015-10-06 23:17:06 UTC (rev 10193)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,6 +216,164 @@
</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">+ * Use the absolute path to an image to set an attachment type for a given item.
+ *
+ * @since 2.4.0
+ *
+ * @param string $type The attachment type to create (avatar or cover_image). Default: avatar.
+ * @param array $args {
+ * @type int $item_id The ID of the object (Required). Default: 0.
+ * @type string $object The object type (eg: group, user, blog) (Required). Default: 'user'.
+ * @type string $component The component for the object (eg: groups, xprofile, blogs). Default: ''.
+ * @type string $image The absolute path to the image (Required). Default: ''.
+ * @type int $crop_w Crop width. Default: 0.
+ * @type int $crop_h Crop height. Default: 0.
+ * @type int $crop_x The horizontal starting point of the crop. Default: 0.
+ * @type int $crop_y The vertical starting point of the crop. Default: 0.
+ * }
+ * @return bool True on success, false otherwise.
+ */
+function bp_attachments_create_item_type( $type = 'avatar', $args = array() ) {
+ if ( empty( $type ) || ( $type !== 'avatar' && $type !== 'cover_image' ) ) {
+ return false;
+ }
+
+ $r = bp_parse_args( $args, array(
+ 'item_id' => 0,
+ 'object' => 'user',
+ 'component' => '',
+ 'image' => '',
+ 'crop_w' => 0,
+ 'crop_h' => 0,
+ 'crop_x' => 0,
+ 'crop_y' => 0
+ ), 'create_item_' . $type );
+
+ if ( empty( $r['item_id'] ) || empty( $r['object'] ) || ! file_exists( $r['image'] ) || ! @getimagesize( $r['image'] ) ) {
+ return false;
+ }
+
+ // Make sure the file path is safe
+ if ( 0 !== validate_file( $r['image'] ) ) {
+ return false;
+ }
+
+ // Set the component if not already done
+ if ( empty( $r['component'] ) ) {
+ if ( 'user' === $r['object'] ) {
+ $r['component'] = 'xprofile';
+ } else {
+ $r['component'] = $r['object'] . 's';
+ }
+ }
+
+ // Get allowed mimes for the Attachment type and check the image one is.
+ $allowed_mimes = bp_attachments_get_allowed_mimes( $type );
+ $is_allowed = wp_check_filetype( $r['image'], $allowed_mimes );
+
+ // It's not an image.
+ if ( ! $is_allowed['ext'] ) {
+ return false;
+ }
+
+ // Init the Attachment data
+ $attachment_data = array();
+
+ if ( 'avatar' === $type ) {
+ // Set crop width for the avatar if not given
+ if ( empty( $r['crop_w'] ) ) {
+ $r['crop_w'] = bp_core_avatar_full_width();
+ }
+
+ // Set crop height for the avatar if not given
+ if ( empty( $r['crop_h'] ) ) {
+ $r['crop_h'] = bp_core_avatar_full_height();
+ }
+
+ if ( is_callable( $r['component'] . '_avatar_upload_dir' ) ) {
+ $dir_args = array( $r['item_id'] );
+
+ // In case of xprofile, we need an extra argument
+ if ( 'xprofile' === $r['component'] ) {
+ $dir_args = array( false, $r['item_id'] );
+ }
+
+ $attachment_data = call_user_func_array( $r['component'] . '_avatar_upload_dir', $dir_args );
+ }
+ } elseif ( 'cover_image' === $type ) {
+ $attachment_data = bp_attachments_uploads_dir_get();
+
+ // Default to members for xProfile
+ $object_subdir = 'members';
+
+ if ( 'xprofile' !== $r['component'] ) {
+ $object_subdir = sanitize_key( $r['component'] );
+ }
+
+ // Set Subdir
+ $attachment_data['subdir'] = $object_subdir . '/' . $r['item_id'] . '/cover-image';
+
+ // Set Path
+ $attachment_data['path'] = trailingslashit( $attachment_data['basedir'] ) . $attachment_data['subdir'];
+ }
+
+ if ( ! isset( $attachment_data['path'] ) || ! isset( $attachment_data['subdir'] ) ) {
+ return false;
+ }
+
+ // It's not a regular upload, we may need to create some folders
+ if ( ! is_dir( $attachment_data['path'] ) ) {
+ if ( ! wp_mkdir_p( $attachment_data['path'] ) ) {
+ return false;
+ }
+ }
+
+ // Set the image name and path
+ $image_file_name = wp_unique_filename( $attachment_data['path'], basename( $r['image'] ) );
+ $image_file_path = $attachment_data['path'] . '/' . $image_file_name;
+
+ // Copy the image file into the avatar dir
+ if ( ! copy( $r['image'], $image_file_path ) ) {
+ return false;
+ }
+
+ // Init the response
+ $created = false;
+
+ // It's an avatar, we need to crop it.
+ if ( 'avatar' === $type ) {
+ $created = bp_core_avatar_handle_crop( array(
+ 'object' => $r['object'],
+ 'avatar_dir' => trim( dirname( $attachment_data['subdir'] ), '/' ),
+ 'item_id' => (int) $r['item_id'],
+ 'original_file' => trailingslashit( $attachment_data['subdir'] ) . $image_file_name,
+ 'crop_w' => $r['crop_w'],
+ 'crop_h' => $r['crop_h'],
+ 'crop_x' => $r['crop_x'],
+ 'crop_y' => $r['crop_y']
+ ) );
+
+ // It's a cover image we need to fit it to feature's dimensions
+ } elseif ( 'cover_image' === $type ) {
+ $cover_image = bp_attachments_cover_image_generate_file( array(
+ 'file' => $image_file_path,
+ 'component' => $r['component'],
+ 'cover_image_dir' => $attachment_data['path']
+ ) );
+
+ $created = ! empty( $cover_image['cover_file'] );
+ }
+
+ // Remove copied file if it fails
+ if ( ! $created ) {
+ @unlink( $image_file_path );
+ }
+
+ // Return the response
+ return $created;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get the url or the path for a type of 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></pre>
</div>
</div>
</body>
</html>