MadelineProto/src/danog/MadelineProto/SessionPaths.php

<?php

/**
 * Session paths module.
 *
 * This file is part of MadelineProto.
 * MadelineProto 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.
 * MadelineProto 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 General Public License along with MadelineProto.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * @author    Daniil Gentili <daniil@daniil.it>
 * @copyright 2016-2020 Daniil Gentili <daniil@daniil.it>
 * @license   https://opensource.org/licenses/AGPL-3.0 AGPLv3
 *
 * @link https://docs.madelineproto.xyz MadelineProto documentation
 */

namespace danog\MadelineProto;

use Amp\File\StatCache;
use Amp\Promise;
use Amp\Success;
use danog\MadelineProto\Ipc\IpcState;

use function Amp\File\exists;
use function Amp\File\open;
use function Amp\File\rename;

/**
 * Session path information.
 */
class SessionPaths
{
    /**
     * Legacy session path.
     */
    private string $legacySessionPath;
    /**
     * Session path.
     */
    private string $sessionPath;
    /**
     * Session lock path.
     */
    private string $lockPath;
    /**
     * IPC socket path.
     */
    private string $ipcPath;
    /**
     * IPC callback socket path.
     */
    private string $ipcCallbackPath;
    /**
     * IPC light state path.
     */
    private string $ipcStatePath;
    /**
     * Light state path.
     */
    private string $lightStatePath;
    /**
     * Light state.
     */
    private ?LightState $lightState = null;

    /**
     * Construct session info from session name.
     *
     * @param string $session Session name
     */
    public function __construct(string $session)
    {
        $session = Tools::absolute($session);
        $this->legacySessionPath = $session;
        $this->sessionPath = "$session.safe.php";
        $this->lightStatePath = "$session.lightState.php";
        $this->lockPath = "$session.lock";
        $this->ipcPath = "$session.ipc";
        $this->ipcCallbackPath = "$session.callback.ipc";
        $this->ipcStatePath = "$session.ipcState.php";
    }
    /**
     * Serialize object to file.
     *
     * @param object $object
     * @param string $path
     * @return \Generator
     */
    public function serialize(object $object, string $path): \Generator
    {
        $file = yield open("$path.temp.php", 'bw+');
        yield $file->write(Serialization::PHP_HEADER);
        yield $file->write(\chr(Serialization::VERSION));
        yield $file->write(\serialize($object));
        yield $file->close();

        yield rename("$path.temp.php", $path);
    }

    /**
     * Deserialize new object.
     *
     * @param string $path Object path, defaults to session path
     *
     * @return \Generator
     *
     * @psalm-return \Generator<mixed, mixed, mixed, object>
     */
    public function unserialize(string $path = ''): \Generator
    {
        $path = $path ?: $this->sessionPath;

        StatCache::clear($path);
        if (!yield exists($path)) {
            return null;
        }
        $headerLen = \strlen(Serialization::PHP_HEADER) + 1;

        $file = yield open($path, 'rb');
        $size = yield \stat($path);
        $size = $size['size'] ?? $headerLen;

        yield $file->seek($headerLen); // Skip version for now
        $unserialized = \unserialize((yield $file->read($size - $headerLen)) ?? '');
        yield $file->close();

        return $unserialized;
    }

    /**
     * Get session path.
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->legacySessionPath;
    }

    /**
     * Get legacy session path.
     *
     * @return string
     */
    public function getLegacySessionPath(): string
    {
        return $this->legacySessionPath;
    }

    /**
     * Get session path.
     *
     * @return string
     */
    public function getSessionPath(): string
    {
        return $this->sessionPath;
    }

    /**
     * Get lock path.
     *
     * @return string
     */
    public function getLockPath(): string
    {
        return $this->lockPath;
    }

    /**
     * Get IPC socket path.
     *
     * @return string
     */
    public function getIpcPath(): string
    {
        return $this->ipcPath;
    }

    /**
     * Get IPC light state path.
     *
     * @return string
     */
    public function getIpcStatePath(): string
    {
        return $this->ipcStatePath;
    }

    /**
     * Get IPC state.
     *
     * @psalm-suppress InvalidReturnType
     * @return Promise<?IpcState>
     */
    public function getIpcState(): Promise
    {
        return Tools::call($this->unserialize($this->ipcStatePath));
    }

    /**
     * Store IPC state.
     *
     * @return \Generator
     */
    public function storeIpcState(IpcState $state): \Generator
    {
        return $this->serialize($state, $this->getIpcStatePath());
    }


    /**
     * Get light state path.
     *
     * @return string
     */
    public function getLightStatePath(): string
    {
        return $this->lightStatePath;
    }

    /**
     * Get light state.
     *
     * @psalm-suppress InvalidReturnType
     * @return Promise<LightState>
     */
    public function getLightState(): Promise
    {
        if ($this->lightState) {
            return new Success($this->lightState);
        }
        $promise = Tools::call($this->unserialize($this->lightStatePath));
        $promise->onResolve(function (?\Throwable $e, ?LightState $res) {
            if ($res) {
                $this->lightState = $res;
            }
        });
        return $promise;
    }

    /**
     * Store light state.
     *
     * @return \Generator
     */
    public function storeLightState(MTProto $state): \Generator
    {
        $this->lightState = new LightState($state);
        return $this->serialize($this->lightState, $this->getLightStatePath());
    }

    /**
     * Get IPC callback socket path.
     *
     * @return string
     */
    public function getIpcCallbackPath(): string
    {
        return $this->ipcCallbackPath;
    }
}