path: root/app/class/object.class.php

<?php

/*
 * SCROTT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * For more information, please refer to UNLICENSE
 */

require_once "class/table.class.php";
require_once "class/image.php";

/*
 * This is a generic database object.  This is a supertype of all Scrott
 * datatypes and defines fields common to all of them.
 */
class object extends table
{
    /*
     * Constants used for uploading images
     */
    public const HEAD_MAXSIZE = 1048576; // 1Mb
    public const IMAGE_MIME = array(
        "image/jpeg",
        "image/jpg",
        "image/png",
    );

    /*
     * Constructor
     */
    public function __construct(?string $guid = NULL)
    {
        $this->fields['objects'] = array(
            "guid",
            "owner",
            "parent",
            "name",
            "created",
            "updated",

            "membModify",
            "membMemb",
            "membAccs",
            "membCres",
            "membModifys",
            "membMembs",
            "pubAcc",
            "pubAccs",
            "pubCres",

            "objtype",
        );

        parent::__construct($guid);
    }

    /*
     * Get the object type for the given GUID
     */
    public static function typeOf(string $guid) : string
    {
        $obj = new object($guid);
        return $obj->objtype;
    }

    /*
     * Get the owner of this object.  Either a user object or a group
     * object will be returned.  If this object does not have an owner,
     * NULL will be returned.
     */
    public function getOwner() : ?agent
    {
        if (!isset($this->owner) || $this->owner == "")
            return NULL;

        if (self::typeOf($this->owner) == "group")
            return new group($this->owner);

        return new user($this->owner);
    }

    /*
     * Update the owner of this object
     */
    public function setOwner(agent $owner) : void
    {
        $this->owner = $owner->guid;
        $this->saveObj();
    }

    /*
     * Get the parent of this object.  If this object does not have a
     * parent, NULL will be returned.
     */
    public function getParent() : ?object
    {
        if (!isset($this->parent) || $this->parent == "")
            return NULL;

        $parent = new object($this->parent);
        return new $parent->objtype($parent->guid);
    }

    /*
     * Update the parent of this object
     */
    public function setParent(object $parent) : void
    {
        $this->parent = $parent->guid;
        $this->saveObj();
    }

    /*
     * Get an array of all members of this object
     */
    public function getMembers() : array
    {
        $memb = array();
        $query = "SELECT member FROM members WHERE guid = '" . database::esc($this->guid) . "'";
        $res = database::query($query);

        foreach ($res as $m)
            $memb[] = new user($m['member']);

        return $memb;
    }

    /*
     * Add a user as a member of this object.  Returns false if user is
     * already a member, or if another error occurs; true otherwise.
     */
    public function addMember(user $user) : bool
    {
        if ($user->isMemberOf($this) || !isset($user->guid))
            return false;

        $query = "INSERT INTO members (guid, member) VALUES ('" . database::esc($this->guid) . "', '" .
            database::esc($user->guid) . "')";
        database::query($query);
        return true;
    }

    /*
     * Remove a user as a member of this object.  Returns false if user
     * is not a member, or if another error occurs; true otherwise.
     */
    public function remMember(user $user) : bool
    {
        if (!$user->isMemberOf($this) || !isset($user->guid))
            return false;

        $query = "DELETE FROM members WHERE guid = '" . database::esc($this->guid) . "' AND " .
            "member = '" . database::esc($user->guid) . "'";
        database::query($query);
        return true;
    }

    /*
     * Set the head image for this object, overwriting any existing
     * image.  $image should be an uploaded file to PHP, still
     * unhandled.
     */
    public function setHeadImg(array $image) : bool
    {
        $path = "dynmic/heads/" . $this->guid;

        if (!saveFile($image, $path, self::HEAD_MAXSIZE, self::IMAGE_MIME))
            return false;

        if (!imageSquareCrop($path))
        {
            $this->rmHeadImg();
            return false;
        }

        return true;
    }

    /*
     * Remove the head image for this object.  This deletes the image
     * on disk.
     */
    public function rmHeadImg() : bool
    {
        if (!is_file("dynmic/heads/" . $this->guid))
            return true;

        return unlink("dynmic/heads/" . $this->guid);
    }
}

?>