<!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][13176] trunk/src/bp-core/bp-core-avatars.php: Introduce 2 functions to get an avatar version and the avatars history</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 { white-space: pre-line; 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/13176">13176</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/13176","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>2021-12-11 12:31:50 +0000 (Sat, 11 Dec 2021)</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 2 functions to get an avatar version and the avatars history

- `bp_avatar_get_version()` can be used to get a version of an avatar according to its timestamp. Since <a href="http://buddypress.trac.wordpress.org/changeset/13175">[13175]</a> the `BP_Attachment_Avatar` class is using a timestamp inside the avatar file name instead of a generated unique string (`uniqid()`), this change allows us to request avatars according to the timestamp included into their names.
- `bp_avatar_get_avatars_history()` can be used to get the file objects list of previously uploaded avatars.

Props vapvarun, oztaser

See <a href="http://buddypress.trac.wordpress.org/ticket/8581">#8581</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<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     2021-12-11 12:00:16 UTC (rev 13175)
+++ trunk/src/bp-core/bp-core-avatars.php       2021-12-11 12:31:50 UTC (rev 13176)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2122,3 +2122,95 @@
</span><span class="cx" style="display: block; padding: 0 10px">                bp_attachments_get_template_part( 'avatars/index' );
</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 a specific version of an avatar from its history.
+ *
+ * @since 10.0.0
+ *
+ * @param int        $item_id   The item ID we need the avatar version for.
+ * @param string     $object    The object the item ID relates to.
+ * @param int|string $timestamp An integer Unix timestamp or a date string of the format 'Y-m-d h:i:s'.
+ * @param string     $type      The type of avatar we need. Possible values are `thumb` and `full`.
+ * @return array                A list of matching results, an empty array if no avatars were found.
+ */
+function bp_avatar_get_version( $item_id = 0, $object = 'user', $timestamp = '', $type = 'full' ) {
+       if ( ! $item_id || ! $timestamp ) {
+               return array();
+       }
+
+       if ( ! is_numeric( $timestamp ) ) {
+               $timestamp = strtotime( $timestamp );
+       }
+
+       $avatar_id = $timestamp . '-bpfull';
+       if ( 'full' !== $type ) {
+               $avatar_id = $timestamp . '-bpthumb';
+       }
+
+       $avatar_dir = 'avatars';
+       if ( 'user' !== $object ) {
+               $avatar_dir = sanitize_key( $object ) . '-avatars';
+       }
+
+       // The object avatar directory we are looking into to get the avatar url.
+       $object_avatar_dir = trailingslashit( bp_core_avatar_upload_path() ) . $avatar_dir . '/' . $item_id;
+
+       return bp_attachments_list_directory_files_recursively( $object_avatar_dir, $avatar_id );
+}
+
+/**
+ * Get the list of previous avatars in history
+ *
+ * @since 10.0.0
+ *
+ * @param int    $item_id The item ID we need the avatar version for.
+ * @param string $object  The object the item ID relates to.
+ * @param string $type    Get the `full`, `thumb` or `both` versions.
+ * @return array          The list of previous uploaded avatars.
+ */
+function bp_avatar_get_avatars_history( $item_id = 0, $object = 'user', $type = 'full' ) {
+       if ( ! $item_id ) {
+               return array();
+       }
+
+       $avatar_dir = 'avatars';
+       if ( 'user' !== $object ) {
+               $avatar_dir = sanitize_key( $object ) . '-avatars';
+       }
+
+       // The user avatar directory we are looking into to get the avatar url.
+       $history_dir      = trailingslashit( bp_core_avatar_upload_path() ) . $avatar_dir . '/' . $item_id . '/history';
+       $historic_avatars = bp_attachments_list_directory_files( $history_dir );
+
+       if ( ! $historic_avatars ) {
+               return array();
+       }
+
+       $avatars     = array();
+       $history_url = trailingslashit( bp_core_avatar_url() ) .  $avatar_dir . '/' . $item_id . '/history';
+
+       foreach ( $historic_avatars as $historic_avatar ) {
+               $prefix = str_replace( array( '-bpfull', '-bpthumb' ), '', $historic_avatar->id );
+               $gmdate = gmdate( 'Y-m-d H:i:s', $historic_avatar->last_modified );
+               $date   = strtotime( get_date_from_gmt( $gmdate ) );
+
+               $avatars[ $historic_avatar->id ] = (object) array(
+                       'id'   => $historic_avatar->id,
+                       'name' => $historic_avatar->name,
+                       'date' => sprintf(
+                               '%1$s (%2$s)',
+                               date_i18n( get_option( 'date_format' ), $date ),
+                               date_i18n( get_option( 'time_format' ), $date )
+                       ),
+                       'type' => str_replace( $prefix . '-bp', '', $historic_avatar->id ),
+                       'url'  => $history_url . '/' . $historic_avatar->name,
+               );
+       }
+
+       if ( 'both' === $type ) {
+               return $avatars;
+       }
+
+       return wp_filter_object_list( $avatars, array( 'type' => $type ) );
+}
</ins></span></pre>
</div>
</div>

</body>
</html>