-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Svg color api #9984
Svg color api #9984
Changes from 17 commits
84e90e2
98a0113
29ff7ef
ccd70a4
09f591f
d904293
8977c71
9e58859
a24cad1
cd6f00a
59db525
14bc9ff
dccfed8
6194681
6ed8c19
9159ed3
bfc6fc8
37a4d2b
9d94cc1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
<?php | ||
declare (strict_types = 1); | ||
/** | ||
* @copyright Copyright (c) 2018, John Molakvoæ (skjnldsv@protonmail.com) | ||
* | ||
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
* | ||
*/ | ||
|
||
namespace OC\Core\Controller; | ||
|
||
use OCP\AppFramework\Controller; | ||
use OCP\AppFramework\Http; | ||
use OCP\AppFramework\Http\DataDisplayResponse; | ||
use OCP\AppFramework\Http\NotFoundResponse; | ||
use OCP\AppFramework\Utility\ITimeFactory; | ||
use OCP\Files\NotFoundException; | ||
use OCP\IRequest; | ||
|
||
class SvgController extends Controller { | ||
|
||
/** @var string */ | ||
protected $serverRoot; | ||
|
||
/** @var ITimeFactory */ | ||
protected $timeFactory; | ||
|
||
public function __construct(string $appName, | ||
IRequest $request, | ||
ITimeFactory $timeFactory) { | ||
parent::__construct($appName, $request); | ||
|
||
$this->serverRoot = \OC::$SERVERROOT; | ||
$this->timeFactory = $timeFactory; | ||
} | ||
|
||
/** | ||
* @NoAdminRequired | ||
* @NoCSRFRequired | ||
* | ||
* Generate svg from filename with the requested color | ||
* | ||
* @param string $folder | ||
* @param string $fileName | ||
* @param string $color | ||
* @return DataDisplayResponse|NotFoundException | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You don't return an exception you throw it ;) |
||
*/ | ||
public function getSvgFromCore(string $folder, string $fileName, string $color = 'ffffff') { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can also declare return types ;) |
||
$path = $this->serverRoot . "/core/img/$folder/$fileName.svg"; | ||
return $this->getSvg($path, $color, $fileName); | ||
} | ||
|
||
/** | ||
* @NoAdminRequired | ||
* @NoCSRFRequired | ||
* | ||
* Generate svg from filename with the requested color | ||
* | ||
* @param string $app | ||
* @param string $fileName | ||
* @param string $color | ||
* @return DataDisplayResponse|NotFoundException | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. NotFoundResponse it seems |
||
*/ | ||
public function getSvgFromApp(string $app, string $fileName, string $color = 'ffffff') { | ||
|
||
if ($app === 'settings') { | ||
$path = $this->serverRoot . "/settings/img/$fileName.svg"; | ||
return $this->getSvg($path, $color, $fileName); | ||
} | ||
|
||
$appPath = \OC_App::getAppWebPath($app); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can't the appmanager do this? |
||
if (!$appPath) { | ||
return new NotFoundResponse(); | ||
} | ||
$path = $this->serverRoot . $appPath ."/img/$fileName.svg"; | ||
return $this->getSvg($path, $color, $fileName); | ||
} | ||
|
||
|
||
/** | ||
* Generate svg from filename with the requested color | ||
* | ||
* @param string $path | ||
* @param string $color | ||
* @return DataDisplayResponse|NotFoundException | ||
*/ | ||
private function getSvg(string $path, string $color, string $fileName) { | ||
if (!file_exists($path)) { | ||
return new NotFoundResponse(); | ||
} | ||
|
||
$svg = file_get_contents($path); | ||
|
||
if (is_null($svg)) { | ||
return new NotFoundResponse(); | ||
} | ||
|
||
// add fill (fill is not present on black elements) | ||
$fillRe = '/<((circle|rect|path)((?!fill)[a-z0-9 =".\-#():;])+)\/>/mi'; | ||
|
||
$svg = preg_replace($fillRe, '<$1 fill="#' . $color . '"/>', $svg); | ||
|
||
// replace any fill or stroke colors | ||
$svg = preg_replace('/stroke="#([a-z0-9]{3,6})"/mi', 'stroke="#' . $color . '"', $svg); | ||
$svg = preg_replace('/fill="#([a-z0-9]{3,6})"/mi', 'fill="#' . $color . '"', $svg); | ||
|
||
$response = new DataDisplayResponse($svg, Http::STATUS_OK, ['Content-Type' => 'image/svg+xml']); | ||
|
||
// Set cache control | ||
$ttl = 31536000; | ||
$response->cacheFor($ttl); | ||
$response->addHeader('Content-Disposition', 'inline; filename="' . $fileName . '.svg"'); | ||
$expires = new \DateTime(); | ||
$expires->setTimestamp($this->timeFactory->getTime()); | ||
$expires->add(new \DateInterval('PT' . $ttl . 'S')); | ||
$response->addHeader('Expires', $expires->format(\DateTime::RFC1123)); | ||
$response->addHeader('Pragma', 'cache'); | ||
|
||
return $response; | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we get rid of this invert rule as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, header needs to use the proper urls
Or we need to exclude the variable invert for the header icons :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I'd say we should exclude those. Their color anyway depends on the theming app color so we should keep that and not invert it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hum, since we're changing the global variables, I'm not sure we can ignore them :/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about just setting the icon for the header with $color-primary-text instead of $color-white? Then they should not be inverted, if I get the code right.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So we would have the regular .icon-contacts with $color-white and a header .icon-contacts with $color-primary-text. Yes this will be some duplication, but the icons where this is used are quite limited, so it would be ok i think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@juliushaertl Of course!!! Great thinking! 👍 🤗