3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module\Api\Mastodon;
24 use Friendica\Core\System;
26 use Friendica\Module\BaseApi;
27 use Friendica\Model\Circle;
30 * @see https://docs.joinmastodon.org/methods/timelines/lists/
32 class Lists extends BaseApi
34 protected function delete(array $request = [])
36 $this->checkAllowedScope(self::SCOPE_WRITE);
37 $uid = self::getCurrentUserID();
39 if (empty($this->parameters['id'])) {
40 $this->logErrorAndJsonExit(422, $this->errorFactory->UnprocessableEntity());
43 if (!Circle::exists($this->parameters['id'], $uid)) {
44 $this->logErrorAndJsonExit(404, $this->errorFactory->RecordNotFound());
47 if (!Circle::remove($this->parameters['id'])) {
48 DI::mstdnError()->InternalError();
54 protected function post(array $request = [])
56 $this->checkAllowedScope(self::SCOPE_WRITE);
57 $uid = self::getCurrentUserID();
59 $request = $this->getRequest([
63 if (empty($request['title'])) {
64 $this->logErrorAndJsonExit(422, $this->errorFactory->UnprocessableEntity());
67 Circle::create($uid, $request['title']);
69 $id = Circle::getIdByName($uid, $request['title']);
71 DI::mstdnError()->InternalError();
74 $this->jsonExit(DI::mstdnList()->createFromCircleId($id));
77 public function put(array $request = [])
79 $request = $this->getRequest([
80 'title' => '', // The title of the list to be updated.
81 'replies_policy' => '', // One of: "followed", "list", or "none".
84 if (empty($request['title']) || empty($this->parameters['id'])) {
85 $this->logErrorAndJsonExit(422, $this->errorFactory->UnprocessableEntity());
88 Circle::update($this->parameters['id'], $request['title']);
92 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
94 protected function rawContent(array $request = [])
96 $this->checkAllowedScope(self::SCOPE_READ);
97 $uid = self::getCurrentUserID();
99 if (empty($this->parameters['id'])) {
102 foreach (Circle::getByUserId($uid) as $circle) {
103 $lists[] = DI::mstdnList()->createFromCircleId($circle['id']);
106 $id = $this->parameters['id'];
108 if (!Circle::exists($id, $uid)) {
109 $this->logErrorAndJsonExit(404, $this->errorFactory->RecordNotFound());
111 $lists = DI::mstdnList()->createFromCircleId($id);
114 $this->jsonExit($lists);