3 * @file src/Worker/DiscoverPoCo.php
5 namespace Friendica\Worker;
7 use Friendica\Core\Cache;
8 use Friendica\Core\Config;
9 use Friendica\Core\Worker;
10 use Friendica\Database\DBM;
11 use Friendica\Model\GlobalContact;
12 use Friendica\Network\Probe;
13 use Friendica\Protocol\PortableContact;
15 require_once 'include/datetime.php';
18 /// @todo Clean up this mess of a parameter hell and split it in several classes
19 public static function execute($command = '', $param1 = '', $param2 = '', $param3 = '', $param4 = '')
22 This function can be called in these ways:
23 - dirsearch <search pattern>: Searches for "search pattern" in the directory. "search pattern" is url encoded.
24 - checkcontact: Updates gcontact entries
25 - suggestions: Discover other servers for their contacts.
26 - server <poco url>: Searches for the poco server list. "poco url" is base64 encoded.
27 - update_server: Frequently check the first 250 servers for vitality.
28 - update_server_directory: Discover the given server id for their contacts
29 - PortableContact::load: Load POCO data from a given POCO address
30 - check_profile: Update remote profile data
33 if ($command == "dirsearch") {
34 $search = urldecode($param1);
36 } elseif ($command == "checkcontact") {
38 } elseif ($command == "suggestions") {
40 } elseif ($command == "server") {
42 } elseif ($command == "update_server") {
44 } elseif ($command == "update_server_directory") {
46 } elseif ($command == "load") {
48 } elseif ($command == "check_profile") {
50 } elseif ($command == '') {
54 logger("Unknown or missing parameter ".$command."\n");
58 logger('start '.$search);
62 PortableContact::lastUpdated($param1, true);
64 } elseif ($mode == 7) {
65 if (!empty($param4)) {
70 PortableContact::load(intval($param1), intval($param2), intval($param3), $url);
71 } elseif ($mode == 6) {
72 PortableContact::discoverSingleServer(intval($param1));
73 } elseif ($mode == 5) {
75 } elseif ($mode == 4) {
76 $server_url = $param1;
77 if ($server_url == "") {
80 $server_url = filter_var($server_url, FILTER_SANITIZE_URL);
81 if (substr(normalise_link($server_url), 0, 7) != "http://") {
84 $result = "Checking server ".$server_url." - ";
85 $ret = PortableContact::checkServer($server_url);
91 logger($result, LOGGER_DEBUG);
92 } elseif ($mode == 3) {
93 GlobalContact::updateSuggestions();
94 } elseif (($mode == 2) && Config::get('system', 'poco_completion')) {
95 self::discoverUsers();
96 } elseif (($mode == 1) && ($search != "") && Config::get('system', 'poco_local_search')) {
97 self::discoverDirectory($search);
98 self::gsSearchUser($search);
99 } elseif (($mode == 0) && ($search == "") && (Config::get('system', 'poco_discovery') > 0)) {
100 // Query Friendica and Hubzilla servers for their users
101 PortableContact::discover();
103 // Query GNU Social servers for their users ("statistics" addon has to be enabled on the GS server)
104 if (!Config::get('system', 'ostatus_disabled')) {
105 GlobalContact::discoverGsUsers();
109 logger('end '.$search);
115 * @brief Updates the first 250 servers
118 private static function updateServer() {
119 $r = q("SELECT `url`, `created`, `last_failure`, `last_contact` FROM `gserver` ORDER BY rand()");
121 if (!DBM::is_result($r)) {
127 foreach ($r AS $server) {
128 if (!PortableContact::updateNeeded($server["created"], "", $server["last_failure"], $server["last_contact"])) {
131 logger('Update server status for server '.$server["url"], LOGGER_DEBUG);
133 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", $server["url"]);
135 if (++$updated > 250) {
141 private static function discoverUsers() {
142 logger("Discover users", LOGGER_DEBUG);
146 $users = q("SELECT `url`, `created`, `updated`, `last_failure`, `last_contact`, `server_url`, `network` FROM `gcontact`
147 WHERE `last_contact` < UTC_TIMESTAMP - INTERVAL 1 MONTH AND
148 `last_failure` < UTC_TIMESTAMP - INTERVAL 1 MONTH AND
149 `network` IN ('%s', '%s', '%s', '%s', '') ORDER BY rand()",
150 dbesc(NETWORK_DFRN), dbesc(NETWORK_DIASPORA),
151 dbesc(NETWORK_OSTATUS), dbesc(NETWORK_FEED));
158 foreach ($users AS $user) {
160 $urlparts = parse_url($user["url"]);
161 if (!isset($urlparts["scheme"])) {
162 q("UPDATE `gcontact` SET `network` = '%s' WHERE `nurl` = '%s'",
163 dbesc(NETWORK_PHANTOM), dbesc(normalise_link($user["url"])));
167 if (in_array($urlparts["host"], array("www.facebook.com", "facebook.com", "twitter.com",
168 "identi.ca", "alpha.app.net"))) {
169 $networks = array("www.facebook.com" => NETWORK_FACEBOOK,
170 "facebook.com" => NETWORK_FACEBOOK,
171 "twitter.com" => NETWORK_TWITTER,
172 "identi.ca" => NETWORK_PUMPIO,
173 "alpha.app.net" => NETWORK_APPNET);
175 q("UPDATE `gcontact` SET `network` = '%s' WHERE `nurl` = '%s'",
176 dbesc($networks[$urlparts["host"]]), dbesc(normalise_link($user["url"])));
180 $server_url = PortableContact::detectServer($user["url"]);
181 $force_update = false;
183 if ($user["server_url"] != "") {
185 $force_update = (normalise_link($user["server_url"]) != normalise_link($server_url));
187 $server_url = $user["server_url"];
190 if ((($server_url == "") && ($user["network"] == NETWORK_FEED)) || $force_update || PortableContact::checkServer($server_url, $user["network"])) {
191 logger('Check profile '.$user["url"]);
192 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "check_profile", $user["url"]);
194 if (++$checked > 100) {
198 q("UPDATE `gcontact` SET `last_failure` = '%s' WHERE `nurl` = '%s'",
199 dbesc(datetime_convert()), dbesc(normalise_link($user["url"])));
202 // Quit the loop after 3 minutes
203 if (time() > ($starttime + 180)) {
209 private static function discoverDirectory($search) {
211 $data = Cache::get("dirsearch:".$search);
212 if (!is_null($data)) {
213 // Only search for the same item every 24 hours
214 if (time() < $data + (60 * 60 * 24)) {
215 logger("Already searched for ".$search." in the last 24 hours", LOGGER_DEBUG);
220 $x = fetch_url(get_server()."/lsearch?p=1&n=500&search=".urlencode($search));
221 $j = json_decode($x);
223 if (count($j->results)) {
224 foreach ($j->results as $jj) {
225 // Check if the contact already exists
226 $exists = q("SELECT `id`, `last_contact`, `last_failure`, `updated` FROM `gcontact` WHERE `nurl` = '%s'", normalise_link($jj->url));
227 if (DBM::is_result($exists)) {
228 logger("Profile ".$jj->url." already exists (".$search.")", LOGGER_DEBUG);
230 if (($exists[0]["last_contact"] < $exists[0]["last_failure"]) &&
231 ($exists[0]["updated"] < $exists[0]["last_failure"])) {
234 // Update the contact
235 PortableContact::lastUpdated($jj->url);
239 $server_url = PortableContact::detectServer($jj->url);
240 if ($server_url != '') {
241 if (!PortableContact::checkServer($server_url)) {
242 logger("Friendica server ".$server_url." doesn't answer.", LOGGER_DEBUG);
245 logger("Friendica server ".$server_url." seems to be okay.", LOGGER_DEBUG);
248 $data = Probe::uri($jj->url);
249 if ($data["network"] == NETWORK_DFRN) {
250 logger("Profile ".$jj->url." is reachable (".$search.")", LOGGER_DEBUG);
251 logger("Add profile ".$jj->url." to local directory (".$search.")", LOGGER_DEBUG);
253 if ($jj->tags != "") {
254 $data["keywords"] = $jj->tags;
257 $data["server_url"] = $data["baseurl"];
259 GlobalContact::update($data);
261 logger("Profile ".$jj->url." is not responding or no Friendica contact - but network ".$data["network"], LOGGER_DEBUG);
265 Cache::set("dirsearch:".$search, time(), CACHE_DAY);
269 * @brief Search for GNU Social user with gstools.org
271 * @param str $search User name
273 private static function gsSearchUser($search) {
275 // Currently disabled, since the service isn't available anymore.
276 // It is not removed since I hope that there will be a successor.
281 $url = "http://gstools.org/api/users_search/".urlencode($search);
283 $result = z_fetch_url($url);
284 if (!$result["success"]) {
288 $contacts = json_decode($result["body"]);
290 if ($contacts->status == 'ERROR') {
294 /// @TODO AS is considered as a notation for constants (as they usually being written all upper-case)
295 /// @TODO find all those and convert to all lower-case which is a keyword then
296 foreach ($contacts->data AS $user) {
297 $contact = Probe::uri($user->site_address."/".$user->name);
298 if ($contact["network"] != NETWORK_PHANTOM) {
299 $contact["about"] = $user->description;
300 GlobalContact::update($contact);