dolibarr 21.0.0-alpha
mastodonhandler.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2024 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
4 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
26require_once DOL_DOCUMENT_ROOT.'/core/class/socialnetworkmanager.class.php';
27
28
33{
37 private $posts;
38
42 public $error = '';
43
47 private $accessToken;
48
52 private $clientId;
53
57 private $clientSecret;
58
62 private $redirectUri;
63
64
70 public function __construct($authParams)
71 {
72
73 $this->clientId = $authParams['client_id'] ?? '';
74 $this->clientSecret = $authParams['client_secret'] ?? '';
75 $this->redirectUri = $authParams['redirect_uri'] ?? '';
76 $this->accessToken = $authParams['access_token'] ?? '';
77 }
78
79
90 public function fetch($urlAPI, $maxNb = 5, $cacheDelay = 60, $cacheDir = '', $authParams = [])
91 {
92 if (empty($this->accessToken) && isset($authParams['access_token'])) {
93 return false;
94 }
95 $cacheFile = $cacheDir.'/'.dol_hash($urlAPI, '3');
96 $foundInCache = false;
97 $data = null;
98
99 // Check cache
100 if ($cacheDelay > 0 && $cacheDir && dol_is_file($cacheFile)) {
101 $fileDate = dol_filemtime($cacheFile);
102 if ($fileDate >= (dol_now() - $cacheDelay)) {
103 $foundInCache = true;
104 $data = file_get_contents($cacheFile);
105 }
106 }
107
108 if (!$foundInCache) {
109 $headers = [
110 'Authorization: Bearer ' . $this->accessToken,
111 'Content-Type: application/json'
112 ];
113
114 $result = getURLContent($urlAPI, 'GET', '', 1, $headers, array('http', 'https'), 0);
115 if (!empty($result['content'])) {
116 $data = $result['content'];
117
118 if ($cacheDir) {
119 dol_mkdir($cacheDir);
120 file_put_contents($cacheFile, $data);
121 }
122 } else {
123 $this->error = 'Error retrieving URL ' . $urlAPI;
124 return false;
125 }
126 }
127 if (!is_null($data)) {
128 $data = json_decode($data, true);
129 if (is_array($data)) {
130 $this->posts = [];
131 $count = 0;
132
133 foreach ($data as $postData) {
134 if ($count >= $maxNb) {
135 break;
136 }
137 $this->posts[$count] = $this->normalizeData($postData);
138 $count++;
139 }
140 return $this->posts;
141 } else {
142 $this->error = 'Invalid data format or empty response';
143 return false;
144 }
145 } else {
146 $this->error = 'Failed to retrieve or decode data';
147 return false;
148 }
149 }
150
157 public function normalizeData($postData)
158 {
159 if (!is_array($postData)) {
160 return [];
161 }
162 return [
163 'id' => $postData['id'] ?? '',
164 'content' => strip_tags($postData['content'] ?? ''),
165 'created_at' => $this->formatDate($postData['created_at'] ?? ''),
166 'url' => $postData['url'] ?? '',
167 'media_url' => $postData['media_attachments'][0]['url'] ?? ''
168 ];
169 }
170
176 private function formatDate($dateString)
177 {
178 $timestamp = is_numeric($dateString) ? (int) $dateString : strtotime($dateString);
179 return $timestamp > 0 ? dol_print_date($timestamp, "dayhour", 'tzuserrel') : 'Invalid Date';
180 }
181
187 public function getPosts()
188 {
189 return $this->posts;
190 }
191
196 public function getRedirectUri()
197 {
198 return $this->redirectUri;
199 }
200
205 public function getAccessToken()
206 {
207 return $this->accessToken;
208 }
209
214 public function getClientId()
215 {
216 return $this->clientId;
217 }
218
223 public function getClientSecret()
224 {
225 return $this->clientSecret;
226 }
227}
Class for handler Mastodon.
formatDate($dateString)
Format date for normalize date.
getClientSecret()
Getter for secret client.
__construct($authParams)
Constructor to set the necessary credentials.
normalizeData($postData)
Normalize data of retrieved posts.
getClientId()
Getter for client Id.
fetch($urlAPI, $maxNb=5, $cacheDelay=60, $cacheDir='', $authParams=[])
Fetch posts from Mastodon API using the access token.
getPosts()
Get the list of retrieved posts.
getAccessToken()
Getter for access token.
getRedirectUri()
Getter for url to redirect.
dol_filemtime($pathoffile)
Return time of a file.
dol_is_file($pathoffile)
Return if path is a file.
dol_now($mode='auto')
Return date for now.
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false)
Output date in a string format according to outputlangs (or langs if not defined).
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
getURLContent($url, $postorget='GET', $param='', $followlocation=1, $addheaders=array(), $allowedschemes=array('http', 'https'), $localurl=0, $ssl_verifypeer=-1)
Function to get a content from an URL (use proxy if proxy defined).
dol_hash($chain, $type='0', $nosalt=0)
Returns a hash (non reversible encryption) of a string.