dolibarr  20.0.0-alpha
Functions
geturl.lib.php File Reference

This file contains functions dedicated to get URLs. More...

Go to the source code of this file.

Functions

 getURLContent ($url, $postorget='GET', $param='', $followlocation=1, $addheaders=array(), $allowedschemes=array('http', 'https'), $localurl=0, $ssl_verifypeer=-1)
 Function to get a content from an URL (use proxy if proxy defined). More...
 
 isIPAllowed ($iptocheck, $localurl)
 Is IP allowed. More...
 
 getDomainFromURL ($url, $mode=0)
 Function get second level domain name. More...
 
 getRootURLFromURL ($url)
 Function root url from a long url For example: https://www.abc.mydomain.com/dir/page.html return 'https://www.abc.mydomain.com' For example: https://www.abc.mydomain.com/ return 'https://www.abc.mydomain.com' For example: http://www.abc.mydomain.com/ return 'http://www.abc.mydomain.com'. More...
 
 removeHtmlComment ($content)
 Function to remove comments into HTML content. More...
 

Detailed Description

This file contains functions dedicated to get URLs.

Definition in file geturl.lib.php.

Function Documentation

◆ getDomainFromURL()

getDomainFromURL (   $url,
  $mode = 0 
)

Function get second level domain name.

For example: https://www.abc.mydomain.com/dir/page.html return 'mydomain'

Parameters
string$urlFull URL.
int$mode0=return 'mydomain', 1=return 'mydomain.com', 2=return 'abc.mydomain.com'
Returns
string Returns domaine name

Definition at line 361 of file geturl.lib.php.

◆ getRootURLFromURL()

getRootURLFromURL (   $url)

Function root url from a long url For example: https://www.abc.mydomain.com/dir/page.html return 'https://www.abc.mydomain.com' For example: https://www.abc.mydomain.com/ return 'https://www.abc.mydomain.com' For example: http://www.abc.mydomain.com/ return 'http://www.abc.mydomain.com'.

Parameters
string$urlFull URL.
Returns
string Returns root url

Definition at line 414 of file geturl.lib.php.

◆ getURLContent()

getURLContent (   $url,
  $postorget = 'GET',
  $param = '',
  $followlocation = 1,
  $addheaders = array(),
  $allowedschemes = array('http', 'https'),
  $localurl = 0,
  $ssl_verifypeer = -1 
)

Function to get a content from an URL (use proxy if proxy defined).

Support Dolibarr setup for timeout and proxy. Enhancement of CURL to add an anti SSRF protection:

  • you can set MAIN_SECURITY_ANTI_SSRF_SERVER_IP to set static ip of server
  • common local lookup ips like 127.*.*.* are automatically added
Parameters
string$urlURL to call.
string$postorget'POST', 'GET', 'HEAD', 'PUT', 'PUTALREADYFORMATED', 'POSTALREADYFORMATED', 'DELETE'
string$paramParameters of URL (x=value1&y=value2) or may be a formatted content with $postorget='PUTALREADYFORMATED'
integer$followlocation0=Do not follow, 1=Follow location.
string[]$addheadersArray of string to add into header. Example: ('Accept: application/xrds+xml', ....)
string[]$allowedschemesList of schemes that are allowed ('http' + 'https' only by default)
int$localurl0=Only external URL are possible, 1=Only local URL, 2=Both external and local URL are allowed.
int$ssl_verifypeer-1=Auto (no ssl check on dev, check on prod), 0=No ssl check, 1=Always ssl check
Returns
array Returns an associative array containing the response from the server array('http_code'=>http response code, 'content'=>response, 'curl_error_no'=>errno, 'curl_error_msg'=>errmsg...)

Definition at line 42 of file geturl.lib.php.

Referenced by ICal\read_file().

◆ isIPAllowed()

isIPAllowed (   $iptocheck,
  $localurl 
)

Is IP allowed.

Parameters
string$iptocheckIP to check
int$localurl0=external url only, 1=internal url only
Returns
string Error message or ''

Definition at line 305 of file geturl.lib.php.

◆ removeHtmlComment()

removeHtmlComment (   $content)

Function to remove comments into HTML content.

Parameters
string$contentText content
Returns
string Returns text without HTML comments

Definition at line 425 of file geturl.lib.php.