]> git.mxchange.org Git - friendica.git/blob - src/Object/Api/Mastodon/Instance.php
API: Central way to fetch the system rules
[friendica.git] / src / Object / Api / Mastodon / Instance.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2022, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
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.
11  *
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.
16  *
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/>.
19  *
20  */
21
22 namespace Friendica\Object\Api\Mastodon;
23
24 use Friendica\App;
25 use Friendica\App\BaseURL;
26 use Friendica\BaseDataTransferObject;
27 use Friendica\Core\Config\Capability\IManageConfigValues;
28 use Friendica\Database\Database;
29 use Friendica\DI;
30 use Friendica\Model\User;
31 use Friendica\Module\Register;
32 use Friendica\Network\HTTPException;
33
34 /**
35  * Class Instance
36  *
37  * @see https://docs.joinmastodon.org/api/entities/#instance
38  */
39 class Instance extends BaseDataTransferObject
40 {
41         /** @var string (URL) */
42         protected $uri;
43         /** @var string */
44         protected $title;
45         /** @var string */
46         protected $short_description;
47         /** @var string */
48         protected $description;
49         /** @var string */
50         protected $email;
51         /** @var string */
52         protected $version;
53         /** @var array */
54         protected $urls;
55         /** @var Stats */
56         protected $stats;
57         /** @var string|null */
58         protected $thumbnail = null;
59         /** @var array */
60         protected $languages;
61         /** @var int */
62         protected $max_toot_chars;
63         /** @var bool */
64         protected $registrations;
65         /** @var bool */
66         protected $approval_required;
67         /** @var bool */
68         protected $invites_enabled;
69         /** @var Account|null */
70         protected $contact_account = null;
71         /** @var array */
72         protected $rules = [];
73
74         /**
75          * @param IManageConfigValues $config
76          * @param BaseURL             $baseUrl
77          * @param Database            $database
78          * @param array               $rules
79          * @throws HTTPException\InternalServerErrorException
80          * @throws HTTPException\NotFoundException
81          * @throws \ImagickException
82          */
83         public function __construct(IManageConfigValues $config, BaseURL $baseUrl, Database $database, array $rules = [])
84         {
85                 $register_policy = intval($config->get('config', 'register_policy'));
86
87                 $this->uri               = $baseUrl->get();
88                 $this->title             = $config->get('config', 'sitename');
89                 $this->short_description = $this->description = $config->get('config', 'info');
90                 $this->email             = implode(',', User::getAdminEmailList());
91                 $this->version           = '2.8.0 (compatible; Friendica ' . App::VERSION . ')';
92                 $this->urls              = null; // Not supported
93                 $this->stats             = new Stats($config, $database);
94                 $this->thumbnail         = $baseUrl->get() . ($config->get('system', 'shortcut_icon') ?? 'images/friendica-32.png');
95                 $this->languages         = [$config->get('system', 'language')];
96                 $this->max_toot_chars    = (int)$config->get('config', 'api_import_size', $config->get('config', 'max_import_size'));
97                 $this->registrations     = ($register_policy != Register::CLOSED);
98                 $this->approval_required = ($register_policy == Register::APPROVE);
99                 $this->invites_enabled   = false;
100                 $this->contact_account   = [];
101                 $this->rules             = $rules;
102
103                 $administrator = User::getFirstAdmin(['nickname']);
104                 if ($administrator) {
105                         $adminContact = $database->selectFirst('contact', ['uri-id'], ['nick' => $administrator['nickname'], 'self' => true]);
106                         $this->contact_account = DI::mstdnAccount()->createFromUriId($adminContact['uri-id']);
107                 }
108         }
109 }