wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cache avatars properly

Browse source 
* Set proper caching headers for avatars (15 minutes)
* For our own avatar use some extra logic to invalidate when we update
This commit is contained in:
Roeland Jago Douma 2016-08-29 14:55:23 +02:00
parent c481210e2b
commit 14136295b7
No known key found for this signature in database
GPG key ID: 1E152838F164D13B
10 changed files with 98 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
core/Controller/AvatarController.php
View file

@ -27,6 +27,7 @@
*/
namespace OC\Core\Controller;
use OC\AppFramework\Utility\TimeFactory;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataDisplayResponse;
@ -73,6 +74,9 @@ class AvatarController extends Controller {
/** @var string */
protected $userId;
/** @var TimeFactory */
protected $timeFactory;
/**
* @param string $appName
* @param IRequest $request
@ -83,6 +87,7 @@ class AvatarController extends Controller {
* @param IRootFolder $rootFolder
* @param ILogger $logger
* @param string $userId
* @param TimeFactory $timeFactory
*/
public function __construct($appName,
IRequest $request,
@ -92,7 +97,8 @@ class AvatarController extends Controller {
IUserManager $userManager,
IRootFolder $rootFolder,
ILogger $logger,
$userId) {
$userId,
TimeFactory $timeFactory) {
parent::__construct($appName, $request);
$this->avatarManager = $avatarManager;
@ -102,6 +108,7 @@ class AvatarController extends Controller {
$this->rootFolder = $rootFolder;
$this->logger = $logger;
$this->userId = $userId;
$this->timeFactory = $timeFactory;
}
/**
@ -126,6 +133,21 @@ class AvatarController extends Controller {
Http::STATUS_OK,
['Content-Type' => $avatar->getMimeType()]);
$resp->setETag($avatar->getEtag());
// Let cache this!
$resp->addHeader('Pragma', 'public');
// Cache for 15 minutes
$resp->cacheFor(900);
// Set last modified
$lastModified = new \DateTime();
$lastModified->setTimestamp($avatar->getMTime());
$resp->setLastModified($lastModified);
$expires = new \DateTime();
$expires->setTimestamp($this->timeFactory->getTime());
$expires->add(new \DateInterval('PT15M'));
$resp->addHeader('Expires', $expires->format(\DateTime::RFC2822));
} catch (NotFoundException $e) {
$user = $this->userManager->get($userId);
$resp = new JSONResponse([
@ -133,18 +155,20 @@ class AvatarController extends Controller {
'displayname' => $user->getDisplayName(),
],
]);
// Don't cache this
$resp->cacheFor(0);
$resp->setLastModified(new \DateTime('now', new \DateTimeZone('GMT')));
} catch (\Exception $e) {
$resp = new JSONResponse([
'data' => [
'displayname' => '',
],
]);
// Don't cache this
$resp->cacheFor(0);
$resp->setLastModified(new \DateTime('now', new \DateTimeZone('GMT')));
}
$resp->addHeader('Pragma', 'public');
$resp->cacheFor(0);
$resp->setLastModified(new \DateTime('now', new \DateTimeZone('GMT')));
return $resp;
}

14
core/js/config.php
View file

@ -149,8 +149,8 @@ $array = array(
"firstDay" => json_encode($l->l('firstday', null)) ,
"oc_config" => json_encode(
array(
'session_lifetime' => min(\OCP\Config::getSystemValue('session_lifetime', OC::$server->getIniWrapper()->getNumeric('session.gc_maxlifetime')), OC::$server->getIniWrapper()->getNumeric('session.gc_maxlifetime')),
'session_keepalive' => \OCP\Config::getSystemValue('session_keepalive', true),
'session_lifetime' => min($config->getSystemValue('session_lifetime', OC::$server->getIniWrapper()->getNumeric('session.gc_maxlifetime')), OC::$server->getIniWrapper()->getNumeric('session.gc_maxlifetime')),
'session_keepalive' => $config->getSystemValue('session_keepalive', true),
'version' => implode('.', \OCP\Util::getVersion()),
'versionstring' => OC_Util::getVersionString(),
'enable_avatars' => \OC::$server->getConfig()->getSystemValue('enable_avatars', true) === true,
@ -187,9 +187,17 @@ $array = array(
'longFooter' => $defaults->getLongFooter(),
'folder' => OC_Util::getTheme(),
)
)
),
);
if (OC_User::getUser() !== null && OC_User::getUser() !== false) {
$array['oc_userconfig'] = json_encode([
'avatar' => [
'version' => (int)$config->getUserValue(OC_User::getUser(), 'avatar', 'version', 0),
]
]);
}
// Allow hooks to modify the output values
OC_Hook::emit('\OCP\Config', 'js', array('array' => &$array));

23
core/js/jquery.avatar.js
View file

@ -74,10 +74,25 @@
user = String(user).replace(/\//g,'');
var $div = this;
var url;
var url = OC.generateUrl(
'/avatar/{user}/{size}',
{user: user, size: Math.ceil(size * window.devicePixelRatio)});
// If this is our own avatar we have to use the version attribute
if (user === OC.getCurrentUser().uid) {
url = OC.generateUrl(
'/avatar/{user}/{size}?v={version}',
{
user: user,
size: Math.ceil(size * window.devicePixelRatio),
version: oc_userconfig.avatar.version
});
} else {
url = OC.generateUrl(
'/avatar/{user}/{size}',
{
user: user,
size: Math.ceil(size * window.devicePixelRatio)
});
}
// If the displayname is not defined we use the old code path
if (typeof(displayname) === 'undefined') {
@ -122,7 +137,7 @@
$div.show();
$div.text('');
$div.append(img);
}
};
img.width = size;
img.height = size;

4
core/templates/layout.user.php
View file

@ -66,8 +66,8 @@
<div class="avatardiv<?php if ($_['userAvatarSet']) { print_unescaped(' avatardiv-shown'); } else { print_unescaped('" style="display: none'); } ?>">
<?php if ($_['userAvatarSet']): ?>
<img alt="" width="32" height="32"
src="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 32]));?>"
srcset="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 64]));?> 2x, <?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 128]));?> 4x"
src="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 32, 'v' => $_['userAvatarVersion']]));?>"
srcset="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 64, 'v' => $_['userAvatarVersion']]));?> 2x, <?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 128, 'v' => $_['userAvatarVersion']]));?> 4x"
>
<?php endif; ?>
</div>

14
lib/private/Avatar.php
View file

@ -34,6 +34,7 @@ use OCP\Files\File;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\IAvatar;
use OCP\IConfig;
use OCP\IImage;
use OCP\IL10N;
use OC_Image;
@ -52,6 +53,8 @@ class Avatar implements IAvatar {
private $user;
/** @var ILogger */
private $logger;
/** @var IConfig */
private $config;
/**
* constructor
@ -60,12 +63,18 @@ class Avatar implements IAvatar {
* @param IL10N $l
* @param User $user
* @param ILogger $logger
* @param IConfig $config
*/
public function __construct (Folder $folder, IL10N $l, $user, ILogger $logger) {
public function __construct(Folder $folder,
IL10N $l,
$user,
ILogger $logger,
IConfig $config) {
$this->folder = $folder;
$this->l = $l;
$this->user = $user;
$this->logger = $logger;
$this->config = $config;
}
/**
@ -137,6 +146,9 @@ class Avatar implements IAvatar {
$regex = '/^avatar\.([0-9]+\.)?(jpg|png)$/';
$avatars = $this->folder->getDirectoryListing();
$this->config->setUserValue($this->user->getUID(), 'avatar', 'version',
(int)$this->config->getUserValue($this->user->getUID(), 'avatar', 'version', 0) + 1);
foreach ($avatars as $avatar) {
if (preg_match($regex, $avatar->getName())) {
$avatar->delete();

11
lib/private/AvatarManager.php
View file

@ -30,6 +30,7 @@ namespace OC;
use OCP\Files\Folder;
use OCP\Files\NotFoundException;
use OCP\IAvatarManager;
use OCP\IConfig;
use OCP\ILogger;
use OCP\IUserManager;
use OCP\Files\IRootFolder;
@ -52,6 +53,9 @@ class AvatarManager implements IAvatarManager {
/** @var ILogger */
private $logger;
/** @var IConfig */
private $config;
/**
* AvatarManager constructor.
*
@ -59,16 +63,19 @@ class AvatarManager implements IAvatarManager {
* @param IRootFolder $rootFolder
* @param IL10N $l
* @param ILogger $logger
* @param IConfig $config
*/
public function __construct(
IUserManager $userManager,
IRootFolder $rootFolder,
IL10N $l,
ILogger $logger) {
ILogger $logger,
IConfig $config) {
$this->userManager = $userManager;
$this->rootFolder = $rootFolder;
$this->l = $l;
$this->logger = $logger;
$this->config = $config;
}
/**
@ -94,6 +101,6 @@ class AvatarManager implements IAvatarManager {
/** @var Folder $folder */
$folder = $this->rootFolder->get($dir);
return new Avatar($folder, $this->l, $user, $this->logger);
return new Avatar($folder, $this->l, $user, $this->logger, $this->config);
}
}

3
lib/private/Server.php
View file

@ -361,7 +361,8 @@ class Server extends ServerContainer implements IServerContainer {
$c->getUserManager(),
$c->getRootFolder(),
$c->getL10N('lib'),
$c->getLogger()
$c->getLogger(),
$c->getConfig()
);
});
$this->registerService('Logger', function (Server $c) {

1
lib/private/TemplateLayout.php
View file

@ -112,6 +112,7 @@ class TemplateLayout extends \OC_Template {
$this->assign('userAvatarSet', false);
} else {
$this->assign('userAvatarSet', \OC::$server->getAvatarManager()->getAvatar(\OC_User::getUser())->exists());
$this->assign('userAvatarVersion', \OC::$server->getConfig()->getUserValue(\OC_User::getUser(), 'avatar', 'version', 0));
}
} else if ($renderAs == 'error') {

3
lib/public/AppFramework/Http/Response.php
View file

@ -92,8 +92,7 @@ class Response {
public function cacheFor($cacheSeconds) {
if($cacheSeconds > 0) {
$this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds .
', must-revalidate');
$this->addHeader('Cache-Control', 'max-age=' . $cacheSeconds . ', must-revalidate');
} else {
$this->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
}

13
settings/js/personal.js
View file

@ -100,6 +100,9 @@ function updateAvatar (hidedefault) {
var $headerdiv = $('#header .avatardiv');
var $displaydiv = $('#displayavatar .avatardiv');
//Bump avatar avatarversion
oc_userconfig.avatar.version = -(Math.floor(Math.random() * 1000));
if (hidedefault) {
$headerdiv.hide();
$('#header .avatardiv').removeClass('avatardiv-shown');
@ -112,7 +115,10 @@ function updateAvatar (hidedefault) {
$displaydiv.avatar(OC.currentUser, 145, true);
$.get(OC.generateUrl(
'/avatar/{user}/{size}',
{user: OC.currentUser, size: 1}
{
user: OC.currentUser,
size: 1
}
), function (result) {
if (typeof(result) === 'string') {
// Show the delete button when the avatar is custom
@ -358,7 +364,10 @@ $(document).ready(function () {
// does the user have a custom avatar? if he does show #removeavatar
$.get(OC.generateUrl(
'/avatar/{user}/{size}',
{user: OC.currentUser, size: 1}
{
user: OC.currentUser,
size: 1
}
), function (result) {
if (typeof(result) === 'string') {
// Show the delete button when the avatar is custom