Merge pull request #4912 from annando/archivecontacts

Added console command to manually archive contacts

diff --git a/src/Core/Console.php b/src/Core/Console.php
index 82c485179eb2a0e22b2fefd9c15d3ea0e6d804bd..a5aff4ae801faa786f50079117dfca59c583be77 100644 (file)
--- a/src/Core/Console.php
+++ b/src/Core/Console.php
@@ -21,6 +21,7 @@ class Console extends \Asika\SimpleConsole\Console
                'extract'                => __NAMESPACE__ . '\Console\Extract',
                'globalcommunityblock'   => __NAMESPACE__ . '\Console\GlobalCommunityBlock',
                'globalcommunitysilence' => __NAMESPACE__ . '\Console\GlobalCommunitySilence',
+               'archivecontact'         => __NAMESPACE__ . '\Console\ArchiveContact',
                'autoinstall'            => __NAMESPACE__ . '\Console\AutomaticInstallation',
                'maintenance'            => __NAMESPACE__ . '\Console\Maintenance',
                'newpassword'            => __NAMESPACE__ . '\Console\NewPassword',
@@ -42,6 +43,7 @@ Commands:
        extract                Generate translation string file for the Friendica project (deprecated)
        globalcommunityblock   Block remote profile from interacting with this node
        globalcommunitysilence Silence remote profile from global community page
+       archivecontact         Archive a contact when you know that it isn't existing anymore
        help                   Show help about a command, e.g (bin/console help config)
        autoinstall            Starts automatic installation of friendica based on values from htconfig.php
        maintenance            Set maintenance mode for this node

diff --git a/src/Core/Console/ArchiveContact.php b/src/Core/Console/ArchiveContact.php
new file mode 100644 (file)
index 0000000..7a973f3
--- /dev/null
+++ b/src/Core/Console/ArchiveContact.php
@@ -0,0 +1,79 @@
+<?php
+
+namespace Friendica\Core\Console;
+
+use Friendica\Core\L10n;
+use dba;
+
+/**
+ * @brief tool to archive a contact on the server
+ *
+ * With this tool you can archive a contact when you know that it isn't existing anymore.
+ * Normally this does happen automatically after a few days.
+ *
+ * License: AGPLv3 or later, same as Friendica
+ *
+ */
+class ArchiveContact extends \Asika\SimpleConsole\Console
+{
+       protected $helpOptions = ['h', 'help', '?'];
+
+       protected function getHelp()
+       {
+               $help = <<<HELP
+console archivecontact - archive a contact
+Usage
+       bin/console archivecontact <profile_url> [-h|--help|-?] [-v]
+
+Description
+       Archive a contact when you know that it isn't existing anymore. Normally this does happen automatically after a few days.
+
+Options
+    -h|--help|-? Show help information
+    -v           Show more debug information.
+HELP;
+               return $help;
+       }
+
+       protected function doExecute()
+       {
+               $a = get_app();
+
+               if ($this->getOption('v')) {
+                       $this->out('Class: ' . __CLASS__);
+                       $this->out('Arguments: ' . var_export($this->args, true));
+                       $this->out('Options: ' . var_export($this->options, true));
+               }
+
+               if (count($this->args) == 0) {
+                       $this->out($this->getHelp());
+                       return 0;
+               }
+
+               if (count($this->args) > 1) {
+                       throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments');
+               }
+
+               require_once '.htconfig.php';
+               $result = \dba::connect($db_host, $db_user, $db_pass, $db_data);
+               unset($db_host, $db_user, $db_pass, $db_data);
+
+               if (!$result) {
+                       throw new \RuntimeException('Unable to connect to database');
+               }
+
+               $nurl = normalise_link($this->getArgument(0));
+               if (!dba::exists('contact', ['nurl' => $nurl, 'archive' => false])) {
+                       throw new \RuntimeException(L10n::t('Could not find any unarchived contact entry for this URL (%s)', $nurl));
+               }
+               if (dba::update('contact', ['archive' => true], ['nurl' => $nurl])) {
+                       $condition = ["`cid` IN (SELECT `id` FROM `contact` WHERE `archive`)"];
+                       dba::delete('queue', $condition);
+                       $this->out(L10n::t('The contact entries have been archived'));
+               } else {
+                       throw new \RuntimeException('The contact archival failed.');
+               }
+
+               return 0;
+       }
+}

diff --git a/src/Protocol/DFRN.php b/src/Protocol/DFRN.php
index bffcb2086fb328e99c767cc021abeec1c0a9554e..4821f3e4a1da1cb00524c33366774dfc27805c51 100644 (file)
--- a/src/Protocol/DFRN.php
+++ b/src/Protocol/DFRN.php
@@ -1197,6 +1197,7 @@ class DFRN
                $ret = Network::curl($url);
 
                if ($ret['errno'] == CURLE_OPERATION_TIMEDOUT) {
+                       Contact::markForArchival($contact);
                        return -2; // timed out
                }
 
@@ -1204,24 +1205,28 @@ class DFRN
 
                $curl_stat = $a->get_curl_code();
                if (empty($curl_stat)) {
+                       Contact::markForArchival($contact);
                        return -3; // timed out
                }
 
                logger('dfrn_deliver: ' . $xml, LOGGER_DATA);
 
                if (empty($xml)) {
+                       Contact::markForArchival($contact);
                        return 3;
                }
 
                if (strpos($xml, '<?xml') === false) {
                        logger('dfrn_deliver: no valid XML returned');
                        logger('dfrn_deliver: returned XML: ' . $xml, LOGGER_DATA);
+                       Contact::markForArchival($contact);
                        return 3;
                }
 
                $res = XML::parseString($xml);
 
-               if ((intval($res->status) != 0) || (! strlen($res->challenge)) || (! strlen($res->dfrn_id))) {
+               if ((intval($res->status) != 0) || !strlen($res->challenge) || !strlen($res->dfrn_id)) {
+                       Contact::markForArchival($contact);
                        return ($res->status ? $res->status : 3);
                }
 
@@ -1274,6 +1279,7 @@ class DFRN
                if ($final_dfrn_id != $orig_id) {
                        logger('dfrn_deliver: wrong dfrn_id.');
                        // did not decode properly - cannot trust this site
+                       Contact::markForArchival($contact);
                        return 3;
                }
 
@@ -1309,6 +1315,7 @@ class DFRN
                                        break;
                                default:
                                        logger("rino: invalid requested version '$rino_remote_version'");
+                                       Contact::markForArchival($contact);
                                        return -8;
                        }
 
@@ -1346,22 +1353,26 @@ class DFRN
 
                $curl_stat = $a->get_curl_code();
                if (empty($curl_stat) || empty($xml)) {
+                       Contact::markForArchival($contact);
                        return -9; // timed out
                }
 
                if (($curl_stat == 503) && stristr($a->get_curl_headers(), 'retry-after')) {
+                       Contact::markForArchival($contact);
                        return -10;
                }
 
                if (strpos($xml, '<?xml') === false) {
                        logger('dfrn_deliver: phase 2: no valid XML returned');
                        logger('dfrn_deliver: phase 2: returned XML: ' . $xml, LOGGER_DATA);
+                       Contact::markForArchival($contact);
                        return 3;
                }
 
                $res = XML::parseString($xml);
 
                if (!isset($res->status)) {
+                       Contact::markForArchival($contact);
                        return -11;
                }
 
@@ -1374,7 +1385,7 @@ class DFRN
                        logger('Delivery returned status '.$res->status.' - '.$res->message, LOGGER_DEBUG);
                }
 
-               if ($res->status == 200) {
+               if (($res->status >= 200) && ($res->status <= 299)) {
                        Contact::unmarkForArchival($contact);
                }
 
@@ -1403,6 +1414,7 @@ class DFRN
 
                        if (empty($contact['addr'])) {
                                logger('Unable to find contact handle for ' . $contact['id'] . ' - ' . $contact['url']);
+                               Contact::markForArchival($contact);
                                return -21;
                        }
                }
@@ -1410,6 +1422,7 @@ class DFRN
                $fcontact = Diaspora::personByHandle($contact['addr']);
                if (empty($fcontact)) {
                        logger('Unable to find contact details for ' . $contact['id'] . ' - ' . $contact['addr']);
+                       Contact::markForArchival($contact);
                        return -22;
                }
 
@@ -1433,22 +1446,26 @@ class DFRN
                $curl_stat = $a->get_curl_code();
                if (empty($curl_stat) || empty($xml)) {
                        logger('Empty answer from ' . $contact['id'] . ' - ' . $dest_url);
+                       Contact::markForArchival($contact);
                        return -9; // timed out
                }
 
                if (($curl_stat == 503) && (stristr($a->get_curl_headers(), 'retry-after'))) {
+                       Contact::markForArchival($contact);
                        return -10;
                }
 
                if (strpos($xml, '<?xml') === false) {
                        logger('No valid XML returned from ' . $contact['id'] . ' - ' . $dest_url);
                        logger('Returned XML: ' . $xml, LOGGER_DATA);
+                       Contact::markForArchival($contact);
                        return 3;
                }
 
                $res = XML::parseString($xml);
 
                if (empty($res->status)) {
+                       Contact::markForArchival($contact);
                        return -23;
                }
 
@@ -1456,7 +1473,7 @@ class DFRN
                        logger('Transmit to ' . $dest_url . ' returned status '.$res->status.' - '.$res->message, LOGGER_DEBUG);
                }
 
-               if ($res->status == 200) {
+               if (($res->status >= 200) && ($res->status <= 299)) {
                        Contact::unmarkForArchival($contact);
                }
 

diff --git a/src/Worker/Queue.php b/src/Worker/Queue.php
index 57f6e92774dade5068cc82f46ca9c31fd670a29d..345da39abbb6b3617dadda2bc2cdad28996fb362 100644 (file)
--- a/src/Worker/Queue.php
+++ b/src/Worker/Queue.php
@@ -63,7 +63,7 @@ class Queue
                        return;
                }
 
-               if (empty($contact['notify'])) {
+               if (empty($contact['notify']) || $contact['archive']) {
                        QueueModel::removeItem($q_item['id']);
                        return;
                }