mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-01 21:19:11 -06:00
131 lines
3.3 KiB
PHP
131 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Help.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* This software may be modified and distributed under the terms of the
|
|
* Creative Commons Attribution-ShareAlike 4.0 International License.
|
|
*
|
|
* See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types = 1);
|
|
namespace FireflyIII\Helpers\Help;
|
|
|
|
use Cache;
|
|
use League\CommonMark\CommonMarkConverter;
|
|
use Log;
|
|
use Requests;
|
|
use Requests_Exception;
|
|
use Route;
|
|
|
|
/**
|
|
* Class Help
|
|
*
|
|
* @package FireflyIII\Helpers\Help
|
|
*/
|
|
class Help implements HelpInterface
|
|
{
|
|
/** @var string */
|
|
protected $userAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36';
|
|
|
|
/**
|
|
* @param string $route
|
|
* @param string $language
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFromCache(string $route, string $language): string
|
|
{
|
|
$line = sprintf('help.%s.%s', $route, $language);
|
|
|
|
return Cache::get($line);
|
|
}
|
|
|
|
/**
|
|
* @param string $route
|
|
* @param string $language
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFromGithub(string $route, string $language): string
|
|
{
|
|
|
|
$uri = sprintf('https://raw.githubusercontent.com/firefly-iii/help/master/%s/%s.md', $language, $route);
|
|
Log::debug(sprintf('Trying to get %s...', $uri));
|
|
$opt = ['useragent' => $this->userAgent];
|
|
$content = '';
|
|
try {
|
|
$result = Requests::get($uri, [], $opt);
|
|
} catch (Requests_Exception $e) {
|
|
Log::error($e);
|
|
|
|
return '';
|
|
}
|
|
|
|
|
|
Log::debug(sprintf('Status code is %d', $result->status_code));
|
|
|
|
if ($result->status_code === 200) {
|
|
$content = trim($result->body);
|
|
}
|
|
if (strlen($content) > 0) {
|
|
Log::debug('Content is longer than zero. Expect something.');
|
|
$converter = new CommonMarkConverter();
|
|
$content = $converter->convertToHtml($content);
|
|
}
|
|
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $route
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasRoute(string $route): bool
|
|
{
|
|
return Route::has($route);
|
|
}
|
|
|
|
/**
|
|
* @param string $route
|
|
* @param string $language
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function inCache(string $route, string $language): bool
|
|
{
|
|
$line = sprintf('help.%s.%s', $route, $language);
|
|
$result = Cache::has($line);
|
|
if ($result) {
|
|
Log::debug(sprintf('Cache has this entry: %s', 'help.' . $route . '.' . $language));
|
|
}
|
|
if (!$result) {
|
|
Log::debug(sprintf('Cache does not have this entry: %s', 'help.' . $route . '.' . $language));
|
|
}
|
|
|
|
return $result;
|
|
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $route
|
|
* @param string $language
|
|
* @param string $content
|
|
*
|
|
*/
|
|
public function putInCache(string $route, string $language, string $content)
|
|
{
|
|
$key = sprintf('help.%s.%s', $route, $language);
|
|
if (strlen($content) > 0) {
|
|
Log::debug(sprintf('Will store entry in cache: %s', $key));
|
|
Cache::put($key, $content, 10080); // a week.
|
|
return;
|
|
}
|
|
Log::info(sprintf('Will not cache %s because content is empty.', $key));
|
|
}
|
|
}
|