3 * wallabag, self hostable application allowing you to not miss any content anymore
6 * @author Nicolas LÅ“uillet <nicolas@loeuillet.org>
8 * @license http://opensource.org/licenses/MIT see COPYING file
14 * Initialize PHP environment
16 public static function initPhp()
18 define('START_TIME', microtime(true));
20 function stripslashesDeep($value) {
21 return is_array($value)
22 ? array_map('stripslashesDeep', $value)
23 : stripslashes($value);
26 if (get_magic_quotes_gpc()) {
27 $_POST = array_map('stripslashesDeep', $_POST);
28 $_GET = array_map('stripslashesDeep', $_GET);
29 $_COOKIE = array_map('stripslashesDeep', $_COOKIE);
33 register_shutdown_function('ob_end_flush');
37 * Get wallabag instance URL
41 public static function getPocheUrl()
45 $https = (!empty($_SERVER['HTTPS'])
46 && (strtolower($_SERVER['HTTPS']) == 'on'))
47 || (isset($_SERVER["SERVER_PORT"])
48 && $_SERVER["SERVER_PORT"] == '443') // HTTPS detection.
49 || (isset($_SERVER["SERVER_PORT"]) //Custom HTTPS port detection
50 && $_SERVER["SERVER_PORT"] == SSL_PORT
)
51 || (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])
52 && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https');
54 $serverport = (!isset($_SERVER["SERVER_PORT"])
55 || $_SERVER["SERVER_PORT"] == '80'
56 || $_SERVER["SERVER_PORT"] == HTTP_PORT
57 || ($https && $_SERVER["SERVER_PORT"] == '443')
58 || ($https && $_SERVER["SERVER_PORT"]==SSL_PORT
) //Custom HTTPS port detection
59 ? '' : ':' . $_SERVER["SERVER_PORT"]);
61 if (isset($_SERVER["HTTP_X_FORWARDED_PORT"])) {
62 $serverport = ':' . $_SERVER["HTTP_X_FORWARDED_PORT"];
65 $scriptname = str_replace('/index.php', '/', $_SERVER["SCRIPT_NAME"]);
67 if (!isset($_SERVER["HTTP_HOST"])) {
71 $host = (isset($_SERVER['HTTP_X_FORWARDED_HOST']) ? $_SERVER['HTTP_X_FORWARDED_HOST'] : (isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_SERVER['SERVER_NAME']));
73 if (strpos($host, ':') !== false) {
77 // check if BASE_URL is configured
81 $baseUrl = 'http' . ($https ? 's' : '') . '://' . $host . $serverport;
84 return $baseUrl . $scriptname;
93 public static function redirect($url = '')
96 $url = (empty($_SERVER['HTTP_REFERER'])?'?':$_SERVER['HTTP_REFERER']);
97 if (isset($_POST['returnurl'])) {
98 $url = $_POST['returnurl'];
103 if (empty($url) || parse_url($url, PHP_URL_QUERY
) === $_SERVER['QUERY_STRING']) {
104 $url = Tools
::getPocheUrl();
107 if (substr($url, 0, 1) !== '?') {
108 $ref = Tools
::getPocheUrl();
109 if (substr($url, 0, strlen($ref)) !== $ref) {
114 self
::logm('redirect to ' . $url);
115 header('Location: '.$url);
120 * Returns name of the template file to display
125 public static function getTplFile($view)
128 'install', 'import', 'export', 'config', 'tags',
129 'edit-tags', 'view', 'login', 'error', 'about', 'register'
132 return (in_array($view, $views) ? $view . '.twig' : 'home.twig');
136 * Download a file (typically, for downloading pictures on web server)
139 * @return bool|mixed|string
141 public static function getFile($url)
144 $useragent = "Mozilla/5.0 (Windows NT 6.3; rv:36.0) Gecko/20100101 Firefox/36.0";
146 if (in_array ('curl', get_loaded_extensions())) {
147 # Fetch feed from URL
149 curl_setopt($curl, CURLOPT_URL
, $url);
150 curl_setopt($curl, CURLOPT_TIMEOUT
, $timeout);
151 if (!ini_get('open_basedir') && !ini_get('safe_mode')) {
152 curl_setopt($curl, CURLOPT_FOLLOWLOCATION
, true);
154 curl_setopt($curl, CURLOPT_RETURNTRANSFER
, true);
155 curl_setopt($curl, CURLOPT_HEADER
, false);
157 # for ssl, do not verified certificate
158 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER
, FALSE);
159 curl_setopt($curl, CURLOPT_AUTOREFERER
, TRUE );
161 # FeedBurner requires a proper USER-AGENT...
162 curl_setopt($curl, CURL_HTTP_VERSION_1_1
, true);
163 curl_setopt($curl, CURLOPT_ENCODING
, "gzip, deflate");
164 curl_setopt($curl, CURLOPT_USERAGENT
, $useragent);
166 $data = curl_exec($curl);
167 $httpcode = curl_getinfo($curl, CURLINFO_HTTP_CODE
);
168 $httpcodeOK = isset($httpcode) and ($httpcode == 200 or $httpcode == 301);
171 # create http context and add timeout and user-agent
172 $context = stream_context_create(
175 'timeout' => $timeout,
176 'header' => "User-Agent: " . $useragent,
177 'follow_location' => true
180 'verify_peer' => false,
181 'allow_self_signed' => true
186 # only download page lesser than 4MB
187 $data = @file_get_contents($url, false, $context, -1, 4000000);
189 if (isset($http_response_header) and isset($http_response_header[0])) {
190 $httpcodeOK = isset($http_response_header) and isset($http_response_header[0]) and ((strpos($http_response_header[0], '200 OK') !== FALSE) or (strpos($http_response_header[0], '301 Moved Permanently') !== FALSE));
194 # if response is not empty and response is OK
195 if (isset($data) and isset($httpcodeOK) and $httpcodeOK) {
197 # take charset of page and get it
198 preg_match('#<meta .*charset=.*>#Usi', $data, $meta);
200 # if meta tag is found
201 if (!empty($meta[0])) {
202 preg_match('#charset="?(.*)"#si', $meta[0], $encoding);
203 # if charset is found set it otherwise, set it to utf-8
204 $html_charset = (!empty($encoding[1])) ? strtolower($encoding[1]) : 'utf-8';
205 if (empty($encoding[1])) $encoding[1] = 'utf-8';
207 $html_charset = 'utf-8';
211 # replace charset of url to charset of page
212 $data = str_replace('charset=' . $encoding[1], 'charset=' . $html_charset, $data);
222 * Headers for JSON export
226 public static function renderJson($data)
228 header('Cache-Control: no-cache, must-revalidate');
229 header('Expires: Sat, 26 Jul 1997 05:00:00 GMT');
230 header('Content-type: application/json; charset=UTF-8');
231 echo json_encode($data);
236 * UTF-8 encode array of string
240 public static function utf8ize($data)
244 foreach ($data as $k => $v)
246 $data[$k] = self
::utf8ize($v);
249 else if (is_string ($data))
251 return utf8_encode($data);
257 * Create new line in log file
261 public static function logm($message)
263 if (DEBUG_POCHE
&& php_sapi_name() != 'cli') {
264 $t = strval(date('Y/m/d_H:i:s')) . ' - ' . $_SERVER["REMOTE_ADDR"] . ' - ' . strval($message) . "\n";
265 file_put_contents(CACHE
. '/log.txt', $t, FILE_APPEND
);
266 error_log('DEBUG POCHE : ' . $message);
271 * Encode a URL by using a salt
276 public static function encodeString($string)
278 return sha1($string . SALT
);
285 * @param string $default
288 public static function checkVar($var, $default = '')
290 return ((isset($_REQUEST["$var"])) ? htmlentities($_REQUEST["$var"]) : $default);
294 * Returns the domain name for a URL
299 public static function getDomain($url)
301 return parse_url($url, PHP_URL_HOST
);
305 * For a given text, we calculate reading time for an article
310 public static function getReadingTime($text)
312 return floor(str_word_count(strip_tags($text)) / 200);
316 * Returns the correct header for a status code
318 * @param $status_code
320 private static function _status($status_code)
322 if (strpos(php_sapi_name(), 'apache') !== false) {
324 header('HTTP/1.0 '.$status_code);
328 header('Status: '.$status_code);
333 * Get the content for a given URL (by a call to FullTextFeed)
338 public static function getPageContent(Url
$url)
340 // Saving and clearing context
342 foreach( $GLOBALS as $key => $value ) {
343 if( $key != 'GLOBALS' && $key != '_SESSION' && $key != 'HTTP_SESSION_VARS' ) {
344 $GLOBALS[$key] = array();
345 $REAL[$key] = $value;
348 // Saving and clearing session
349 if (isset($_SESSION)) {
350 $REAL_SESSION = array();
351 foreach( $_SESSION as $key => $value ) {
352 $REAL_SESSION[$key] = $value;
353 unset($_SESSION[$key]);
357 // Running code in different context
358 $scope = function() {
359 extract( func_get_arg(1) );
360 $_GET = $_REQUEST = array(
361 "url" => $url->getUrl(),
363 "links" => "preserve",
366 "submit" => "Create Feed"
369 require func_get_arg(0);
370 $json = ob_get_contents();
375 // Silence $scope function to avoid
376 // issues with FTRSS when error_reporting is to high
377 // FTRSS generates PHP warnings which break output
378 $json = @$scope("inc/3rdparty/makefulltextfeed.php", array("url" => $url));
380 // Clearing and restoring context
381 foreach ($GLOBALS as $key => $value) {
382 if($key != "GLOBALS" && $key != "_SESSION" ) {
383 unset($GLOBALS[$key]);
386 foreach ($REAL as $key => $value) {
387 $GLOBALS[$key] = $value;
390 // Clearing and restoring session
391 if (isset($REAL_SESSION)) {
392 foreach($_SESSION as $key => $value) {
393 unset($_SESSION[$key]);
396 foreach($REAL_SESSION as $key => $value) {
397 $_SESSION[$key] = $value;
401 return json_decode($json, true);
405 * Returns whether we handle an AJAX (XMLHttpRequest) request.
407 * @return boolean whether we handle an AJAX (XMLHttpRequest) request.
409 public static function isAjaxRequest()
411 return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH']==='XMLHttpRequest';
417 public static function emptyCache()
419 $files = new RecursiveIteratorIterator(
420 new RecursiveDirectoryIterator(CACHE
, RecursiveDirectoryIterator
::SKIP_DOTS
),
421 RecursiveIteratorIterator
::CHILD_FIRST
424 foreach ($files as $fileInfo) {
425 $filename = $fileInfo->getFilename();
426 if (!$filename[0] == '.') {
427 $todo = ($fileInfo->isDir() ? 'rmdir' : 'unlink');
428 $todo($fileInfo->getRealPath());
432 Tools
::logm('empty cache');
436 public static function generateToken()
438 if (ini_get('open_basedir') === '') {
439 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
440 // alternative to /dev/urandom for Windows
441 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
443 $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
447 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
450 return str_replace('+', '', $token);
455 * Returns the doctype for an HTML document (used for Mozilla Bookmarks)
456 * @param simple_html_dom $doc
457 * @return doctype $el
461 public static function get_doctype($doc)
463 $els = $doc->find('unknown');
465 foreach ($els as $e => $el)
466 if ($el->parent()->tag
== 'root')