gnu-social-v2-archive-activitypub-plugin/classes/Activitypub_pending_follow_requests.php

<?php
/**
 * GNU social - a federating social network
 *
 * ActivityPubPlugin implementation for GNU Social
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Plugin
 * @package   GNUsocial
 * @author    Diogo Cordeiro <diogo@fc.up.pt>
 * @copyright 2018 Free Software Foundation http://fsf.org
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      https://www.gnu.org/software/social/
 */
if (!defined('GNUSOCIAL')) {
    exit(1);
}

/**
 * ActivityPub's Pending follow requests
 *
 * @category  Plugin
 * @package   GNUsocial
 * @author    Diogo Cordeiro <diogo@fc.up.pt>
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://www.gnu.org/software/social/
 */
class Activitypub_pending_follow_requests extends Managed_DataObject
{
    public $__table = 'Activitypub_pending_follow_requests';
    public $local_profile_id;
    public $remote_profile_id;
    private $_reldb = null;

    /**
     * Return table definition for Schema setup and DB_DataObject usage.
     *
     * @author Diogo Cordeiro <diogo@fc.up.pt>
     * @return array array of column definitions
     */
    public static function schemaDef()
    {
        return [
            'fields' => [
                'local_profile_id'  => ['type' => 'integer', 'not null' => true],
                'remote_profile_id' => ['type' => 'integer', 'not null' => true],
                'relation_id'       => ['type' => 'serial',  'not null' => true],
            ],
            'primary key' => ['relation_id'],
            'unique keys' => [
                'Activitypub_pending_follow_requests_relation_id_key' => ['relation_id'],
            ],
            'foreign keys' => [
                'Activitypub_pending_follow_requests_local_profile_id_fkey'  => ['profile', ['local_profile_id' => 'id']],
                'Activitypub_pending_follow_requests_remote_profile_id_fkey' => ['profile', ['remote_profile_id' => 'id']],
            ],
        ];
    }

    public function __construct($actor, $remote_actor)
    {
        $this->local_profile_id  = $actor;
        $this->remote_profile_id = $remote_actor;
    }

    /**
     * Add Follow request to table.
     *
     * @author Diogo Cordeiro <diogo@fc.up.pt>
     * @param int32 $actor actor id
     * @param int32 $remote_actor remote actor id
     * @return boolean true if added, false otherwise
     */
    public function add()
    {
        return !$this->exists() && $this->insert();
    }

    /**
     * Check if a Follow request is pending.
     *
     * @author Diogo Cordeiro <diogo@fc.up.pt>
     * @return boolean true if is pending, false otherwise
     */
    public function exists()
    {
        $this->_reldb = clone ($this);
        if ($this->_reldb->find() > 0) {
            $this->_reldb->fetch();
            return true;
        }
        return false;
    }

    /**
     * Remove a request from the pending table.
     *
     * @author Diogo Cordeiro <diogo@fc.up.pt>
     * @return boolean true if removed, false otherwise
     */
    public function remove()
    {
        return $this->exists() && $this->_reldb->delete();
    }
}