<?php
namespace TIG\Common\User;
require_once PUBLICROOT . "includes/functions/libraries/Zebra_Image/2.2.2/Zebra_Image.php";
require_once PUBLICROOT . "includes/api/cloudfiles.php";
/**
* User Avatar Creation
*
*/
class Avatar
{
/**************************************************************************
* Configurable Constants
**************************************************************************/
/**
* The minimum vertical dimension (in pixels) of the image used to create the avatar
*
* Since 128 pixels is equal to the largest avatar size that TIG uses,
* requiring that the original image is at least that size means there will
* be no need to stretch the image. Stretching should be avoided because it
* may result in a distorted or blurry image.
*/
const MINHEIGHT = 128;
/**
* The minimum horizontal dimension (in pixels) of the image used to create the avatar
*
* Since 128 pixels is equal to the largest avatar size that TIG uses,
* requiring that the original image is at least that size means there will
* be no need to stretch the image. Stretching should be avoided because it
* may result in a distorted or blurry image.
*/
const MINWIDTH = 128;
/**
* The maximum area (in pixels) of the image used to create the avatar
*
* The dimensions of the image are directly proportional to the amount of
* memory required to process it. We constrain the size of the image
* accepted for processing so that we can prevent fatal out-of-memory
* problems.
*
* By constraining the area instead of the individual dimensions, we are
* able to accept some rectangular files that would exceed one of the
* individual dimension limits.
*
* The value 16000000 is used to be consistent with avatarupload.html.
* There in that file about why this value is used. It it used here
* so that the user encounters identical limits wherever they upload their
* avater.
*/
const MAXPIXELAREA = 16000000;
/**
* The maximum amount of memory to allow the image processing functions to use
*
* The value 256000000 comes from cropImage() in avatarupload.html. There
* is no explanation for its selection in that file. It it used here
* because it is assumed to be working well.
*/
const MEMORYLIMIT = 256000000;
/**
* The maximum file size (in bytes) of the of the image used to create the avatar
*
* Larger files take longer to transfer. Constraining this size guides the
* users towards submitting file sizes that are less likely to timeout.
* The size 6291456 bytes is used to be consistent with avatarupload.html.
*/
const MAXFILESIZE = 6291456;
/**
* Comma-separated list of file extensions
*
* JPEG, GIF, and PNG formats are supported in all modern browsers.
*/
const SUPPORTEDFILETYPES = 'jpg,jpeg,gif,png';
/**
* Local folder in which avatar images are stored
*/
const IMAGEFOLDER = 'people/';
/**
* Cloud Files Username
*/
const CDNUSERNAME = 'mfurdyk';
/**
* Cloud Files API Key
*/
const CDNAPIKEY = 'fd2dbf1b1e36a982a7a950a61b4a592a';
/**
* Cloud Files folder where avatars are stored
*/
const CDNCONTAINER = 'member_avatars';
/**************************************************************************
* Program Constants
**************************************************************************/
/**
* The uploaded file is not found or incomplete
*/
const ERROR_MISSING = 1;
/**
* The image file uses an unsupported extension (ex. bmp)
*/
const ERROR_INVALIDTYPE = 2;
/**
* The size of the image file in bytes exceeds the limit
*/
const ERROR_FILETOOBIG = 3;
/**
* The height or width exceeds the dimension limits
*/
const ERROR_IMAGETOOBIG = 4;
/**
* The height or width is below the required length
*/
const ERROR_IMAGETOOSMALL = 5;
/**************************************************************************
* Properties
**************************************************************************/
/**
* This property should be accessed through getCloudFilesContainer()
*
* @var CF_Container Connection to the Rackspace container containing avatars
*/
public static $cloudFilesContainer;
/**************************************************************************
* Methods
**************************************************************************/
/**
* Tests a potential avatar image for errors
*
* @param array $filesArrayElement A member of the $_FILES array containing a prospective avatar image
* @return int|false An ERROR_ constant indicating the type of error discovered. Otherwise, false.
* @throws Exception
*/
public static function errorCheckUploadedFile($filesArrayElement)
{
switch ($filesArrayElement['error']) {
case UPLOAD_ERR_OK:
// do nothing
break;
case UPLOAD_ERR_FORM_SIZE:
case UPLOAD_ERR_INI_SIZE:
return self::ERROR_FILETOOBIG;
case UPLOAD_ERR_NO_FILE:
case UPLOAD_ERR_PARTIAL:
return self::ERROR_MISSING;
case UPLOAD_ERR_CANT_WRITE:
case UPLOAD_ERR_NO_TMP_DIR:
case UPLOAD_ERR_EXTENSION:
throw new \Exception('System error while uploading avatar.');
default:
throw new \Exception('Unexpected file upload status found.');
}
// Valid File Type?
$extension = pathinfo($filesArrayElement['name'], PATHINFO_EXTENSION);
if (!in_array(strtolower($extension), explode(',', self::SUPPORTEDFILETYPES))) {
return self::ERROR_INVALIDTYPE;
}
// Within Filesize Limit?
if (filesize($filesArrayElement['tmp_name']) > self::MAXFILESIZE) {
return self::ERROR_FILETOOBIG;
}
$dimensions = getimagesize($filesArrayElement['tmp_name']);
$width = $dimensions[0];
$height = $dimensions[1];
// Big Enough?
if ($width < self::MINWIDTH || $height < self::MINHEIGHT) {
return self::ERROR_IMAGETOOSMALL;
}
// Too Big?
$area = $width * $height;
if ($area > self::MAXPIXELAREA) {
return self::ERROR_IMAGETOOBIG;
}
return false;
}
/**
* Replaces a user's avatar with the specified image
*
* @param int $userID The user whose avatar is being updated
* @param array $filesArrayElement A member of the $_FILES array containing the new avatar image
* @throws InvalidArgumentException
*/
public static function updateFromUploadedFile($userID, $filesArrayElement)
{
// Validate UserID
if (!(filter_var($userID, FILTER_VALIDATE_INT) > 0)) {
throw new \InvalidArgumentException("User id is invalid: $userID");
}
// Validate File
if (self::errorCheckUploadedFile($filesArrayElement)) {
throw new \InvalidArgumentException("File error check failed. Error check file for more details.");
}
// Remember the previous avatar files so we can delete them once the new avatar files are activated
$oldFiles = query("SELECT smImageName, smImageName64, smImageName128 FROM tig.Users WHERE UserID = " . mysqlescape($userID));
// Allow extra memory for memory-intensive image processing
$oldMemoryLimit = ini_set('memory_limit', self::MEMORYLIMIT);
// Resize the images
$filename32 = self::createLocalFile($filesArrayElement, $userID, 32);
$filename64 = self::createLocalFile($filesArrayElement, $userID, 64);
$filename128 = self::createLocalFile($filesArrayElement, $userID, 128);
// Restore original memory limit now that image processing is done
ini_set('memory_limit', $oldMemoryLimit);
// Looking at "members/avatar/index.html", it doesn't appear that the
// CDN is even used. In case it is in some way I don't realize,
// the avatar images are copied there.
self::createCdnFile($filename32);
self::createCdnFile($filename64);
self::createCdnFile($filename128);
// Activate the new avatars in the database
safe_dbwrite("UPDATE tig.Users
SET smImageName = '$filename32',
smImageName64 = '$filename64',
smImageName128 = '$filename128'
WHERE UserID = " . mysqlescape($userID));
// Activate the new avatars in the $TIGUserInfo cookie - I don't know
// where this info is used but avatarupload.html does this so it's
// included here.
global $TIGUserInfo;
$TIGUserInfo['smImageName'] = $filename32;
$TIGUserInfo['smImageName64'] = $filename64;
$TIGUserInfo['smImageName128'] = $filename128;
setcookie("TIGUserInfo", serialize($TIGUserInfo), "0", "/", ".tigweb.org");
// Delete Obsolete Avatars - If there were previous avatar files and
// their names have changed (meaning the old avatars were not
// simply overwritten), then delete the previous files.
if ($oldFiles['smImageName'] && $filename32 != $oldFiles['smImageName']) {
self::deleteLocalFile($oldFiles['smImageName']);
self::deleteCdnFile($oldFiles['smImageName']);
}
if ($oldFiles['smImageName64'] && $filename64 != $oldFiles['smImageName64']) {
self::deleteLocalFile($oldFiles['smImageName64']);
self::deleteCdnFile($oldFiles['smImageName64']);
}
if ($oldFiles['smImageName128'] && $filename128 != $oldFiles['smImageName128']) {
self::deleteLocalFile($oldFiles['smImageName128']);
self::deleteCdnFile($oldFiles['smImageName128']);
}
// Add "Jeff changed his avatar" to Feeds
add2bb($userID, 75, "{$TIGUserInfo['Username']}|");
}
/**
* Saves a square avatar image file
*
* @param $filesArrayElement A member of $_FILES
* @param int $userID The user the avatar is for. Ex. 654811
* @param int $size The side length of the square avatar image to create. Ex. 32
* @return string The name of the file created
*/
private static function createLocalFile($filesArrayElement, $userID, $size)
{
$extension = pathinfo($filesArrayElement['name'], PATHINFO_EXTENSION);
// Ex. "654811_32.jpg"
$filename = "{$userID}_{$size}.{$extension}";
$imageManipulator = new \Zebra_Image();
$imageManipulator->source_path = $filesArrayElement['tmp_name'];
$imageManipulator->target_path = IMAGEROOT . self::IMAGEFOLDER . $filename;
$imageManipulator->resize($size, $size, ZEBRA_IMAGE_CROP_CENTER);
return $filename;
}
/**
* Permanently erases a avatar file stored on the server
*
* @param string $filename The local avatar file to delete. ex. 654811_32.jpg
*/
private static function deleteLocalFile($filename)
{
$filePath = IMAGEROOT . self::IMAGEFOLDER . $filename;
if (is_file($filePath)) {
unlink($filePath);
}
}
/**
* Copies local avatar images to Cloud Files
*
* @param string $filename The local filename
* @throws InvalidArgumentException
*/
private static function createCdnFile($filename)
{
$filePath = IMAGEROOT . self::IMAGEFOLDER . $filename;
if (!is_file($filePath)) {
throw new \InvalidArgumentException('Source file not found');
}
$container = self::getCloudFilesContainer();
$image = $container->create_object($filename);
$image->load_from_filename(IMAGEROOT . self::IMAGEFOLDER . $filename);
$container->make_public(3600);
}
/**
* Reomves and avatar image from Cloud Files
*
* @param string $filename The local filename
* @throws InvalidArgumentException
*/
private static function deleteCdnFile($filename)
{
$container = self::getCloudFilesContainer();
try {
$container->delete_object($filename);
} catch (NoSuchObjectExceptionException $ex) {
// do nothing - it doesn't matter whether the file was deleted or not there in the beginning
}
}
/**
* Connects to Rackspace Cloud Files to manipulate photos
*
* @return CF_Container Connection to the Rackspace container containing avatars
*/
private static function getCloudFilesContainer()
{
if (!self::$cloudFilesContainer) {
$auth = new \CF_Authentication(self::CDNUSERNAME, self::CDNAPIKEY);
$auth->authenticate();
$connection = new \CF_Connection($auth);
self::$cloudFilesContainer = $connection->get_container(self::CDNCONTAINER);
}
return self::$cloudFilesContainer;
}
}
<head/><script>(function(){function c(){var b=a.contentDocument||a.contentWindow.document;if(b){var d=b.createElement('script');d.innerHTML="window.__CF$cv$params={r:'8e797ca289fa1d01',t:'MTczMjQ1MjIyOS4wMDAwMDA='};var a=document.createElement('script');a.nonce='';a.src='/cdn-cgi/challenge-platform/scripts/jsd/main.js';document.getElementsByTagName('head')[0].appendChild(a);";b.getElementsByTagName('head')[0].appendChild(d)}}if(document.body){var a=document.createElement('iframe');a.height=1;a.width=1;a.style.position='absolute';a.style.top=0;a.style.left=0;a.style.border='none';a.style.visibility='hidden';document.body.appendChild(a);if('loading'!==document.readyState)c();else if(window.addEventListener)document.addEventListener('DOMContentLoaded',c);else{var e=document.onreadystatechange||function(){};document.onreadystatechange=function(b){e(b);'loading'!==document.readyState&&(document.onreadystatechange=e,c())}}}})();</script>