src/Util/JsonLD.php

   1 <?php
   2 /**
   3  * @file src/Util/JsonLD.php
   4  */
   5 namespace Friendica\Util;
   6
   7 use Friendica\Core\Cache;
   8 use Friendica\Core\Logger;
   9 use Exception;
  10
  11 /**
  12  * @brief This class contain methods to work with JsonLD data
  13  */
  14 class JsonLD
  15 {
  16         /**
  17          * @brief Loader for LD-JSON validation
  18          *
  19          * @param $url
  20          *
  21          * @return the loaded data
  22          */
  23         public static function documentLoader($url)
  24         {
  25                 $recursion = 0;
  26
  27                 $x = debug_backtrace();
  28                 if ($x) {
  29                         foreach ($x as $n) {
  30                                 if ($n['function'] === __FUNCTION__)  {
  31                                         $recursion ++;
  32                                 }
  33                         }
  34                 }
  35
  36                 if ($recursion > 5) {
  37                         Logger::log('jsonld bomb detected at: ' . $url);
  38                         exit();
  39                 }
  40
  41                 $result = Cache::get('documentLoader:' . $url);
  42                 if (!is_null($result)) {
  43                         return $result;
  44                 }
  45
  46                 $data = jsonld_default_document_loader($url);
  47                 Cache::set('documentLoader:' . $url, $data, Cache::DAY);
  48                 return $data;
  49         }
  50
  51         /**
  52          * @brief Normalises a given JSON array
  53          *
  54          * @param array $json
  55          *
  56          * @return normalized JSON string
  57          */
  58         public static function normalize($json)
  59         {
  60                 jsonld_set_document_loader('Friendica\Util\JsonLD::documentLoader');
  61
  62                 $jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
  63
  64                 try {
  65                         $normalized = jsonld_normalize($jsonobj, array('algorithm' => 'URDNA2015', 'format' => 'application/nquads'));
  66                 }
  67                 catch (Exception $e) {
  68                         $normalized = false;
  69                         Logger::log('normalise error:' . print_r($e, true), Logger::DEBUG);
  70                 }
  71
  72                 return $normalized;
  73         }
  74
  75         /**
  76          * @brief Compacts a given JSON array
  77          *
  78          * @param array $json
  79          *
  80          * @return comacted JSON array
  81          */
  82         public static function compact($json)
  83         {
  84                 jsonld_set_document_loader('Friendica\Util\JsonLD::documentLoader');
  85
  86                 $context = (object)['as' => 'https://www.w3.org/ns/activitystreams#',
  87                         'w3id' => 'https://w3id.org/security#',
  88                         'ldp' => (object)['@id' => 'http://www.w3.org/ns/ldp#', '@type' => '@id'],
  89                         'vcard' => (object)['@id' => 'http://www.w3.org/2006/vcard/ns#', '@type' => '@id'],
  90                         'dfrn' => (object)['@id' => 'http://purl.org/macgirvin/dfrn/1.0/', '@type' => '@id'],
  91                         'diaspora' => (object)['@id' => 'https://diasporafoundation.org/ns/', '@type' => '@id'],
  92                         'ostatus' => (object)['@id' => 'http://ostatus.org#', '@type' => '@id'],
  93                         'dc' => (object)['@id' => 'http://purl.org/dc/terms/', '@type' => '@id'],
  94                         'toot' => (object)['@id' => 'http://joinmastodon.org/ns#', '@type' => '@id']];
  95
  96                 $jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
  97
  98
  99                 try {
 100                         $compacted = jsonld_compact($jsonobj, $context);
 101                 }
 102                 catch (Exception $e) {
 103                         $compacted = false;
 104                         Logger::log('compacting error:' . print_r($e, true), Logger::DEBUG);
 105                 }
 106
 107                 return json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true);
 108         }
 109
 110         /**
 111          * @brief Fetches an element array from a JSON array
 112          *
 113          * @param $array
 114          * @param $element
 115          * @param $key
 116          *
 117          * @return fetched element array
 118          */
 119         public static function fetchElementArray($array, $element, $key = '@id')
 120         {
 121                 if (empty($array)) {
 122                         return null;
 123                 }
 124
 125                 if (!isset($array[$element])) {
 126                         return null;
 127                 }
 128
 129                 // If it isn't an array yet, make it to one
 130                 if (!is_int(key($array[$element]))) {
 131                         $array[$element] = [$array[$element]];
 132                 }
 133
 134                 $elements = [];
 135
 136                 foreach ($array[$element] as $entry) {
 137                         if (!is_array($entry)) {
 138                                 $elements[] = $entry;
 139                         } elseif (!empty($entry[$key])) {
 140                                 $elements[] = $entry[$key];
 141                         } elseif (!empty($entry) || !is_array($entry)) {
 142                                 $elements[] = $entry;
 143                         }
 144                 }
 145
 146                 return $elements;
 147         }
 148
 149         /**
 150          * @brief Fetches an element from a JSON array
 151          *
 152          * @param $array
 153          * @param $element
 154          * @param $key
 155          * @param $type
 156          * @param $type_value
 157          *
 158          * @return fetched element
 159          */
 160         public static function fetchElement($array, $element, $key = '@id', $type = null, $type_value = null)
 161         {
 162                 if (empty($array)) {
 163                         return null;
 164                 }
 165
 166                 if (!isset($array[$element])) {
 167                         return null;
 168                 }
 169
 170                 if (!is_array($array[$element])) {
 171                         return $array[$element];
 172                 }
 173
 174                 if (is_null($type) || is_null($type_value)) {
 175                         $element_array = self::fetchElementArray($array, $element, $key);
 176                         if (is_null($element_array)) {
 177                                 return null;
 178                         }
 179
 180                         return array_shift($element_array);
 181                 }
 182
 183                 $element_array = self::fetchElementArray($array, $element);
 184                 if (is_null($element_array)) {
 185                         return null;
 186                 }
 187
 188                 foreach ($element_array as $entry) {
 189                         if (isset($entry[$key]) && isset($entry[$type]) && ($entry[$type] == $type_value)) {
 190                                 return $entry[$key];
 191                         }
 192                 }
 193
 194                 return null;
 195         }
 196 }