API: The legacy API finally moved

src/Module/Api/Friendica/Group/Create.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\Api\Friendica\Group;
+
+use Friendica\Database\DBA;
+use Friendica\Model\Group;
+use Friendica\Module\BaseApi;
+use Friendica\Network\HTTPException;
+
+/**
+ * API endpoint: /api/friendica/group_create
+ */
+class Create extends BaseApi
+{
+	protected function post(array $request = [])
+	{
+		BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
+		$uid = BaseApi::getCurrentUserID();
+	
+		// params
+		$name = $_REQUEST['name'] ?? '';
+		$json = json_decode($_POST['json'], true);
+		$users = $json['user'];
+	
+		// error if no name specified
+		if ($name == '') {
+			throw new HTTPException\BadRequestException('group name not specified');
+		}
+	
+		// error message if specified group name already exists
+		if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) {
+			throw new HTTPException\BadRequestException('group name already exists');
+		}
+	
+		// Check if the group needs to be reactivated
+		if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => true])) {
+			$reactivate_group = true;
+		}
+	
+		// create group
+		$ret = Group::create($uid, $name);
+		if ($ret) {
+			$gid = Group::getIdByName($uid, $name);
+		} else {
+			throw new HTTPException\BadRequestException('other API error');
+		}
+	
+		// add members
+		$erroraddinguser = false;
+		$errorusers = [];
+		foreach ($users as $user) {
+			$cid = $user['cid'];
+			if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) {
+				Group::addMember($gid, $cid);
+			} else {
+				$erroraddinguser = true;
+				$errorusers[] = $cid;
+			}
+		}
+	
+		// return success message incl. missing users in array
+		$status = ($erroraddinguser ? 'missing user' : ((isset($reactivate_group) && $reactivate_group) ? 'reactivated' : 'ok'));
+	
+		$result = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
+		
+		$this->response->exit('group_create', ['$result' => $result], $this->parameters['extension'] ?? null);
+	}
+}

src/Module/Api/Friendica/Group/Show.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\Api\Friendica\Group;
+
+use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Model\Contact;
+use Friendica\Module\BaseApi;
+use Friendica\Network\HTTPException;
+
+/**
+ * API endpoint: /api/friendica/group_show
+ */
+class Show extends BaseApi
+{
+	protected function post(array $request = [])
+	{
+		BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
+		$uid  = BaseApi::getCurrentUserID();
+		$type = $this->parameters['extension'] ?? '';
+	
+		// params
+		$gid = $_REQUEST['gid'] ?? 0;
+	
+		// get data of the specified group id or all groups if not specified
+		if ($gid != 0) {
+			$groups = DBA::selectToArray('group', [], ['deleted' => false, 'uid' => $uid, 'id' => $gid]);
+	
+			// error message if specified gid is not in database
+			if (!DBA::isResult($groups)) {
+				throw new HTTPException\BadRequestException('gid not available');
+			}
+		} else {
+			$groups = DBA::selectToArray('group', [], ['deleted' => false, 'uid' => $uid]);
+		}
+	
+		// loop through all groups and retrieve all members for adding data in the user array
+		$grps = [];
+		foreach ($groups as $rr) {
+			$members = Contact\Group::getById($rr['id']);
+			$users = [];
+	
+			if ($type == 'xml') {
+				$user_element = 'users';
+				$k = 0;
+				foreach ($members as $member) {
+					$user = DI::twitterUser()->createFromContactId($member['contact-id'], $uid, true)->toArray();
+					$users[$k++.':user'] = $user;
+				}
+			} else {
+				$user_element = 'user';
+				foreach ($members as $member) {
+					$user = DI::twitterUser()->createFromContactId($member['contact-id'], $uid, true)->toArray();
+					$users[] = $user;
+				}
+			}
+			$grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
+		}
+
+		$this->response->exit('group_update', ['group' => $grps], $this->parameters['extension'] ?? null);
+	}
+}

src/Module/Api/Friendica/Photo.php

@@ -22,29 +22,28 @@
 namespace Friendica\Module\Api\Friendica;
 
 use Friendica\DI;
+use Friendica\Model\Contact;
 use Friendica\Module\BaseApi;
-require_once __DIR__ . '/../../../../include/api.php';
+use Friendica\Network\HTTPException;
 
-/**
- * api/friendica
- *
- * @package Friendica\Module\Api\Friendica
- */
-class Index extends BaseApi
+class Activity extends BaseApi
 {
 	protected function post(array $request = [])
 	{
-		self::checkAllowedScope(self::SCOPE_WRITE);		
-	}
+		BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
+		$uid  = BaseApi::getCurrentUserID();
+		$type = $this->parameters['extension'] ?? '';
 
-	protected function delete(array $request = [])
-	{
-		self::checkAllowedScope(self::SCOPE_WRITE);
-	}
-
-	protected function rawContent(array $request = [])
-	{
-		echo api_call(DI::args()->getCommand(), $this->parameters['extension'] ?? 'json');
-		exit();
+		if (empty($_REQUEST['photo_id'])) {
+			throw new HTTPException\BadRequestException('No photo id.');
+		}
+	
+		$scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
+		$photo_id = $_REQUEST['photo_id'];
+	
+		// prepare json/xml output with data from database for the requested photo
+		$data = ['photo' => DI::friendicaPhoto()->createFromId($photo_id, $scale, $uid, $type)];
+	
+		$this->response->exit('statuses', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
 	}
 }

src/Module/Api/Friendica/Photo/Create.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\Api\Friendica\Photo;
+
+use Friendica\Core\ACL;
+use Friendica\DI;
+use Friendica\Model\Photo;
+use Friendica\Module\BaseApi;
+use Friendica\Network\HTTPException;
+
+/**
+ * API endpoint: /api/friendica/photo/create
+ */
+class Create extends BaseApi
+{
+	protected function post(array $request = [])
+	{
+		BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
+		$uid  = BaseApi::getCurrentUserID();
+		$type = $this->parameters['extension'] ?? '';
+
+		// input params
+		$desc      = $_REQUEST['desc']      ?? null;
+		$album     = $_REQUEST['album']     ?? null;
+		$allow_cid = $_REQUEST['allow_cid'] ?? null;
+		$deny_cid  = $_REQUEST['deny_cid' ] ?? null;
+		$allow_gid = $_REQUEST['allow_gid'] ?? null;
+		$deny_gid  = $_REQUEST['deny_gid' ] ?? null;
+	
+		// do several checks on input parameters
+		// we do not allow calls without album string
+		if ($album == null) {
+			throw new HTTPException\BadRequestException('no albumname specified');
+		}
+	
+		// error if no media posted in create-mode
+		if (empty($_FILES['media'])) {
+			// Output error
+			throw new HTTPException\BadRequestException('no media data submitted');
+		}
+	
+		// checks on acl strings provided by clients
+		$acl_input_error = false;
+		$acl_input_error |= !ACL::isValidContact($allow_cid, $uid);
+		$acl_input_error |= !ACL::isValidContact($deny_cid, $uid);
+		$acl_input_error |= !ACL::isValidGroup($allow_gid, $uid);
+		$acl_input_error |= !ACL::isValidGroup($deny_gid, $uid);
+		if ($acl_input_error) {
+			throw new HTTPException\BadRequestException('acl data invalid');
+		}
+		// now let's upload the new media in create-mode
+		$photo = Photo::upload($uid, $_FILES['media'], $album, trim($allow_cid), trim($allow_gid), trim($deny_cid), trim($deny_gid), $desc);
+
+		// return success of updating or error message
+		if (!empty($photo)) {
+			$data = ['photo' => DI::friendicaPhoto()->createFromId($photo['resource_id'], null, $uid, $type)];
+			$this->response->exit('photo_create', $data, $this->parameters['extension'] ?? null);
+			return;
+		} else {
+			throw new HTTPException\InternalServerErrorException('unknown error - uploading photo failed, see Friendica log for more information');
+		}
+	}
+}

src/Module/Api/Friendica/Photo/Lists.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\Api\Friendica\Photo;
+
+use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Module\BaseApi;
+use Friendica\Model\Contact;
+use Friendica\Model\Photo;
+
+/**
+ * Returns all lists the user subscribes to.
+ *
+ * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
+ */
+class Lists extends BaseApi
+{
+	protected function rawContent(array $request = [])
+	{
+		BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
+		$uid  = BaseApi::getCurrentUserID();
+		$type = $this->parameters['extension'] ?? '';
+
+		$photos = Photo::selectToArray(['resource-id'], ["`uid` = ? AND NOT `photo-type` IN (?, ?)", $uid, Photo::CONTACT_AVATAR, Photo::CONTACT_BANNER],
+			['order' => ['id'], 'group_by' => ['resource-id']]);
+	
+		$data = ['photo' => []];
+		if (DBA::isResult($photos)) {
+			foreach ($photos as $photo) {
+				$element = DI::friendicaPhoto()->createFromId($photo['resource-id'], null, $uid, 'json', false);
+	
+				$element['thumb'] = end($element['link']);
+				unset($element['link']);
+	
+				if ($type == 'xml') {
+					$thumb = $element['thumb'];
+					unset($element['thumb']);
+					$data['photo'][] = ['@attributes' => $element, '1' => $thumb];
+				} else {
+					$data['photo'][] = $element;
+				}
+			}
+		}
+
+		$this->response->exit('statuses', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
+	}
+}

src/Module/Api/Friendica/Photo/Update.php

@@ -0,0 +1,136 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\Api\Friendica\Photo;
+
+use Friendica\Core\ACL;
+use Friendica\DI;
+use Friendica\Model\Photo;
+use Friendica\Module\BaseApi;
+use Friendica\Network\HTTPException;
+
+/**
+ * API endpoint: /api/friendica/photo/update
+ */
+class Update extends BaseApi
+{
+	protected function post(array $request = [])
+	{
+		BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
+		$uid  = BaseApi::getCurrentUserID();
+		$type = $this->parameters['extension'] ?? '';
+	
+		// input params
+		$photo_id  = $_REQUEST['photo_id']  ?? null;
+		$desc      = $_REQUEST['desc']      ?? null;
+		$album     = $_REQUEST['album']     ?? null;
+		$album_new = $_REQUEST['album_new'] ?? null;
+		$allow_cid = $_REQUEST['allow_cid'] ?? null;
+		$deny_cid  = $_REQUEST['deny_cid' ] ?? null;
+		$allow_gid = $_REQUEST['allow_gid'] ?? null;
+		$deny_gid  = $_REQUEST['deny_gid' ] ?? null;
+	
+		// do several checks on input parameters
+		// we do not allow calls without album string
+		if ($album == null) {
+			throw new HTTPException\BadRequestException('no albumname specified');
+		}
+
+		// check if photo is existing in databasei
+		if (!Photo::exists(['resource-id' => $photo_id, 'uid' => $uid, 'album' => $album])) {
+			throw new HTTPException\BadRequestException('photo not available');
+		}
+	
+		// checks on acl strings provided by clients
+		$acl_input_error = false;
+		$acl_input_error |= !ACL::isValidContact($allow_cid, $uid);
+		$acl_input_error |= !ACL::isValidContact($deny_cid, $uid);
+		$acl_input_error |= !ACL::isValidGroup($allow_gid, $uid);
+		$acl_input_error |= !ACL::isValidGroup($deny_gid, $uid);
+		if ($acl_input_error) {
+			throw new HTTPException\BadRequestException('acl data invalid');
+		}
+	
+		$updated_fields = [];
+
+		if (!is_null($desc)) {
+			$updated_fields['desc'] = $desc;
+		}
+
+		if (!is_null($album_new)) {
+			$updated_fields['album'] = $album_new;
+		}
+
+		if (!is_null($allow_cid)) {
+			$allow_cid = trim($allow_cid);
+			$updated_fields['allow_cid'] = $allow_cid;
+		}
+
+		if (!is_null($deny_cid)) {
+			$deny_cid = trim($deny_cid);
+			$updated_fields['deny_cid'] = $deny_cid;
+		}
+
+		if (!is_null($allow_gid)) {
+			$allow_gid = trim($allow_gid);
+			$updated_fields['allow_gid'] = $allow_gid;
+		}
+
+		if (!is_null($deny_gid)) {
+			$deny_gid = trim($deny_gid);
+			$updated_fields['deny_gid'] = $deny_gid;
+		}
+
+		$result = false;
+		if (count($updated_fields) > 0) {
+			$nothingtodo = false;
+			$result = Photo::update($updated_fields, ['uid' => $uid, 'resource-id' => $photo_id, 'album' => $album]);
+		} else {
+			$nothingtodo = true;
+		}
+
+		if (!empty($_FILES['media'])) {
+			$nothingtodo = false;
+			$photo = Photo::upload($uid, $_FILES['media'], $album, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc, $photo_id);
+			if (!empty($photo)) {
+				$data = ['photo' => DI::friendicaPhoto()->createFromId($photo['resource_id'], null, $uid, $type)];
+				$this->response->exit('photo_update', $data, $this->parameters['extension'] ?? null);
+				return;
+			}
+		}
+
+		// return success of updating or error message
+		if ($result) {
+			$answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
+			$this->response->exit('photo_update', ['$result' => $answer], $this->parameters['extension'] ?? null);
+			return;
+		} else {
+			if ($nothingtodo) {
+				$answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
+				$this->response->exit('photo_update', ['$result' => $answer], $this->parameters['extension'] ?? null);
+				return;
+			}
+			throw new HTTPException\InternalServerErrorException('unknown error - update photo entry in database failed');
+		}
+
+		throw new HTTPException\InternalServerErrorException('unknown error - this error on uploading or updating a photo should never happen');
+	}
+}