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
  95                 $jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
  96
  97
  98                 try {
  99                         $compacted = jsonld_compact($jsonobj, $context);
 100                 }
 101                 catch (Exception $e) {
 102                         $compacted = false;
 103                         Logger::log('compacting error:' . print_r($e, true), Logger::DEBUG);
 104                 }
 105
 106                 return json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true);
 107         }
 108
 109         /**
 110          * @brief Fetches an element array from a JSON array
 111          *
 112          * @param $array
 113          * @param $element
 114          * @param $key
 115          *
 116          * @return fetched element array
 117          */
 118         public static function fetchElementArray($array, $element, $key = '@id')
 119         {
 120                 if (empty($array)) {
 121                         return null;
 122                 }
 123
 124                 if (!isset($array[$element])) {
 125                         return null;
 126                 }
 127
 128                 // If it isn't an array yet, make it to one
 129                 if (!is_int(key($array[$element]))) {
 130                         $array[$element] = [$array[$element]];
 131                 }
 132
 133                 $elements = [];
 134
 135                 foreach ($array[$element] as $entry) {
 136                         if (!is_array($entry)) {
 137                                 $elements[] = $entry;
 138                         } elseif (!empty($entry[$key])) {
 139                                 $elements[] = $entry[$key];
 140                         } elseif (!empty($entry) || !is_array($entry)) {
 141                                 $elements[] = $entry;
 142                         }
 143                 }
 144
 145                 return $elements;
 146         }
 147
 148         /**
 149          * @brief Fetches an element from a JSON array
 150          *
 151          * @param $array
 152          * @param $element
 153          * @param $key
 154          * @param $type
 155          * @param $type_value
 156          *
 157          * @return fetched element
 158          */
 159         public static function fetchElement($array, $element, $key = '@id', $type = null, $type_value = null)
 160         {
 161                 if (empty($array)) {
 162                         return null;
 163                 }
 164
 165                 if (!isset($array[$element])) {
 166                         return null;
 167                 }
 168
 169                 if (!is_array($array[$element])) {
 170                         return $array[$element];
 171                 }
 172
 173                 if (is_null($type) || is_null($type_value)) {
 174                         $element_array = self::fetchElementArray($array, $element, $key);
 175                         if (is_null($element_array)) {
 176                                 return null;
 177                         }
 178
 179                         return array_shift($element_array);
 180                 }
 181
 182                 $element_array = self::fetchElementArray($array, $element);
 183                 if (is_null($element_array)) {
 184                         return null;
 185                 }
 186
 187                 foreach ($element_array as $entry) {
 188                         if (isset($entry[$key]) && isset($entry[$type]) && ($entry[$type] == $type_value)) {
 189                                 return $entry[$key];
 190                         }
 191                 }
 192
 193                 return null;
 194         }
 195 }