catavatar/catavatar.php

   1 <?php
   2 /**
   3  * Name: Cat Avatar Generator
   4  * Description: Generate a default avatar based on David Revoy's cat-avatar-generator https://framagit.org/Deevad/cat-avatar-generator
   5  * Version: 1.1
   6  * Author: Fabio <https://kirgroup.com/profile/fabrixxm>
   7  */
   8
   9 use Friendica\App;
  10 use Friendica\Core\Config;
  11 use Friendica\Core\Hook;
  12 use Friendica\Core\L10n;
  13 use Friendica\Core\Logger;
  14 use Friendica\Core\PConfig;
  15 use Friendica\Core\Renderer;
  16 use Friendica\Core\Worker;
  17 use Friendica\Database\DBA;
  18 use Friendica\DI;
  19 use Friendica\Model\Contact;
  20 use Friendica\Model\Photo;
  21 use Friendica\Network\HTTPException\NotFoundException;
  22
  23 define("CATAVATAR_SIZE", 256);
  24
  25 /**
  26  * Installs the addon hook
  27  */
  28 function catavatar_install()
  29 {
  30         Hook::register('avatar_lookup', 'addon/catavatar/catavatar.php', 'catavatar_lookup');
  31         Hook::register('addon_settings', 'addon/catavatar/catavatar.php', 'catavatar_addon_settings');
  32         Hook::register('addon_settings_post', 'addon/catavatar/catavatar.php', 'catavatar_addon_settings_post');
  33
  34         Logger::log('registered catavatar');
  35 }
  36
  37 /**
  38  * Removes the addon hook
  39  */
  40 function catavatar_uninstall()
  41 {
  42         Hook::unregister('avatar_lookup', 'addon/catavatar/catavatar.php', 'catavatar_lookup');
  43         Hook::unregister('addon_settings', 'addon/catavatar/catavatar.php', 'catavatar_addon_settings');
  44         Hook::unregister('addon_settings_post', 'addon/catavatar/catavatar.php', 'catavatar_addon_settings_post');
  45
  46         Logger::log('unregistered catavatar');
  47 }
  48
  49 /**
  50  * Cat avatar user settings page
  51  */
  52 function catavatar_addon_settings(App $a, &$s)
  53 {
  54         if (!local_user()) {
  55                 return;
  56         }
  57
  58         $t = Renderer::getMarkupTemplate('settings.tpl', 'addon/catavatar/');
  59         $s .= Renderer::replaceMacros($t, [
  60                 '$postpost' => !empty($_POST['catavatar-morecat']) || !empty($_POST['catavatar-emailcat']),
  61                 '$uncache' => time(),
  62                 '$uid' => local_user(),
  63                 '$usecat' => L10n::t('Use Cat as Avatar'),
  64                 '$morecat' => L10n::t('More Random Cat!'),
  65                 '$emailcat' => L10n::t('Reset to email Cat'),
  66                 '$seed' => DI::pConfig()->get(local_user(), 'catavatar', 'seed', false),
  67                 '$header' => L10n::t('Cat Avatar Settings'),
  68         ]);
  69 }
  70
  71 /**
  72  * Cat avatar user settings POST handle
  73  */
  74 function catavatar_addon_settings_post(App $a, &$s)
  75 {
  76         if (!local_user()) {
  77                 return;
  78         }
  79
  80         // delete the current cached cat avatar
  81         $condition = ['uid' => local_user(), 'blocked' => false,
  82                         'account_expired' => false, 'account_removed' => false];
  83         $user = DBA::selectFirst('user', ['email'], $condition);
  84
  85         $seed = DI::pConfig()->get(local_user(), 'catavatar', 'seed', md5(trim(strtolower($user['email']))));
  86
  87         if (!empty($_POST['catavatar-usecat'])) {
  88                 $url = DI::baseUrl()->get() . '/catavatar/' . local_user() . '?ts=' . time();
  89
  90                 $self = DBA::selectFirst('contact', ['id'], ['uid' => local_user(), 'self' => true]);
  91                 if (!DBA::isResult($self)) {
  92                         notice(L10n::t("The cat hadn't found itself."));
  93                         return;
  94                 }
  95
  96                 Photo::importProfilePhoto($url, local_user(), $self['id']);
  97
  98                 $condition = ['uid' => local_user(), 'contact-id' => $self['id']];
  99                 $photo = DBA::selectFirst('photo', ['resource-id'], $condition);
 100                 if (!DBA::isResult($photo)) {
 101                         notice(L10n::t('There was an error, the cat ran away.'));
 102                         return;
 103                 }
 104
 105                 DBA::update('photo', ['profile' => false], ['profile' => true, 'uid' => local_user()]);
 106
 107                 $fields = ['profile' => true, 'album' => L10n::t('Profile Photos'), 'contact-id' => 0];
 108                 DBA::update('photo', $fields, ['uid' => local_user(), 'resource-id' => $photo['resource-id']]);
 109
 110                 Photo::importProfilePhoto($url, local_user(), $self['id']);
 111
 112                 Contact::updateSelfFromUserID(local_user(), true);
 113
 114                 // Update global directory in background
 115                 $url = DI::baseUrl()->get() . '/profile/' . $a->user['nickname'];
 116                 if ($url && strlen(Config::get('system', 'directory'))) {
 117                         Worker::add(PRIORITY_LOW, 'Directory', $url);
 118                 }
 119
 120                 Worker::add(PRIORITY_LOW, 'ProfileUpdate', local_user());
 121
 122                 info(L10n::t('Meow!'));
 123                 return;
 124         }
 125
 126         if (!empty($_POST['catavatar-morecat'])) {
 127                 DI::pConfig()->set(local_user(), 'catavatar', 'seed', time());
 128         }
 129
 130         if (!empty($_POST['catavatar-emailcat'])) {
 131                 DI::pConfig()->delete(local_user(), 'catavatar', 'seed');
 132         }
 133 }
 134
 135 /**
 136  * Returns the URL to the cat avatar
 137  *
 138  * @param $a array
 139  * @param &$b array
 140  */
 141 function catavatar_lookup(App $a, &$b)
 142 {
 143         $user = DBA::selectFirst('user', ['uid'], ['email' => $b['email']]);
 144         $url = DI::baseUrl()->get() . '/catavatar/' . $user['uid'];
 145
 146         switch($b['size']) {
 147                 case 300: $url .= "/4"; break;
 148                 case 80: $url .= "/5"; break;
 149                 case 47: $url .= "/6"; break;
 150         }
 151
 152         $b['url'] = $url;
 153         $b['success'] = true;
 154 }
 155
 156 function catavatar_module() {}
 157
 158 /**
 159  * Returns image for user id
 160  *
 161  * @throws NotFoundException
 162  *
 163  */
 164 function catavatar_content(App $a)
 165 {
 166         if ($a->argc < 2 || $a->argc > 3) {
 167                 throw new NotFoundException(); // this should be catched on index and show default "not found" page.
 168         }
 169
 170         $uid = intval($a->argv[1]);
 171
 172         $size = 0;
 173         if ($a->argc == 3) {
 174                 $size = intval($a->argv[2]);
 175         }
 176
 177         $condition = ['uid' => $uid,
 178                         'account_expired' => false, 'account_removed' => false];
 179         $user = DBA::selectFirst('user', ['email'], $condition);
 180
 181         if ($user === false) {
 182                 throw new NotFoundException();
 183         }
 184
 185         $seed = DI::pConfig()->get($uid, "catavatar", "seed", md5(trim(strtolower($user['email']))));
 186
 187         // ...Or start generation
 188         ob_start();
 189
 190         // render the picture:
 191         build_cat($seed, $size);
 192
 193         ob_end_flush();
 194
 195         exit();
 196 }
 197
 198
 199
 200 /**
 201  * ====================
 202  * CAT-AVATAR-GENERATOR
 203  * ====================
 204  *
 205  * @authors: Andreas Gohr, David Revoy
 206  *
 207  * This PHP is licensed under the short and simple permissive:
 208  * [MIT License](https://en.wikipedia.org/wiki/MIT_License)
 209  *
 210 **/
 211
 212 function build_cat($seed = '', $size = 0)
 213 {
 214         // init random seed
 215         if ($seed) {
 216                 srand(hexdec(substr(md5($seed), 0, 6)));
 217         }
 218
 219         // throw the dice for body parts
 220         $parts = array(
 221                 'body' => rand(1, 15),
 222                 'fur' => rand(1, 10),
 223                 'eyes' => rand(1, 15),
 224                 'mouth' => rand(1, 10),
 225                 'accessorie' => rand(1, 20)
 226         );
 227
 228         // create backgound
 229         $cat = @imagecreatetruecolor(CATAVATAR_SIZE, CATAVATAR_SIZE)
 230                 or die("GD image create failed");
 231         $white = imagecolorallocate($cat, 255, 255, 255);
 232         imagefill($cat, 0, 0, $white);
 233
 234         // add parts
 235         foreach ($parts as $part => $num) {
 236                 $file = dirname(__FILE__) . '/avatars/' . $part . '_' . $num . '.png';
 237
 238                 $im = @imagecreatefrompng($file);
 239                 if (!$im) {
 240                         die('Failed to load ' . $file);
 241                 }
 242                 imageSaveAlpha($im, true);
 243                 imagecopy($cat, $im, 0, 0, 0, 0, CATAVATAR_SIZE, CATAVATAR_SIZE);
 244                 imagedestroy($im);
 245         }
 246
 247         // scale image
 248         if ($size > 3 && $size < 7) {
 249                 switch ($size) {
 250                         case 4:
 251                                 $size = 300;
 252                                 break;
 253                         case 5:
 254                                 $size = 80;
 255                                 break;
 256                         case 6:
 257                                 $size = 48;
 258                                 break;
 259                 }
 260
 261                 $dest = imagecreatetruecolor($size, $size);
 262                 imagealphablending($dest, false);
 263                 imagesavealpha($dest, true);
 264                 imagecopyresampled($dest, $cat, 0, 0, 0, 0, $size, $size, CATAVATAR_SIZE, CATAVATAR_SIZE);
 265                 imagedestroy($cat);
 266                 $cat = $dest;
 267         }
 268
 269         // restore random seed
 270         if ($seed) {
 271                 srand();
 272         }
 273
 274         header('Pragma: public');
 275         header('Cache-Control: max-age=86400');
 276         header('Expires: ' . gmdate('D, d M Y H:i:s \G\M\T', time() + 86400));
 277         header('Content-Type: image/jpg');
 278         imagejpeg($cat, NULL, 90);
 279         imagedestroy($cat);
 280 }