Activitypub_notice.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. <?php
  2. // This file is part of GNU social - https://www.gnu.org/software/social
  3. //
  4. // GNU social is free software: you can redistribute it and/or modify
  5. // it under the terms of the GNU Affero General Public License as published by
  6. // the Free Software Foundation, either version 3 of the License, or
  7. // (at your option) any later version.
  8. //
  9. // GNU social is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU Affero General Public License for more details.
  13. //
  14. // You should have received a copy of the GNU Affero General Public License
  15. // along with GNU social. If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17. * ActivityPub implementation for GNU social
  18. *
  19. * @package GNUsocial
  20. * @author Diogo Cordeiro <diogo@fc.up.pt>
  21. * @copyright 2018-2019 Free Software Foundation, Inc http://www.fsf.org
  22. * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  23. * @link http://www.gnu.org/software/social/
  24. */
  25. defined('GNUSOCIAL') || die();
  26. /**
  27. * ActivityPub notice representation
  28. *
  29. * @category Plugin
  30. * @package GNUsocial
  31. * @author Diogo Cordeiro <diogo@fc.up.pt>
  32. * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  33. */
  34. class Activitypub_notice
  35. {
  36. /**
  37. * Generates a pretty notice from a Notice object
  38. *
  39. * @param Notice $notice
  40. * @return array array to be used in a response
  41. * @throws EmptyPkeyValueException
  42. * @throws InvalidUrlException
  43. * @throws ServerException
  44. * @throws Exception
  45. * @author Diogo Cordeiro <diogo@fc.up.pt>
  46. */
  47. public static function notice_to_array($notice)
  48. {
  49. $profile = $notice->getProfile();
  50. $attachments = [];
  51. foreach ($notice->attachments() as $attachment) {
  52. $attachments[] = Activitypub_attachment::attachment_to_array($attachment);
  53. }
  54. $tags = [];
  55. foreach ($notice->getTags() as $tag) {
  56. if ($tag != "") { // Hacky workaround to avoid stupid outputs
  57. $tags[] = Activitypub_tag::tag_to_array($tag);
  58. }
  59. }
  60. if ($notice->isPublic()) {
  61. $to = ['https://www.w3.org/ns/activitystreams#Public'];
  62. $cc = [common_local_url('apActorFollowers', ['id' => $profile->getID()])];
  63. } else {
  64. // Since we currently don't support sending unlisted/followers-only
  65. // notices, arriving here means we're instead answering to that type
  66. // of posts. Not having subscription policy working, its safer to
  67. // always send answers of type unlisted.
  68. $to = [];
  69. $cc = ['https://www.w3.org/ns/activitystreams#Public'];
  70. }
  71. foreach ($notice->getAttentionProfiles() as $to_profile) {
  72. $to[] = $href = $to_profile->getUri();
  73. $tags[] = Activitypub_mention_tag::mention_tag_to_array_from_values($href, $to_profile->getNickname() . '@' . parse_url($href, PHP_URL_HOST));
  74. }
  75. $item = [
  76. '@context' => 'https://www.w3.org/ns/activitystreams',
  77. 'id' => self::getUrl($notice),
  78. 'type' => 'Note',
  79. 'published' => str_replace(' ', 'T', $notice->getCreated()) . 'Z',
  80. 'url' => self::getUrl($notice),
  81. 'attributedTo' => $profile->getUri(),
  82. 'to' => $to,
  83. 'cc' => $cc,
  84. 'conversation' => $notice->getConversationUrl(),
  85. 'content' => $notice->getRendered(),
  86. 'isLocal' => $notice->isLocal(),
  87. 'attachment' => $attachments,
  88. 'tag' => $tags
  89. ];
  90. // Is this a reply?
  91. if (!empty($notice->reply_to)) {
  92. $item['inReplyTo'] = self::getUrl(Notice::getById($notice->reply_to));
  93. }
  94. // Do we have a location for this notice?
  95. try {
  96. $location = Notice_location::locFromStored($notice);
  97. $item['latitude'] = $location->lat;
  98. $item['longitude'] = $location->lon;
  99. } catch (Exception $e) {
  100. // Apparently no.
  101. }
  102. return $item;
  103. }
  104. /**
  105. * Create a Notice via ActivityPub Note Object.
  106. * Returns created Notice.
  107. *
  108. * @param array $object
  109. * @param Profile $actor_profile
  110. * @param bool $directMessage
  111. * @return Notice
  112. * @throws Exception
  113. * @author Diogo Cordeiro <diogo@fc.up.pt>
  114. */
  115. public static function create_notice(array $object, Profile $actor_profile, bool $directMessage = false): Notice
  116. {
  117. $id = $object['id']; // int
  118. $url = isset($object['url']) ? $object['url'] : $id; // string
  119. $content = $object['content']; // string
  120. // possible keys: ['inReplyTo', 'latitude', 'longitude']
  121. $settings = [];
  122. if (isset($object['inReplyTo'])) {
  123. $settings['inReplyTo'] = $object['inReplyTo'];
  124. }
  125. if (isset($object['latitude'])) {
  126. $settings['latitude'] = $object['latitude'];
  127. }
  128. if (isset($object['longitude'])) {
  129. $settings['longitude'] = $object['longitude'];
  130. }
  131. $act = new Activity();
  132. $act->verb = ActivityVerb::POST;
  133. $act->time = time();
  134. $act->actor = $actor_profile->asActivityObject();
  135. $act->context = new ActivityContext();
  136. $options = ['source' => 'ActivityPub',
  137. 'uri' => $id,
  138. 'url' => $url,
  139. 'is_local' => self::getNotePolicyType($object, $actor_profile)];
  140. if ($directMessage) {
  141. $options['scope'] = Notice::MESSAGE_SCOPE;
  142. }
  143. // Is this a reply?
  144. if (isset($settings['inReplyTo'])) {
  145. try {
  146. $inReplyTo = ActivityPubPlugin::grab_notice_from_url($settings['inReplyTo']);
  147. $act->context->replyToID = $inReplyTo->getUri();
  148. $act->context->replyToUrl = $inReplyTo->getUrl();
  149. } catch (Exception $e) {
  150. // It failed to grab, maybe we got this note from another source
  151. // (e.g.: OStatus) that handles this differently or we really
  152. // failed to get it...
  153. // Welp, nothing that we can do about, let's
  154. // just fake we don't have such notice.
  155. }
  156. } else {
  157. $inReplyTo = null;
  158. }
  159. // Mentions
  160. $mentions = [];
  161. if (isset($object['tag']) && is_array($object['tag'])) {
  162. foreach ($object['tag'] as $tag) {
  163. if (array_key_exists('type', $tag) && $tag['type'] == 'Mention') {
  164. $mentions[] = $tag['href'];
  165. }
  166. }
  167. }
  168. $mentions_profiles = [];
  169. $discovery = new Activitypub_explorer;
  170. foreach ($mentions as $mention) {
  171. try {
  172. $mentions_profiles[] = $discovery->lookup($mention)[0];
  173. } catch (Exception $e) {
  174. // Invalid actor found, just let it go. // TODO: Fallback to OStatus
  175. }
  176. }
  177. unset($discovery);
  178. foreach ($mentions_profiles as $mp) {
  179. if (!$mp->hasBlocked($actor_profile)) {
  180. $act->context->attention[$mp->getUri()] = 'http://activitystrea.ms/schema/1.0/person';
  181. }
  182. }
  183. // Add location if that is set
  184. if (isset($settings['latitude'], $settings['longitude'])) {
  185. $act->context->location = Location::fromLatLon($settings['latitude'], $settings['longitude']);
  186. }
  187. /* Reject notice if it is too long (without the HTML)
  188. if (Notice::contentTooLong($content)) {
  189. throw new Exception('That\'s too long. Maximum notice size is %d character.');
  190. }*/
  191. $actobj = new ActivityObject();
  192. $actobj->type = ActivityObject::NOTE;
  193. $actobj->content = strip_tags($content, '<p><b><i><u><a><ul><ol><li>');
  194. // Finally add the activity object to our activity
  195. $act->objects[] = $actobj;
  196. $note = Notice::saveActivity($act, $actor_profile, $options);
  197. return $note;
  198. }
  199. /**
  200. * Validates a note.
  201. *
  202. * @param array $object
  203. * @return bool false if unacceptable for GS but valid ActivityPub object
  204. * @throws Exception if invalid ActivityPub object
  205. * @author Diogo Cordeiro <diogo@fc.up.pt>
  206. */
  207. public static function validate_note($object)
  208. {
  209. if (!isset($object['id'])) {
  210. common_debug('ActivityPub Notice Validator: Rejected because Object ID was not specified.');
  211. throw new Exception('Object ID not specified.');
  212. } elseif (!filter_var($object['id'], FILTER_VALIDATE_URL)) {
  213. common_debug('ActivityPub Notice Validator: Rejected because Object ID is invalid.');
  214. throw new Exception('Invalid Object ID.');
  215. }
  216. if (!isset($object['type']) || $object['type'] !== 'Note') {
  217. common_debug('ActivityPub Notice Validator: Rejected because of Type.');
  218. throw new Exception('Invalid Object type.');
  219. }
  220. if (isset($object['url']) && !filter_var($object['url'], FILTER_VALIDATE_URL)) {
  221. common_debug('ActivityPub Notice Validator: Rejected because Object URL is invalid.');
  222. throw new Exception('Invalid Object URL.');
  223. }
  224. if (!(isset($object['to']) && isset($object['cc']))) {
  225. common_debug('ActivityPub Notice Validator: Rejected because either Object CC or TO wasn\'t specified.');
  226. throw new Exception('Either Object CC or TO wasn\'t specified.');
  227. }
  228. if (!isset($object['content'])) {
  229. common_debug('ActivityPub Notice Validator: Rejected because Content was not specified (GNU social requires content in notes).');
  230. return false;
  231. }
  232. return true;
  233. }
  234. /**
  235. * Get the original representation URL of a given notice.
  236. *
  237. * @param Notice $notice notice from which to retrieve the URL
  238. * @return string URL
  239. * @throws InvalidUrlException
  240. * @throws Exception
  241. * @author Bruno Casteleiro <brunoccast@fc.up.pt>
  242. */
  243. public static function getUrl(Notice $notice): string
  244. {
  245. if ($notice->isLocal()) {
  246. return common_local_url('apNotice', ['id' => $notice->getID()]);
  247. } else {
  248. return $notice->getUrl();
  249. }
  250. }
  251. /**
  252. * Extract note policy type from note targets.
  253. *
  254. * @param array $note received Note
  255. * @param Profile $actor_profile Note author
  256. * @return int Notice policy type
  257. * @author Bruno Casteleiro <brunoccast@fc.up.pt>
  258. */
  259. public static function getNotePolicyType(array $note, Profile $actor_profile): int
  260. {
  261. if (in_array('https://www.w3.org/ns/activitystreams#Public', $note['to'])) {
  262. return $actor_profile->isLocal() ? Notice::LOCAL_PUBLIC : Notice::REMOTE;
  263. } else {
  264. // either an unlisted or followers-only note, we'll handle
  265. // both as a GATEWAY notice since this type is not visible
  266. // from the public timelines, hence partially enough while
  267. // we don't have subscription_policy working.
  268. return Notice::GATEWAY;
  269. }
  270. }
  271. }