]> git.mxchange.org Git - friendica.git/blobdiff - mod/parse_url.php
Merge branch 'develop' into rewrites/dbm_is_result
[friendica.git] / mod / parse_url.php
index a6b7cd5024c9aa929120ebb7b87b03901297f848..44cf80935e2bd237aa437a55969c82c1f2823c84 100644 (file)
@@ -1,27 +1,25 @@
 <?php
+
 /** 
  * @file mod/parse_url.php
+ * @brief The parse_url module
  * 
- * @todo https://developers.google.com/+/plugins/snippet/
- * 
- * @verbatim
- * <meta itemprop="name" content="Toller Titel">
- * <meta itemprop="description" content="Eine tolle Beschreibung">
- * <meta itemprop="image" content="http://maple.libertreeproject.org/images/tree-icon.png">
+ * This module does parse an url for embedable content (audio, video, image files or link)
+ * information and does format this information to BBCode or html (this depends
+ * on the user settings - default is BBCode output).
+ * If the user has enabled the richtext editor setting the output will be in html
+ * (Note: This is not always possible and in some case not useful because
+ * the richtext editor doesn't support all kind of html).
+ * Otherwise the output will be constructed BBCode.
  * 
- * <body itemscope itemtype="http://schema.org/Product">
- *   <h1 itemprop="name">Shiny Trinket</h1>
- *   <img itemprop="image" src="{image-url}" />
- *   <p itemprop="description">Shiny trinkets are shiny.</p>
- * </body>
- * @endverbatim
+ * @see ParseUrl::getSiteinfo() for more information about scraping embeddable content 
 */
 
 use \Friendica\ParseUrl;
 
 require_once("include/items.php");
 
-function parse_url_content(&$a) {
+function parse_url_content(App &$a) {
 
        $text = null;
        $str_tags = "";
@@ -67,8 +65,8 @@ function parse_url_content(&$a) {
 
        logger("prse_url: " . $url);
 
-       // If the URL is a image, video or audio file format the URL with the corresponding
-       // BBCode media tag
+       // Check if the URL is an image, video or audio file. If so format
+       // the URL with the corresponding BBCode media tag
        $redirects = 0;
        // Fetch the header of the URL
        $result = z_fetch_url($url, false, $redirects, array("novalidate" => true, "nobody" => true));
@@ -114,7 +112,8 @@ function parse_url_content(&$a) {
                killme();
        }
 
-
+       // If there is allready some content information submitted we don't
+       // need to parse the url for content.
        if ($url && $title && $text) {
 
                $title = str_replace(array("\r","\n"),array("",""),$title);
@@ -134,7 +133,7 @@ function parse_url_content(&$a) {
                killme();
        }
 
-       // Fetch the information from the webpage
+       // Fetch the information directly from the webpage
        $siteinfo = ParseUrl::getSiteinfo($url);
 
        unset($siteinfo["keywords"]);
@@ -151,3 +150,27 @@ function parse_url_content(&$a) {
 
        killme();
 }
+
+/**
+ * @brief Legacy function to call ParseUrl::getSiteinfoCached
+ * 
+ * Note: We have moved the function to ParseUrl.php. This function is only for
+ * legacy support and will be remove in the future
+ * 
+ * @param type $url The url of the page which should be scraped
+ * @param type $no_guessing If true the parse doens't search for
+ *    preview pictures
+ * @param type $do_oembed The false option is used by the function fetch_oembed()
+ *    to avoid endless loops
+ * 
+ * @return array which contains needed data for embedding
+ * 
+ * @see ParseUrl::getSiteinfoCached()
+ * 
+ * @todo Remove this function after all Addons has been changed to use
+ *    ParseUrl::getSiteinfoCached
+ */
+function parseurl_getsiteinfo_cached($url, $no_guessing = false, $do_oembed = true) {
+       $siteinfo = ParseUrl::getSiteinfoCached($url, $no_guessing, $do_oembed);
+       return $siteinfo;
+}