* @category wallabag
* @author Nicolas Lœuillet <nicolas@loeuillet.org>
* @copyright 2013
- * @license http://www.wtfpl.net/ see COPYING file
+ * @license http://opensource.org/licenses/MIT see COPYING file
*/
-class Tools
+final class Tools
{
+ private function __construct()
+ {
+
+ }
+
+ /**
+ * Initialize PHP environment
+ */
public static function initPhp()
{
define('START_TIME', microtime(true));
- if (phpversion() < 5) {
- die(_('Oops, it seems you don\'t have PHP 5.'));
- }
-
function stripslashesDeep($value) {
return is_array($value)
? array_map('stripslashesDeep', $value)
register_shutdown_function('ob_end_flush');
}
+ /**
+ * Get wallabag instance URL
+ *
+ * @return string
+ */
public static function getPocheUrl()
{
$https = (!empty($_SERVER['HTTPS'])
. $host . $serverport . $scriptname;
}
+ /**
+ * Redirects to a URL
+ *
+ * @param string $url
+ */
public static function redirect($url = '')
{
if ($url === '') {
$url = $ref;
}
}
+
self::logm('redirect to ' . $url);
header('Location: '.$url);
exit();
}
+ /**
+ * Returns name of the template file to display
+ *
+ * @param $view
+ * @return string
+ */
public static function getTplFile($view)
{
$views = array(
'edit-tags', 'view', 'login', 'error'
);
- if (in_array($view, $views)) {
- return $view . '.twig';
- }
-
- return 'home.twig';
+ return (in_array($view, $views) ? $view . '.twig' : 'home.twig');
}
+ /**
+ * Download a file (typically, for downloading pictures on web server)
+ *
+ * @param $url
+ * @return bool|mixed|string
+ */
public static function getFile($url)
{
$timeout = 15;
}
}
+ /**
+ * Headers for JSON export
+ *
+ * @param $data
+ */
public static function renderJson($data)
{
header('Cache-Control: no-cache, must-revalidate');
exit();
}
+ /**
+ * Create new line in log file
+ *
+ * @param $message
+ */
public static function logm($message)
{
if (DEBUG_POCHE && php_sapi_name() != 'cli') {
}
}
+ /**
+ * Encode a URL by using a salt
+ *
+ * @param $string
+ * @return string
+ */
public static function encodeString($string)
{
return sha1($string . SALT);
}
+ /**
+ * Cleans a variable
+ *
+ * @param $var
+ * @param string $default
+ * @return string
+ */
public static function checkVar($var, $default = '')
{
- return ((isset ($_REQUEST["$var"])) ? htmlentities($_REQUEST["$var"]) : $default);
+ return ((isset($_REQUEST["$var"])) ? htmlentities($_REQUEST["$var"]) : $default);
}
+ /**
+ * Returns the domain name for a URL
+ *
+ * @param $url
+ * @return string
+ */
public static function getDomain($url)
{
return parse_url($url, PHP_URL_HOST);
}
- public static function getReadingTime($text) {
- $word = str_word_count(strip_tags($text));
- $minutes = floor($word / 200);
- $seconds = floor($word % 200 / (200 / 60));
- $time = array('minutes' => $minutes, 'seconds' => $seconds);
-
- return $minutes;
- }
-
- public static function getDocLanguage($userlanguage) {
- $lang = explode('.', $userlanguage);
- return str_replace('_', '-', $lang[0]);
+ /**
+ * For a given text, we calculate reading time for an article
+ *
+ * @param $text
+ * @return float
+ */
+ public static function getReadingTime($text)
+ {
+ return floor(str_word_count(strip_tags($text)) / 200);
}
- public static function status($status_code)
+ /**
+ * Returns the correct header for a status code
+ *
+ * @param $status_code
+ */
+ private static function _status($status_code)
{
if (strpos(php_sapi_name(), 'apache') !== false) {
}
}
- public static function download_db() {
+ /**
+ * Download the sqlite database
+ */
+ public static function downloadDb()
+ {
header('Content-Disposition: attachment; filename="poche.sqlite.gz"');
- self::status(200);
+ self::_status(200);
header('Content-Transfer-Encoding: binary');
header('Content-Type: application/octet-stream');
exit;
}
+ /**
+ * Get the content for a given URL (by a call to FullTextFeed)
+ *
+ * @param Url $url
+ * @return mixed
+ */
public static function getPageContent(Url $url)
{
// Saving and clearing context
$REAL = array();
foreach( $GLOBALS as $key => $value ) {
if( $key != 'GLOBALS' && $key != '_SESSION' && $key != 'HTTP_SESSION_VARS' ) {
- $GLOBALS[$key] = array();
- $REAL[$key] = $value;
+ $GLOBALS[$key] = array();
+ $REAL[$key] = $value;
}
}
// Saving and clearing session
- if ( isset($_SESSION) ) {
+ if (isset($_SESSION)) {
$REAL_SESSION = array();
foreach( $_SESSION as $key => $value ) {
$REAL_SESSION[$key] = $value;
$scope = function() {
extract( func_get_arg(1) );
$_GET = $_REQUEST = array(
- "url" => $url->getUrl(),
- "max" => 5,
- "links" => "preserve",
- "exc" => "",
- "format" => "json",
- "submit" => "Create Feed"
+ "url" => $url->getUrl(),
+ "max" => 5,
+ "links" => "preserve",
+ "exc" => "",
+ "format" => "json",
+ "submit" => "Create Feed"
);
ob_start();
require func_get_arg(0);
ob_end_clean();
return $json;
};
- $json = $scope( "inc/3rdparty/makefulltextfeed.php", array("url" => $url) );
+
+ $json = $scope("inc/3rdparty/makefulltextfeed.php", array("url" => $url));
// Clearing and restoring context
- foreach( $GLOBALS as $key => $value ) {
- if( $key != "GLOBALS" && $key != "_SESSION" ) {
+ foreach ($GLOBALS as $key => $value) {
+ if($key != "GLOBALS" && $key != "_SESSION" ) {
unset($GLOBALS[$key]);
}
}
- foreach( $REAL as $key => $value ) {
+ foreach ($REAL as $key => $value) {
$GLOBALS[$key] = $value;
}
+
// Clearing and restoring session
- if ( isset($REAL_SESSION) ) {
- foreach( $_SESSION as $key => $value ) {
+ if (isset($REAL_SESSION)) {
+ foreach($_SESSION as $key => $value) {
unset($_SESSION[$key]);
}
- foreach( $REAL_SESSION as $key => $value ) {
+
+ foreach($REAL_SESSION as $key => $value) {
$_SESSION[$key] = $value;
}
}
/**
* Returns whether we handle an AJAX (XMLHttpRequest) request.
+ *
* @return boolean whether we handle an AJAX (XMLHttpRequest) request.
*/
public static function isAjaxRequest()
{
- return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH']==='XMLHttpRequest';
+ return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH']==='XMLHttpRequest';
}
}
projects / github / wallabag / wallabag.git / blobdiff